com.highqsoft.moma.rules.mearules

Class MeasurementHolderRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.mearules.MeasurementHolderRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class MeasurementHolderRule
extends AbstractSequencerRule

\page MeasurementRules \section rules_com_highqsoft_moma_rules_mearules_MeasurementHolderRule MeasurementHolderRule \addindex MeasurementHolderRule The MeasurementHolderRule iis used to get or set a dataset from or to the MeasurementHolder object The following datasets are supported for the elements derived from -# AoMeasurement -# AoPhysicalDimension -# AoUnit -# AoQuantity The rule is a sequencer rule \subsection MeasurementHolderRuleProperties Properties \addindex MeasurementHolderRule Properties The MeasurementHolderRule is initialized with the following properties: \li \b MeasurementHolderRef (required)
Reference to the MeasurementHolder that will be written to the target. \li \b DataSetElementName (required)
the name of the element which dataset should be handled. The name must be in the list above. \subsection MeasurementHolderRuleExample Example \addindex MeasurementHolderRule Example The example below is called from the sequence in a modelmapper control file. It writes the measurements and all related instances stored in the MeasurementHolder referenced by the name "MeaHolder" \code \endcode \subsection MeasurementHolderRuleMomaMethods Methods used within the Modelmapper \addindex MeasurementHolderRule Modelmapper Methods \li getValue(),setValue()

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	dataSetElementName
protected java.lang.String	meaHolderRef

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

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() Get the data set of the requested element.
void	init() Check the properties and store them in fields for the execute() and writeElement() methods.
void	setValue(NameValueUnit[][] nvu) Store the instances of Measurement in the holder
void	terminate() The terminate method reset the class 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

dataSetElementName

protected java.lang.String dataSetElementName

meaHolderRef

protected java.lang.String meaHolderRef

Constructor Detail

MeasurementHolderRule

public MeasurementHolderRule()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Get the data set of the requested element.

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

Store the instances of Measurement in the holder

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

init

public void init()
          throws InitializationFailedException

Check the properties and store them in fields for the execute() and writeElement() methods.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

terminate

public void terminate()
               throws TerminationException

Description copied from class: AbstractSequencerRule

The terminate method reset the class variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractSequencerRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()