com.highqsoft.moma.rules.mapping

Class ReplaceRelationIdStatic

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.mapping.ReplaceRelationIdStatic

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class ReplaceRelationIdStatic
extends AbstractSequencerRule

\page MappingRules \section rules_com_highqsoft_moma_rules_mapping_ReplaceRelationIdStatic ReplaceRelationIdStatic \addindex ReplaceRelationIdStatic This rule changes the value of a relation. The ids of the source and target elements is taken from a mapping file. Each line in the mapping file must follow the syntax =. The mapping file can be created with the Rule \ref CreateStaticMapping. \b WARNING
This rule was created to avoid unnecessary queries of Unit and Quantity Ids on the source and target database during the migration of a whole ODS database. The rule can only be used if it is guaranteed that the ids and names of the mapped elements do not change between creation of the mapping file and using the Rule! Type: SequencerRule \par Properties \li \b TargetSessionReference (required, no default, DT_STRING)
The name of the reference to the target session. \li \b TargetCacheReference (required, no default, DT_STRING)
The name of the reference to the ODSCache object of the target session. \li \b RelatedApplicationElementName (required, no default, DT_STRING)
The name of the application element the relation points to ("related element"). \li \b RelationAttributeName (required, no default, DT_STRING)
The name of the application relation to update. \li \b MappingFileName (required, no default, DT_STRING)
The name of the file that contains the mapping. \li \b AbortOnMissingTarget (optional, default "true", DT_BOOLEAN)
If this flag is set to "true" an exception is thrown if the related element does not exist in the target database. Otherwise the relation is not created and a warning is written to the messenger. \par Example The example below is used to link a measurement quantity to a unit in the target database. The unit must have the the same name as the related unit in the source. It is called within the part of the MoMa control file. \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
ReplaceRelationIdStatic()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method, nothing to do.
NameValueUnit[][]	getValue() Hands the name value units from the rule back to the framework.
void	init() Get the required arguments: -SourceSessionReference - mandatory reference by name of the source session.
void	setValue(NameValueUnit[][] nvu) Hands the name value units from the framework over to the rule.
void	terminate() The terminate method reset the private variables.

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

ReplaceRelationIdStatic

public ReplaceRelationIdStatic()

Method Detail

setValue

public void setValue(NameValueUnit[][] nvu)

Hands the name value units from the framework over to the rule.

Parameters:

nvu - The NameValueUnit[][] containing the instances

See Also:

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

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Hands the name value units from the rule back to the framework.

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractSequencerRule

Returns:

The result of the previous rule in the sequence

Throws:

RuleException

See Also:

RuleIF.getValue()

init

public void init()
          throws InitializationFailedException

Get the required arguments:
-SourceSessionReference - mandatory reference by name of the source session.
-TargetSessionReference - mandatory reference by name of the target session.
-RelationAttributeName - mandatory name of an attribute which holds the relation.
-RelatedApplicationElementName - mandatory name of the application element,
the current application element is related to.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException

See Also:

AbstractImplementation.init()

execute

public void execute()
             throws ExecutableException

Description copied from class: AbstractSequencerRule

The execute method, nothing to do.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractSequencerRule

Throws:

ExecutableException - if execution fails.

See Also:

AbstractRule.execute()

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

See Also:

AbstractSequencerRule.terminate()