com.highqsoft.moma.rules.ods

Class GetInstanceElementsFromList

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.ods.GetInstanceElementsFromList

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class GetInstanceElementsFromList
extends AbstractRule

\page OdsRules \section rules_com_highqsoft_moma_rules_ods_GetInstanceElementsFromList GetInstanceElementsFromList \addindex ODS source \addindex instance GetInstanceElementsFromList is used to read one or more instances from an ODS source. The instance to read can be selected by - Application Element Name and list with Instance Id's - Application Element Name and list with Instance Names If this rule is used in a sequence or rules it must be the first one. The found instances can be stored in the context for later use by other rules. Type: SequencerRule \par Properties \li \b ApplicationElement (mandatory, no default, DT_STRING)
The name of the application Element. \li \b IdList (optional, no default, DT_STRING)
The id's of the Instance Element. \li \b NameList (optional, no default, DT_STRING)
The names of the Instance Element. Wildcards are allowed. \li \b SplitChar (optional, " ", DT_STRING)
The character for splitting IdList or NameList. \li \b ResultRef (optional, no default, DT_STRING)
If this property exists and is set true the rule does not throw an exception if the ApplicationElement does not exist in the data model. Instead it behaves as if there were no instances. \li \b IgnoreMissingInstances (optional, default false, DT_BOOLEAN)
If this property exists and is set true the rule does not throw an exception if there is no instance found at all. Although all properties are optional there must exist exactly one of the combinations - ApplicationElement / Id - ApplicationElement / Name \par Example The example below is called from the sequence in a modelmapper control file. It reads all Instances of "Test" that have a name starting with "MySpecialTest". The found instances are stored under the name "TestRef" in the context and passed to the to-rule "writeTest". \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
GetInstanceElementsFromList()

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() Get the instances from the ODS source.
void	init() The init method.
void	setValue(NameValueUnit[][] nvu) Set the named values to rule.

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

GetInstanceElementsFromList

public GetInstanceElementsFromList()

Method Detail

init

public void init()
          throws InitializationFailedException

The init method.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Get the instances from the ODS source.

Returns:

A NameValueUnit[][] containing the attributes of all instances found.

Throws:

RuleException

See Also:

RuleIF.setValue(NameValueUnit[][] nvu)

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