com.highqsoft.moma.rules.ods

Class AddOrdinalNumber

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.ods.AddOrdinalNumber

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class AddOrdinalNumber
extends AbstractSequencerRule

\page OdsRules \section rules_com_highqsoft_moma_rules_ods_AddOrdinalNumber AddOrdinalNumber \addindex AddOrdinalNumber \addindex ordinal number This rule is used to add the next used ordinal number of the files for the instances of the external component to append the values of the external component file as values of the 'localcolumn' instances. When the 'ordinal_number' of the instances in the data storage is not set these attributes will be updated with the value 1. The data set will be extended with the max(ordianl_number) + 1. Type: SequencerRule \par Properties \li \b ElementName (optional, no default, DT_STRING)
The name of the application Element. \li \b OdsCacheRef (required, no default, DT_STRING)
The name of the ODS Cache reference in the context. \par Example The example below is called from the sequence in a modelmapper control file. \code \endcode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	elementName
protected ODSCache	odsCache

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

Method Summary

Methods

Modifier and Type	Method and Description
void	init() The init method.
void	setValue(NameValueUnit[][] nvu) Set the named values to rule.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

execute, getValue, terminate

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

elementName

protected java.lang.String elementName

odsCache

protected ODSCache odsCache

Constructor Detail

AddOrdinalNumber

public AddOrdinalNumber()

Method Detail

init

public void init()
          throws InitializationFailedException

The init method.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

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