com.highqsoft.moma.rules.mearules.xatf

Class MeasurementToRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.mearules.MeasurementToRule

com.highqsoft.moma.rules.mearules.xatf.MeasurementToRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class MeasurementToRule
extends MeasurementToRule

\page MeasurementXatfRules \section rules_com_highqsoft_moma_rules_mearules_xatf_MeasurementToRule MeasurementToRule \addindex MeasurementToRule The MeasurementToRule is used to write the content of a MeasurementHolder object created by the XATFReader to the target. The current implementation supports only flags and values stored in component files. Flags and Values stored directly in the XATF file are ignored and not handled. This rule uses the \ref ElementToRule and the \ref AoFileToRule to write the Elements of the Measurements in the order -# AoPhysicalDimension -# AoUnit -# AoQuantity -# AoMeasurement -# AoMeasurementQuantity -# AoSubmatrix -# AoLocalColumn -# AoFile -# AoExternalComponent The catalog elements AoPhysicalDimension, AoUnit and AoQuantity are optional and are only written if they were loaded during initialization of the MeasurementHolder object and if the property "WriteCatalogs" is set true. If "WriteCatalogs is set false and the catalog elements were loaded during the initialization all elements that have a matching element in the target database are written to the ODSCache. The measurement quantities are then automatically linked to the units and quantities with the same name in the target model. The rule allows to add or remove columns in append mode and takes care to create missing values and flags in this case. It also converts global flags to single value flags in case the global flag differs between existing and newly inserted values. \subsection MeasurementToRuleProperties Properties \addindex MeasurementToRule Properties The MeasurementToRule is initzialized with the following properties: \li \b MeasurementHolderRef (required)
Reference to the MeasurementHolder that will be written to the target. \li \b OdsCacheRef (required)
Reference to the ODSCache instance of the target service. \li \b RememberInstances (optional, default="YES")
If this property is set to "YES" the ids of the created elements in the target are stored in the ODSCache instance referenced by \em ODSCacheRef. This is required if you want to create relations to one of the created elements later in the Moma process. \li \b InsertMode (optional, default="abort")
This property defines the behavior if an InstanceElement that shall be written to the target already exists. There are four possible options: - \b abort: The rule throws an exception and aborts the Modelmapper - \b ignore: The rule doesn't write the new Instance Element. The existing one is used instead. - \b update: If the Instance Element exists it is replaced by the new one. - \b no_check: If it is not possible that the instance exists the check can be omitted. Use this option only if you can be sure that the Instance Element doesn't exist, for example because the parent instance was inserted in "abort" mode. - \b append: In mode append the external components are appended if there is already a measurement. All other base elements are inserted in mode "update". The catalogs are always inserted in mode "ignore", because it makes no sense to update them during insert of a Measurement. \li \b WriteCatalogs (optional, default="no")
If this property is set to "yes" the Physical Dimensions, Units and Quantities in the MeasurementHolder are written to the target database. Everything else than "yes" is interpreted as "no" and the catalog elements are not written. \li \b Cleanup (optional, default="no")
If this property is set to "yes" all Elements stored in MeasurementHolderRef are destroyed after they are written to the target. The reference MeasurementHolderRef is removed from the context. \li \b LogExisting (optional, default "yes")\n If "yes" the ElementToRule logs the name and Id of all existing elements that will be ignored or updated to the messenger file. This can be a very huge amount of log data! All other values are interpreted as "no". \li \b VersionIsLong (optional, default "no")\n If "yes" the ElementToRule assumes datatype DT_LONG for base attribute "version". This is needed to write to older Santorin servers. \li \b DefaultQuantity (optional, no default)\n If a default Quantity is configured it is used if the Quantity in the data source does not exist in the target. If the default Quantity does not exist in the target an error is thrown. The default Quantity is also used if the Measurement Quantity in the source has no relation to a Quantity. \li \b DefaultUnit (optional, no default)\n If a default Unit is configured it is used if the Unit in the data source does not exist in the target. If the default Unit does not exist in the target an error is thrown. The default Unit is also used if the Measurement Quantity in the source has no relation to a Unit. \li \b ErrorReasonProperty (optional, no default)\n If this property exists and an exception is thrown in the MeasurementToRule a unique identifier is written to the \li \b IgnoreMissingValuesToAppend (optional, default "No") \n If this property is set to "Yes" the rule continues if not all submatrices of a measurement have values to append in the source data. Otherwise an exception is thrown. \li \b AllowColumnMismatch (optional, default "No") \n If this property is set to "Yes" a mismatch of local columns and / or submatrices is allowen in append mode. If a new local column is found during append the column is added and the values for all existing rows are added and marked as invalid. If a local column is missing during append the values for all new rows are added and marked as invalid. \subsection MeasurementToRuleExample Example \addindex MeasurementToRule 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 MeasurementToRuleMomaMethods Methods used within the Modelmapper \addindex MeasurementToRule Modelmapper Methods \li void execute()
The execute method calls the setValue() method of the ElementToRule to write the InstanceElements stored in the MeasurementHolder instance to the target. Before the instances are written the method ensures that missing flags and values are generated.

Field Summary

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

abortOnMissingTargetAttr, allowColumnMismatch, defaultQuantity, defaultUnit, errorReasonProperty, ignoreMissingValuesToAppend, insertMode, keyword, logExisting, meaHolderRef, odsCache, odsCacheRef, performCleanup, rememberInstancesId, versionIsLong, writeCatalogs

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	appendLcValues(MeasurementHolder meaHolder) Append External Components to existing Local Columns.
void	init() Check the properties and store them in fields for the execute() and writeElement() methods.
void	setValue(NameValueUnit[][] nvu) Set the named values to rule.
void	terminate() The terminate method reset the class variables.

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

appendInvalidValues, checkQuantities, checkUnits, createInvalidValueSeq, elementToOdsCache, getAttributeIndex, getAttributeValueAsString, getExistingColumns, getIndependentColumns, getValue, insertNewValuesToExisting

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

Constructor Detail

MeasurementToRule

public MeasurementToRule()

Method Detail

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.

Specified by:

setValue in interface RuleIF

Overrides:

setValue in class MeasurementToRule

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

appendLcValues

protected void appendLcValues(MeasurementHolder meaHolder)
                       throws RuleException

Append External Components to existing Local Columns.

Parameters:

meaHolder - The MeasurementHolder containing the values to write

Throws:

AoException

RuleException

init

public void init()
          throws InitializationFailedException

Description copied from class: MeasurementToRule

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

Specified by:

init in interface ImplementationIF

Overrides:

init in class MeasurementToRule

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 MeasurementToRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()