com.highqsoft.moma.rules.mapping

Class CalcAttrValueRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.mapping.CalcAttrValueRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class CalcAttrValueRule
extends AbstractSequencerRule

\page MappingRules \section rules_com_highqsoft_moma_rules_mapping_CalcValueRule CalcAttrValueRule \addindex CalcAttrValueRule \addindex attribute value calculation This rule calculates the value of a new attribute on the basis of the given input attributes. Input attributes which are not available in the line will be skipped. The order of the given input attribute names are used as order in the calculation, important for the operation \em sub and \em div. The input values are converted to the given datatype and the result data will be in the given value. If the input data can not be converted or parsed, an error is reported. The result data will be the datatype. There must be at least 2 input attribute names. Type: SequencerRule \par Properties \li \b AttributeName (required, no default, DT_STRING)
The name of attribute where the values will be changed. \li \b operation (required, no default, DT_STRING)
The Operation on the values, this can be 'add', 'sub', 'multi', 'div, 'mod'. \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 InputAttributeNames (required, no default, DT_STRING)
The list with input attributes names. There must be at least 2 input attribute names. \li \b datatype (required, no default, DT_STRING)
The datatype of the result, it must be a numeric datatype. \par Test 1 This is called from the sequence in a modelmapper control file. The value BlockSize will be calculated and stored in the result dataset as DT_LONG. \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	attributeValueName
protected DataType	datatype
protected java.lang.String[]	inputAttrNames
protected int	op
protected static int	OP_ADD
protected static int	OP_DIV
protected static int	OP_MOD
protected static int	OP_MULTI
protected static int	OP_SUB
protected java.lang.String	operation

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

Method Summary

Methods

Modifier and Type	Method and Description
void	init() The init method, get the element name and the reference from the PACReturnWriter from the context.
void	setValue(NameValueUnit[][] nvu) The setValue, change the values.
void	terminate() The terminate method reset the private 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

Field Detail

OP_ADD

protected static final int OP_ADD

See Also:

Constant Field Values

OP_SUB

protected static final int OP_SUB

See Also:

Constant Field Values

OP_MULTI

protected static final int OP_MULTI

See Also:

Constant Field Values

OP_DIV

protected static final int OP_DIV

See Also:

Constant Field Values

OP_MOD

protected static final int OP_MOD

See Also:

Constant Field Values

inputAttrNames

protected java.lang.String[] inputAttrNames

attributeValueName

protected java.lang.String attributeValueName

operation

protected java.lang.String operation

op

protected int op

datatype

protected DataType datatype

Constructor Detail

CalcAttrValueRule

public CalcAttrValueRule()

Method Detail

setValue

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

The setValue, change the values.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

See Also:

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

init

public void init()
          throws InitializationFailedException

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