com.highqsoft.moma.rules.ods

Class GetMaxChildInstanceId

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.ods.GetMaxChildInstanceId

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class GetMaxChildInstanceId
extends AbstractSequencerRule

\page OdsRules \section rules_com_highqsoft_moma_rules_ods_GetMaxChildInstanceId GetMaxChildInstanceId \addindex GetMaxChildInstanceId This rule is used to read the Id of the instances with the given name from the input data set. The instances are searched as child of the parent element. In the dataset is an attribute which match the name attribute of the element. The result dataset will replace the values of the attribute which match the Id attribute with the Id from the target. When the Id attribute is not available in the dataset, the dataset will be extended with this attribute. Type: SequencerRule \par Properties \li \b ElementName (required, no default, DT_STRING)
The name of the application Element. \li \b OdsCacheRef (required, no default, DT_STRING)
The name of the ODSCache reference in the context. \li \b CacheAttribute (required, no default, DT_STRING)
The name of the base attribute which will be used for the cache to find the attribute. \li \b SortAttribute (required, no default, DT_STRING)
The name of the attribute (base or attribute) which will be used to sort the results The first Id according the order is used. \li \b SortDirectrion (required, default "descending", DT_STRING)
The sort direction of the sort attribute. Value can be "ascending" or "descending". \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	cacheAttribute
protected java.lang.String	elementName
protected ODSCache	odsCache
protected java.lang.String	sortAttribute
protected java.lang.String	sortDirection

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

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

cacheAttribute

protected java.lang.String cacheAttribute

sortAttribute

protected java.lang.String sortAttribute

sortDirection

protected java.lang.String sortDirection

Constructor Detail

GetMaxChildInstanceId

public GetMaxChildInstanceId()

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