com.highqsoft.moma.rules.utils

Class AttributeValuesToPropertyRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.AttributeValuesToPropertyRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class AttributeValuesToPropertyRule
extends AbstractSequencerRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_AttributeValuesToPropertyRule AttributeValuesToPropertyRule \addindex AttributeValuesToPropertyRule \addindex attribute values to property \addindex value to property \addindex property from attribute value This rule stores the string representation of one or more attribute values as properties in the context. If there is more than one instance all values are stored in the property and the values are separated with a configurable separator character. If one of the attributes does not exist or has no value the specified default value is used. If no default value is given and no attribute value is found an empty string is inserted as default value. The result lists in the properties have the same length for all properties. If there are no instances at all and default values are specified, the default values are used in the result properties instead of empty strings. Type: SequencerRule \par Properties This rule is initialized with the following properties: \li \b AttributeNames (required, no default, DT_STRING)
A list of attribute names to read the values from. The names are separated with the \e SplitChar character. \li \b PropertyNames (required, no default, DT_STRING)
A list of property names where the values will be stored. The names are separated with the \e SplitChar character. \li \b DefaultValues (optional, default " ", DT_STRING)
A list of default values for each attribute to use if it does not exist or has no value. \li \b SplitChar (optional, default " ", DT_STRING)
The character to split the \e AttributeNames and \e PropertyNames. \li \b SplitCharResult (optional, default " ", DT_STRING)
The character to split the Values within the result properties \par Test 1 This is called in a sequence of rules in the \ sequence of a modelmapper control file. It stores the attributes \e fileName and \e Action of all instances found the properties \e processedFiles and \e ActionForFile. \li Input \code \endcode \li Configuration \code \endcode \li Expected Output \code \endcode

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	init() Initialize the work.
void	setValue(NameValueUnit[][] nvu) Set the named values to rule.
void	terminate() The terminate method reset the class variables.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

execute, getValue

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

Constructor Detail

AttributeValuesToPropertyRule

public AttributeValuesToPropertyRule()

Method Detail

setValue

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

Description copied from interface: RuleIF

Set the named values to rule. The rule decides how to organize the array structur. To have a homogenous environment try to hold in mind that the first index should assign something like instances and the second the attributes belong to the instances.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

init

public void init()
          throws InitializationFailedException

Description copied from class: AbstractImplementation

Initialize the work.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

terminate

public void terminate()
               throws TerminationException

Description copied from class: AbstractSequencerRule

The terminate method reset the class variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractSequencerRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()