com.highqsoft.moma.rules.utils

Class MapValueRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.MapValueRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class MapValueRule
extends AbstractSequencerRule

\page MapValueRule \section rules_com_highqsoft_moma_rules_utils_MapValueRule MapValueRule \addindex map value This rule takes a value as argument and does mapping based on a name map defined in an xml file. The structure of the mapping definition file is: \code \endcode Type: SequencerRule \par Properties \li \b MappingFile (required, no default, DT_STRING)
File containing the mapping rules. \li \b MappingType (required, no default, DT_STRING)
The mapping type to use. Different types enable the configuration of different mappings in a single configuration file. \li \b OldValue (required, no default, DT_STRING)
The value to be mapped. \li \b NewValueProperty (required, no default, DT_STRING)
The property where the new value is stored. \li \b AbortOnMissingMapping (optional, default false, DT_BOOLEAN)
If this Property is true the rule throws an exception if there is no mapping for \e OldValue. Otherwise the default value is used if it is configured in the mapping file. If there is no default value, OldValue is used without mapping. Note that the default value is ignored if \e AbortOnMissingMapping is true. \par Example The example below is called from the \ sequence in a modelmapper control file. It loads the mapping file defined in ${MappingFile} and searches for a map named "Project". If the value supplied in ${Arg.Project} is found it is mapped and the new Value is stored in the property "ProjectGroup" in the context. If the old value is not found and a default value is specified in the xml file the default value is used. If no default value is configured the old value is used. \code \endcode The following code shows an example for a mapping file: \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
MapValueRule()

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() The getValue method, return the values of the AbstractSequencerRule.localNVU field.
void	init() Get the required arguments.
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

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

MapValueRule

public MapValueRule()

Method Detail

init

public void init()
          throws InitializationFailedException

Get the required 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

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

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

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