com.highqsoft.moma.rules.ods

Class GetIdFromOdsCache

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.ods.GetIdFromOdsCache

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class GetIdFromOdsCache
extends AbstractRule

\page OdsRules \section rules_com_highqsoft_moma_rules_ods_GetIdFromOdsCache GetIdFromOdsCache \addindex instance ID \addindex ODSCache This rule reads the Id of an instance written by the elementToRule from the ODSCache and stores it in the context. This is only possible when RememberInstances is true in the ElementToRule of the requested element. If the rule is called in the section, it returns a NameValuUnit[][] containing the id attribute of all instances found. Type: SequencerRule \par Properties \li \b ElementName (required, no default, DT_STRING)
The application element name of the instance we look for. \li \b SourceId (required, no default, DT_STRING)
The instances id in the data source. If the properties value is "*" a list of all ids separated with a blank is returned. \li \b OdsCacheRef (required, no default, DT_STRING)
The name of the ODSCache reference in the context. \li \b ComposeChar (optional, " ", DT_STRING)
The character o rstring between the different Ids.. \li \b ResultProperty (required, no default, DT_STRING)
The name of the Property where the found id is stored. \par Example The example below is called from the \ sequence in a modelmapper control file. It reads the the target id of the Instance of "Messung" which had the id "1" in the source and stores it in the Property "MeaId". \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
GetIdFromOdsCache()

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() Get the named value from rule.
void	init() get the properties
void	setValue(NameValueUnit[][] nvu) The setValue, add the attribute and the value.
void	terminate() Terminate the execution.

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

GetIdFromOdsCache

public GetIdFromOdsCache()

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)
              throws RuleException

The setValue, add the attribute and the value.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

See Also:

RuleIF.setValue(org.asam.ods.NameValueUnit[][])

init

public void init()
          throws InitializationFailedException

get the properties

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

terminate

public void terminate()
               throws TerminationException

Description copied from class: AbstractRule

Terminate the execution. This implementation does nothing by default. Can be overridden.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.