com.highqsoft.moma.rules.ods

Class LinkToElementRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.ods.LinkToElementRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class LinkToElementRule
extends AbstractSequencerRule

\page OdsRules \section rules_com_highqsoft_moma_rules_ods_LinkToElementRule LinkToElementRule \addindex substitute \addindex instances names \addindex element ID This rule will substitute the names of the instances in the dataset with the Id of the element from the target element. When the dataset is inserted in the target the attribute values are the relations to the element. This rule does not work for N:M relations. Type: SequencerRule \par Properties \li \b ElementToLinkWith (required, no default, DT_STRING)
The name of the application element to link the element to. \li \b RelationName (required, no default, DT_STRING)
Name of the application relation used for the link. \li \b OdsCacheRef (required, no default, DT_STRING)
The reference to the target ODS Cache. \li \b LoadAll (optional, default false, DT_BOOLEAN)
Switch to load all instances at the beginning of the linking. \par Example \addindex LinkToElementRule Example The example below is called from the \ sequence in a modelmapper control file. It creates a relation from the currently processed element to the Environment in the target database, which has always id 1 in this case. \code \endcode

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	fillMap(java.util.HashMap<java.lang.String,T_LONGLONG> instIdMap)
void	init() The init method, get the arguments.
protected T_LONGLONG	loadId(java.lang.String instName)
void	setValue(NameValueUnit[][] nvu) Get the instance id from the target and write it to the relation attribute.

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

Constructor Detail

LinkToElementRule

public LinkToElementRule()

Method Detail

fillMap

protected void fillMap(java.util.HashMap<java.lang.String,T_LONGLONG> instIdMap)
                throws AoException,
                       RuleException

Throws:

AoException

RuleException

loadId

protected T_LONGLONG loadId(java.lang.String instName)
                     throws AoException,
                            RuleException

Throws:

AoException

RuleException

setValue

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

Get the instance id from the target and write it to the relation attribute. The target element is stored in the ODSCache

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

init

public void init()
          throws InitializationFailedException

The init method, get the arguments.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.