com.highqsoft.moma.rules.mearules

Class AbstractMeasurementRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.mearules.AbstractMeasurementRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

Direct Known Subclasses:

AbstractMeasurementRule, AddLiteralsRule, AddMeqUnitNameAttr, CalculateStatisticAttributes, ChannelValuesToParameters, ChannelValuesToProperties, CloneAttributesRule, CloneLocalColumn, CreateQuantities, CsvMeasurementHolder, FilterColumns, GetStorageModeFromMeasuement, InsertPointsInExistingMeasurement, LinkToTargetCatalogsByName, MakeImplicit, MdfFileValuesToComponents, MergeMeasurements, RenameAttributesRule, RenameColumns, SetIndependentFlag, UseTargetQuantityDatatype, ValuesToComponents

public abstract class AbstractMeasurementRule
extends AbstractRule

\page HelperRules \section AbstractMeasurementRule \addindex AbstractMeasurementRule This class should be used to derive MeaurementRules from. It provides two fields to store the MeasurementHolder object and the optional Name of the ResultRef. Both are initialized within the init() method so all rules derived from this class can use them without having to check them on their own. If ResultRef is used a copy of the MeasurementHolder object is created instead of using the input MeasurementHolder directly. For this reason the derived rules can always work on the MeasurementHolder stored in the context. \addindex AbstractMeasurementRule Properties \subsection AbstractMeasurementRuleProperties Properties The AbstractMeasurementRule provides the the following properties to all rules derived from it: \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)
If this path is configured the measurement rules can use it to write Dumps of the ElementHolder instances they modify. It is up to the rule developer du implement the dumps at the points of interest. Using the messenger or tracer for this type of output is a bad idea, because this can be a huge amount of data. If the path does not exist or is not writable and cannot be created an exception is thrown during the initialization phase. If an empty string is used as dump file path the behaviour is the same as if the property is missing. This is useful to define the DumpFilePath as a property in the header of the control file during development and debugging and set it to "" for productive use. \li \b IgnoreMissingValues (optional, default false)
If this property is true, MeasurementRules that deal with values (Calculate min / max for example) should ignore if values are not loaded. Otherwise they should throw an exception. \subsection AbstractMeasurementRuleMomaMethods Methods used within the Modelmapper \addindex AbstractMeasurementRule Modelmapper Methods \li void execute()
Restores the Object referenced by MeasurementHolderRef and stores it in the field measurementHolder. If the Property "ResultRef" exists a clone of the existing measurementHolder object is stored, otherwise the object itself. The execute() method of a derived rule must call super.execute() explicitly! \li NameValueUnit[][] getValue()
Restores the Object referenced by MeasurementHolderRef and stores it in the field measurementHolder. If the Property "ResultRef" exists a clone of the existing measurementHolder object is stored, otherwise the object itself. The getValue() method of a derived rule must call super.getValue() explicitly! The method always returns null. \li void init()
Reads the properties described above and stores them for later use. \subsection AbstractMeasurementRuleOtherMethods Methods that can be called from other rules \addindex AbstractMeasurementRule Other Public Methods \li MeasurementHolder getMeasurementHolder()
If the ResultRef property was specified during init() this method returns a clone of the MeasurementHolder object, otherwise the object itself. A rule writer can always work on the returned MeasurementHolder and doesn't have to worry about overwriting the original object if the result shall be stored in a new MeasurementHolder. \li String getDumpFilePath()
Returns the Path where dump files should be written. If the Property was not specified null is returned. The derived rules must not write a dump file in this case. \li void storeResult(MeasurementHolder)
Every derived rule must use this method to store the resulting MeasurementHolder in the context. The method automatically takes care of the ResultRef property.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	dumpFilePath
protected java.lang.Boolean	ignoreMissingValues
protected java.lang.String	measurementHolderRef
protected java.lang.String	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
AbstractMeasurementRule()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the program.
java.lang.String	getDumpFilePath()
MeasurementHolder	getMeasurementHolder()
NameValueUnit[][]	getValue() Get the named value from rule.
void	init() Initialize the work.
void	setValue(NameValueUnit[][] nvu) Set the named values to rule.
void	storeResult(MeasurementHolder measurementHolder)

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, terminate, 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

dumpFilePath

protected java.lang.String dumpFilePath

measurementHolderRef

protected java.lang.String measurementHolderRef

resultRef

protected java.lang.String resultRef

ignoreMissingValues

protected java.lang.Boolean ignoreMissingValues

Constructor Detail

AbstractMeasurementRule

public AbstractMeasurementRule()

Method Detail

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 AbstractRule

Throws:

ExecutableException - if execution fails.

init

public void init()
          throws InitializationFailedException

Description copied from class: AbstractImplementation

Initialize the work.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Description copied from interface: RuleIF

Get the named value from rule.

Returns:

The name value of the rule.

Throws:

RuleException

See Also:

RuleIF.setValue(NameValueUnit[][] nvu)

setValue

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

Description copied from interface: RuleIF

Set the named values to rule. The rule decides how to organize the array structur. To have a homogenous environment try to hold in mind that the first index should assign something like instances and the second the attributes belong to the instances.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

getMeasurementHolder

public MeasurementHolder getMeasurementHolder()

getDumpFilePath

public java.lang.String getDumpFilePath()

storeResult

public void storeResult(MeasurementHolder measurementHolder)