com.highqsoft.moma.rules.mearules

Class UseTargetQuantityDatatype

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.mearules.AbstractMeasurementRule

com.highqsoft.moma.rules.mearules.UseTargetQuantityDatatype

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class UseTargetQuantityDatatype
extends AbstractMeasurementRule

\page MeasurementRules \section rules_com_highqsoft_moma_rules_mearules_UseTargetQuantityDatatype UseTargetQuantityDatatype \addindex UseTargetQuantityDatatype This rule will copy the default_datatype of a quantity to the attribute of an instance. Usually this rule is used for measurement quantities, but for greater flexibility the base attribute datatype is not used and the attribute name must be given as argument. The mapping is done in three steps: - If there is a quantity with the same name its datatype is used. - If there is no quantity and a default datatype is specified the default datatype is used. - If there is no quantity and no default datatype the datatype is not changed. \subsection UseTargetQuantityDatatypeProperties Properties \addindex UseTargetQuantityDatatype Properties The UseTargetQuantityDatatype is initzialized with the following properties: \li \b MeasurementHolderRef (required)
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)
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 MeqNameAttr (required, no default)
The measurement quantities base attribute "name". \li \b MeqDatatypeAttr (required, no default)
The measurement quantities base attribute "data_type" \li \b LcNameAttr (optional, no default)
The local columns base attribute "name". \li \b LcDatatypeAttr (optional, no default)
The local columns base attribute "data_type". \li \b DefaultDatatype (optional, no default)
A default datatype that is used if no quantity is found for a measurement quantity \li \b OdsCacheRef (required, no default)
\subsection UseTargetQuantityDatatypeExample Example \addindex UseTargetQuantityDatatype Example The example below is called from the \ sequence in a modelmapper control file. It updates the measurement quantities attribute "DatenTyp" with the default datatype of the quantity with the same name. The measurement quantity name is stored in the attribute "MessGroesse". It also updates the local column attribute "Datatype" if the attribute "Name" matches a quantities name. Since there is no "DefaultDatatype" the datatypes of measurement quantities and local columns with no matching quantity are left untouched. \endcode \subsection UseTargetQuantityDatatypeMomaMethods Methods used within the Modelmapper \addindex UseTargetQuantityDatatype Modelmapper Methods \li void execute()
Perform the datatype update as described above. \li void setValue(NameValueUnit[][] nvu)
Call execute().

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

Method Summary

Methods

Modifier and Type	Method and Description
void	changeDatatype(NameValueUnit[][] nvu, java.lang.String nameAttr, java.lang.String dtAttr) Change the data type.
void	execute() Execute the program.
NameValueUnit[][]	getValue() call execute()
void	init() The init method, get and check the arguments
void	terminate() The terminate method reset the private variables.
void	updateLcDatatype(NameValueUnit[][] nvu, java.lang.String nameAttr, java.lang.String dtAttr) Change the data type.

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

getDumpFilePath, getMeasurementHolder, setValue, 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

UseTargetQuantityDatatype

public UseTargetQuantityDatatype()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

call execute()

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractMeasurementRule

Returns:

The name value of the rule.

Throws:

RuleException

See Also:

RuleIF.setValue(NameValueUnit[][] nvu)

updateLcDatatype

public void updateLcDatatype(NameValueUnit[][] nvu,
                    java.lang.String nameAttr,
                    java.lang.String dtAttr)
                      throws ExecutableException

Change the data type.

Parameters:

nvu - The NameValueUnit[][] that holds the instances ant attributes

nameAttr - The name of the attribute containing the name

dtAttr - The name of the attribute containing the data type

Throws:

ExecutableException

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.

See Also:

AbstractImplementation.init()

terminate

public void terminate()
               throws TerminationException

The terminate method reset the private variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractSequencerRule.terminate()

changeDatatype

public void changeDatatype(NameValueUnit[][] nvu,
                  java.lang.String nameAttr,
                  java.lang.String dtAttr)
                    throws ExecutableException

Change the data type.

Parameters:

nvu - The NameValueUnit[][] that holds the instances ant attributes

nameAttr - The name of the attribute containing the name

dtAttr - The name of the attribute containing the data type

Throws:

ExecutableException