com.highqsoft.moma.rules.mearules

Class SetIndependentFlag

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.mearules.AbstractMeasurementRule

com.highqsoft.moma.rules.mearules.SetIndependentFlag

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class SetIndependentFlag
extends AbstractMeasurementRule

\page MeasurementRules \section rules_com_highqsoft_moma_rules_mearules_SetIndependentFlag SetIndependentFlag \addindex SetIndependentFlag This rule will set the independent flag to 1 at the local column that matches the Property "IndependentColumnName". Some data models also rely on an independent attribute at the measurement quantity. This attribute can be set by using the optional properties "MeqIndependentAttribute" and "MeqNameAttribute". Datatype DT_SHORT is used for this attribute. \subsection SetIndependentFlagProperties Properties \addindex SetIndependentFlag Properties The SetIndependentFlag rule is initzialized with the following properties: \li \b MeasurementHolderRef (required) \n The name of the reference in the context where the MeasurementHolder instance that is used as input for the rule is stored. \li \b ResultRef (optional, MeasurementHolderRef) \n The name of the reference in the context where the resulting MeasurementHolder instance is stored. If it is omitted the resulting MeasurementHolder instance replaces the input instance. \li \b DumpFilePath (optional, no default)
The directory where the dumpfiles are created. If this Property is set and is not an empty string the rule creates a dump of all modified ElementHolders. The dump files are named "\_\_*.dmp. \li \b IndependentColumnName (required, no default)
The name of the independent column. The independent flag for this local column is set to 1, the flag for all other local columns is set to 0. If the properties "meqIndependentAttribute" and "meqNameAttribute" are used the flag is also set at the measurement quantity with the same name. \li \b lcIndependentAttribute (required, no default)
The name of the local columns base attribute "independent". \li \b lcNameAttribute (required, no default)
The name of the local columns base attribute "name". \li \b meqIndependentAttribute (optional, no default)
The name of the measurement quantity attribute that is used to mark it as independent. ODS does not require an independent flag at the measurement quantity. \li \b meqNameAttribute (optional, no default)
The name of the local columns base attribute "name". \subsection SetIndependentFlagExample Example \addindex SetIndependentFlag Example The example below is called from the \ sequence in a modelmapper control file. It sets the attribute "independent" of the local column named "TIMESTAMP" to 1. It also sets the attribute "IsIndependent" of the measurement quantity "TIMESTAMP" to 1. For all other local columns and measurement quantities this attribute is set explicitly to 0. \code \endcode \subsection SetIndependentFlagMomaMethods Methods used within the Modelmapper \addindex SetIndependentFlag Modelmapper Methods \li void execute()
Sets the independent flag as described above. \li void setValue(NameValueUnit[][] nvu)
Calls the execute() method.

Field Summary

Fields inherited from class com.highqsoft.moma.rules.mearules.AbstractMeasurementRule

dumpFilePath, ignoreMissingValues, measurementHolderRef, resultRef

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the program.
void	init() The init method, get and check the arguments
void	setValue(NameValueUnit[][] nvu) Call execute()
void	terminate() The terminate method does nothing here

Methods inherited from class com.highqsoft.moma.rules.mearules.AbstractMeasurementRule

getDumpFilePath, getMeasurementHolder, getValue, storeResult

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

SetIndependentFlag

public SetIndependentFlag()

Method Detail

setValue

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

Call execute()

Specified by:

setValue in interface RuleIF

Overrides:

setValue in class AbstractMeasurementRule

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

execute

public void execute()
             throws ExecutableException

Description copied from class: AbstractRule

Execute the program. This implementation does nothing by default. Can be overridden.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractMeasurementRule

Throws:

ExecutableException - if execution fails.

init

public void init()
          throws InitializationFailedException

The init method, get and check the arguments

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractMeasurementRule

Throws:

InitializationFailedException - if the initialization fails.

terminate

public void terminate()
               throws TerminationException

The terminate method does nothing here

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractSequencerRule.terminate()