com.highqsoft.moma.rules.mapping

Class AddPropertiesIfExistRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.mapping.AddPropertiesIfExistRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class AddPropertiesIfExistRule
extends AbstractSequencerRule

\page MappingRules \section rules_com_highqsoft_moma_rules_mapping_AddPropertiesIfExistRule AddPropertiesIfExistRule \addindex AddPropertiesIfExistRule \addindex add properties if they exist This rule adds or modifies a list of attributes and sets the value for each attribute to the value of the matching property. If the property does not exist in the context the attribute is not added or modified.
The properties are read from the context at the getValue() method. This means the content of the properties can be set at runtime by previously executed rules. Type: SequencerRule \par Properties \li \b SplitChar (optional, default" ", DT_STRING)
The character used to split the lists \e AttributeName and \PropertyNames. \li \b AttributeNames (required, no default, DT_STRING)
The list of attribute names. \li \b PropertyNames (required, no default, DT_STRING)
The list of property names where the value is taken from. If the property does not exist it is ignored. The lists \e AttributeNames and \e PropertyNames must have the same length \par Test 1 This is called from the sequence in a modelmapper control file. All lines in the dataset get the new attribute TestID with the values from the property TestId \li Input \code \endcode \li Configuration \code \endcode \li Expected Output \code \endcode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	attributeNames
protected java.lang.String[]	propertyNames

Fields inherited from class com.highqsoft.xsd.AbstractSequencerRule

cleanAfterGet, localNVU

Fields inherited from class com.highqsoft.xsd.AbstractRule

loggerName, postMethods, preMethods, sessionRef

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
AddPropertiesIfExistRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected NameValueUnit	createNameValueUnit(java.lang.String name) Create a NameValueUnit, the name is set, the value and the union are initialized, the flag of the values is set to valid, the unit is an empty unit.
NameValueUnit[][]	getValue() The getValue method, return the values of the AbstractSequencerRule.localNVU field.
void	init() The init method, get and check the arguments
void	setValue(NameValueUnit[][] nvu) Add the Attributes and Values to the NameValueUnit[][].
void	terminate() The terminate method reset the private variables.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

execute

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, executePostMethods, executePreMethods, getAoSessionFromContextWithSessionRef, getId, getOdsCache, getPointTo, getSessionRef, getType, isPedantic, setGathermode, setId, setPointTo, setPostMethods, setPreMethods, setSessionRef, setType, toString, toString, toString

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Field Detail

attributeNames

protected java.lang.String[] attributeNames

propertyNames

protected java.lang.String[] propertyNames

Constructor Detail

AddPropertiesIfExistRule

public AddPropertiesIfExistRule()

Method Detail

createNameValueUnit

protected NameValueUnit createNameValueUnit(java.lang.String name)

Create a NameValueUnit, the name is set, the value and the union are initialized, the flag of the values is set to valid, the unit is an empty unit.

Parameters:

name - the name

Returns:

the created name value unit

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Description copied from class: AbstractSequencerRule

The getValue method, return the values of the AbstractSequencerRule.localNVU field. If rule property 'CLEANAFTERGET' was set to true, the nvu field of the rule is wiped to clear memory.

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractSequencerRule

Returns:

the values.

Throws:

RuleException

See Also:

RuleIF.getValue()

setValue

public void setValue(NameValueUnit[][] nvu)
              throws RuleException

Add the Attributes and Values to the NameValueUnit[][]. If an attribute already exists its value is overwritten.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

init

public void init()
          throws InitializationFailedException

The init method, get and check the arguments

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

terminate

public void terminate()
               throws TerminationException

The terminate method reset the private variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractSequencerRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractSequencerRule.terminate()