com.highqsoft.moma.rules.utils

Class CreateNewElementRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.utils.CreateNewElementRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class CreateNewElementRule
extends AbstractRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_CreateNewElementRule CreateNewElementRule \addindex CreateNewElementRule \addindex new element \addindex create element This rule Creates a new instance element and its attributes as a NameValueUnit[][]. Type: FromRule \par Properties \li \b AttributeNames (required, no default, DT_STRING)
A list of attribute names, separated by 'SplitChar'. \li \b AttributeValues (required, no default, DT_STRING)
A list of attribute values, separated by 'SplitChar'. \li \b AttributeDatatypes (optional, default "DT_STRING", DT_STRING)
A list of Datatypes, separated by 'SplitChar'. \li \b SplitChar (optional, default " ", DT_STRING)
The character used to split the lists. \li \b TrimListElements (optional, default false, DT_BOOLEAN)
If true, the values in the lists are trimmed. This may be necessary if long lists are split across lines in the job file. \li \b IgnoreUnresolvedProperties (optional, default false, DT_BOOLEAN)
If true, all unresolved properties used in \e AttributeValues are not added as attributes. The default behaviour is to add the property as ${propertyName}. This is problematic if the attribute has a numeric data type. \par Test 1 This is called from the \ sequence in a modelmapper control file. It creates a new element with the three attributes ProjectId (value 1), ProjectName (value stored in the property "ProjectName") and Description (value "Default Project for insert"). \li Input \code \endcode \li Configuration \code \endcode \li Expected Output \code \endcode

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() Get the named value from rule.
void	init() The init method, get the element name and the reference from the PACReturnWriter from the context.
void	setValue(NameValueUnit[][] nvu) The setValue, rename the values.
void	terminate() The terminate method reset the private variables.

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, 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

CreateNewElementRule

public CreateNewElementRule()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Description copied from interface: RuleIF

Get the named value from rule.

Returns:

The name value of the rule.

Throws:

RuleException

See Also:

RuleIF.setValue(NameValueUnit[][] nvu)

setValue

public void setValue(NameValueUnit[][] nvu)

The setValue, rename the values.

Parameters:

nvu - The name value of the rule.

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

Specified by:

init in class AbstractImplementation

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 AbstractRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractSequencerRule.terminate()