com.highqsoft.moma.rules.ods

Class TargetElemIdToContextReference

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.ods.TargetElemIdToContextReference

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class TargetElemIdToContextReference
extends AbstractSequencerRule

\page OdsRules \section rules_com_highqsoft_moma_rules_ods_TargetElemIdToContextReference TargetElemIdToContextReference \addindex TargetElemIdToContextReference This rule will copy a ods cache value into a context reference. The ODSCache stores the ElemId of the imported instances in a Hashtable. The key in this table is made from \\#\. The id in the identifier is taken from the data source. The aid and iid of the ElemId are taken from the target. Te rule can be useful to spawn post processing outside the current Modelmapper context. \subsection TargetElemIdToContextReferenceProperties Properties \addindex TargetElemIdToContextReference Properties The TargetElemIdToContextReference is initialized with the following properties: \li \b OdsCacheRef (required)
The name of the context reference where the ODSCache object is stored. \li \b Identifier (required)
The identifier of the ODSCache element, that should be stored in the context. \li \b Keyword (required)
The keyword that will be used to store the element to the context reference map. In addition to this keyword the two other references .iid and .aid are atutomatically generated. They contain the iid and aid part of the ElemId in String representation. \li \b AbortIfMissing (optional, default false)
If this property is set true the rule throws an exception if the identifier does not exist in the ODSCache. Otherwise a Warning level message is written to the messenger. \subsection TargetElemIdToContextReferenceExample Example \addindex TargetElemIdToContextReference Example The example below is called from the \ sequence in a modelmapper control file. It reads the ElemId denoted by the identifier "Messung\#1" and stores it in the context with the reference name "MessungsID". Additionally the two references "MessungsID.iid" and "MessungsId.aid" are created. They hold the instance id and the application element id in string representation for easier use in the control file. \code \endcode \subsection TargetElemIdToContextReferenceMomaMethods Methods used within the Modelmapper \addindex TargetElemIdToContextReference Modelmapper Methods \li void setValue(NameValueUnit[][] nvu)
Read the identifier and store the value in the context.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	abortIfMissing
protected java.lang.String	identifier
protected java.lang.String	keyword

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

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() The getValue method, return the values of the AbstractSequencerRule.localNVU field.
void	init() Get the arguments
void	setValue(NameValueUnit[][] nvu) Get the ElemId referenced by the identifier and store it in the context.
void	terminate() The terminate method reset the private variables.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

execute

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

identifier

protected java.lang.String identifier

keyword

protected java.lang.String keyword

abortIfMissing

protected boolean abortIfMissing

Constructor Detail

TargetElemIdToContextReference

public TargetElemIdToContextReference()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Description copied from class: AbstractSequencerRule

The getValue method, return the values of the AbstractSequencerRule.localNVU field. If rule property 'CLEANAFTERGET' was set to true, the nvu field of the rule is wiped to clear memory.

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractSequencerRule

Returns:

the values.

Throws:

RuleException

See Also:

RuleIF.getValue()

setValue

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

Get the ElemId referenced by the identifier and store it in the context.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

init

public void init()
          throws InitializationFailedException

Get the arguments

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

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