com.highqsoft.moma.rules.mapping

Class AddIdRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.mapping.AddIdRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class AddIdRule
extends AbstractSequencerRule

\page MappingRules \section rules_com_highqsoft_moma_rules_mapping_AddIdRule AddIdRule \addindex AddIdRule \addindex add id \addindex id attribute This rule adds an attribute which represents an Id. Type: SequencerRule \par Properties \li \b AttributeName (required, no default, String)
The name of the attribute. \li \b InitialValue (optional, default 1, int)
The initial value of the attribute. \li \b NextValueProperty (optional, no default, String)
If set, the maximum used id + 1 is stored in the property. The stored value can be used as an InitialValue for another rule. \par Test 1 This is called from the sequence in a modelmapper control file. Id adds the Attributes "Id" to all instances passed to it. \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
protected int	initialValue

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

Method Summary

Methods

Modifier and Type	Method and Description
protected NameValueUnit	createNameValueUnit(java.lang.String name) Create a NameValueUnit, the name is set, the value and the union are initialized, the flag of the values is set to valid, the unit is an empty unit.
void	init() The init method, get and check the arguments
void	setValue(NameValueUnit[][] nvu) Add the Attributes and Values to the NameValueUnit[][].
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

attributeName

protected java.lang.String attributeName

initialValue

protected int initialValue

Constructor Detail

AddIdRule

public AddIdRule()

Method Detail

createNameValueUnit

protected NameValueUnit createNameValueUnit(java.lang.String name)

Create a NameValueUnit, the name is set, the value and the union are initialized, the flag of the values is set to valid, the unit is an empty unit.

Parameters:

name - the name

Returns:

the created name value unit

setValue

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

Add the Attributes and Values to the NameValueUnit[][]. If an attribute already exists its value is overwritten.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

init

public void init()
          throws InitializationFailedException

The init method, get and check the 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

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