com.highqsoft.moma.rules.mapping

Class ComposeAttributeRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.mapping.ComposeAttributeRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class ComposeAttributeRule
extends AbstractSequencerRule

\page MappingRules \section rules_com_highqsoft_moma_rules_mapping_ComposeAttributeRule ComposeAttributeRule \addindex ComposeAttributeRule \addindex attribute composition This rule composes a list of attributes (source) to the value of a new attribute. The order of the values in the new attribute is identical with the order of the source attribute names given in the properties. The values are separated with the separation character. Type: SequencerRule \par Properties \li \b SplitChar (optional, default " ", DT_STRING)
The character used to split the lists below. If there are list entries with spaces another split character must be used. \li \b SourceAttributeNames (required, no default, DT_STRING)
A list of attribute names that will be used to compose the new attribute. The names must be separated with \e SplitChar. \li \b AttributeName (required, no default, DT_STRING)
The name of attribute where the composed value will be set. When the attribute is not in the input data set the attribute is added. \li \b SeparatorChar (required, no default, DT_STRING)
The character or string which will be use to separate between the different values. \par Test 1 This is called from the section in a modelmapper control file. \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	attributeName The name of the attribute name.
protected java.lang.String	separatorChar
protected java.lang.String[]	sourceNames

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
ComposeAttributeRule()

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() The getValue method, return the values of the AbstractSequencerRule.localNVU field.
void	init() The initialize method, get the element name and the reference from the PACReturnWriter from the context.
void	setValue(NameValueUnit[][] nvu) The setValue, add the new value to the lines of the data set.
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

attributeName

protected java.lang.String attributeName

The name of the attribute name.

sourceNames

protected java.lang.String[] sourceNames

separatorChar

protected java.lang.String separatorChar

Constructor Detail

ComposeAttributeRule

public ComposeAttributeRule()

Method Detail

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)

The setValue, add the new value to the lines of the data set.

Parameters:

nvu - The name value of the rule.

See Also:

RuleIF.setValue(org.asam.ods.NameValueUnit[][])

init

public void init()
          throws InitializationFailedException

The initialize method, get the element name and the reference from the PACReturnWriter from the context.

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()