MeasurementToRule

java.lang.Object
- com.highqsoft.xsd.AbstractImplementation
- - com.highqsoft.xsd.AbstractRule
  - - com.highqsoft.xsd.AbstractSequencerRule
    - - com.highqsoft.moma.rules.mearules.MeasurementToRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

Direct Known Subclasses:

MeasurementToRule
```
public class MeasurementToRule
extends AbstractSequencerRule
```
\page MeasurementRules \section rules_com_highqsoft_moma_rules_mearules_MeasurementToRule MeasurementToRule \addindex MeasurementToRule The MeasurementToRule is used to write the content of a MeasurementHolder object to the target. This rule uses the \ref ElementToRule ElementToRule to write the Elements of the Measurements in the order -# AoPhysicalDimension -# AoUnit -# AoQuantity -# AoMeasurement -# AoMeasurementQuantity -# AoSubmatrix -# AoLocalColumn 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. \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 behaviour 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 local column values and flags are appended if there is already a measurement. All other base elements are inserted in mode "update". - \b insert: In mode insert the local column values and flags are inserted if there is already a submatrix. All other base elements are inserted in mode "update". The property "SortColumns" must contain one or more local columns used to sort the rows. - \b updateStatistics: Update statistic attributes of the measurement quantities only. No other application elements are written. The only use case for this mode is to get the MeasurementHoler from an ODS server, use the rule CalculateStatisticValues and the use MeasurementToRule to update the attributes. 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 LogMissingAttributes (optional, default "yes", DT_STRING)
If "yes" the ElementToRule logs the name of attributes in the source data set that do not have a matching attribute in the target. The message is useful during development, but should be turned off in normal operation. The default "yes" was choosen for backward compatibility. \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. \li \b SortColumns (required in mode \e insert, no default)
In mode \e insert, the position where the new points must be inserted is detected by the columns listed in this porperty. The order of the columns must be the natural sort order. If there is more than one submatrix in the measurement where the points are inserted, the independent column should be used as only SortColumn to get a valid valuematrix. \li \b SplitChar (optional, default " ")
The character used to split the columns listed in \e SortColumns \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.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`abortOnMissingTargetAttr`
`protected boolean`	`allowColumnMismatch`
`protected java.lang.String`	`defaultQuantity`
`protected java.lang.String`	`defaultUnit`
`protected java.lang.String`	`errorReasonProperty`
`protected boolean`	`ignoreMissingValuesToAppend`
`protected java.lang.String`	`insertMode`
`protected java.lang.String`	`keyword`
`protected boolean`	`logExisting`
`protected java.lang.String`	`meaHolderRef`
`protected ODSCache`	`odsCache`
`protected java.lang.String`	`odsCacheRef`
`protected boolean`	`performCleanup`
`protected boolean`	`rememberInstancesId`
`protected boolean`	`versionIsLong`
`protected boolean`	`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()

Constructors
Constructor and Description
`MeasurementToRule()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`appendInvalidValues(ValueMatrix vm, java.lang.String name, int nrOfNewValues)` Append invalid values to a local column that was removed from an existing submatrix
`protected void`	`checkQuantities(ElementHolder[] meqHolders, ElementHolder qtyHolder)`
`protected void`	`checkUnits(ElementHolder[] meqHolders, ElementHolder unitHolder)`
`protected TS_ValueSeq`	`createInvalidValueSeq(DataType dt, int nrOfNewValues)` Create a TS_ValueSeq with invalid values of the specified data type
`protected void`	`elementToOdsCache(java.lang.String baseElement, NameValueUnit[][] nvu)`
`protected int`	`getAttributeIndex(NameValueUnit[] nvu, java.lang.String attrName)` Get the index on an attribute in the NameValueUnit[] of an instance
`protected java.lang.String`	`getAttributeValueAsString(NameValueUnit[] nvu, java.lang.String attrName)` Get the values in the TS_Union as a String
`protected java.util.Hashtable<java.lang.String,java.lang.Integer>`	`getExistingColumns(ValueMatrix vm)`
`protected java.util.HashSet<java.lang.String>`	`getIndependentColumns(ValueMatrix vm)`
`NameValueUnit[][]`	`getValue()` The getValue method, return the values of the `AbstractSequencerRule.localNVU` field.
`void`	`init()` Check the properties and store them in fields for the execute() and writeElement() methods.
`short[]`	`insertNewValuesToExisting(DataType dt, TS_Value vNew, TS_ValueSeq vOld, short[] newFlags, int indexToInsert)` Insert the new points in the correct position.
`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.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
  - odsCache
```
protected ODSCache odsCache
```
  - meaHolderRef
```
protected java.lang.String meaHolderRef
```
  - keyword
```
protected java.lang.String keyword
```
  - rememberInstancesId
```
protected boolean rememberInstancesId
```
  - insertMode
```
protected java.lang.String insertMode
```
  - writeCatalogs
```
protected boolean writeCatalogs
```
  - performCleanup
```
protected boolean performCleanup
```
  - logExisting
```
protected boolean logExisting
```
  - versionIsLong
```
protected boolean versionIsLong
```
  - defaultUnit
```
protected java.lang.String defaultUnit
```
  - defaultQuantity
```
protected java.lang.String defaultQuantity
```
  - abortOnMissingTargetAttr
```
protected boolean abortOnMissingTargetAttr
```
  - ignoreMissingValuesToAppend
```
protected boolean ignoreMissingValuesToAppend
```
  - errorReasonProperty
```
protected java.lang.String errorReasonProperty
```
  - allowColumnMismatch
```
protected boolean allowColumnMismatch
```
  - odsCacheRef
```
protected java.lang.String odsCacheRef
```
- Constructor Detail
  - MeasurementToRule
```
public MeasurementToRule()
```
- Method Detail
  - getValue
```
public NameValueUnit[][] getValue()
                           throws RuleException
```
    Description copied from class: AbstractSequencerRule
    
    The getValue method, return the values of the AbstractSequencerRule.localNVU field. If rule property 'CLEANAFTERGET' was set to true, the nvu field of the rule is wiped to clear memory.
    
    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
```
    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
  - getAttributeValueAsString
```
protected java.lang.String getAttributeValueAsString(NameValueUnit[] nvu,
                                         java.lang.String attrName)
```
    Get the values in the TS_Union as a String
    
    Parameters:
    nvu - The NameValueUnit[] with the attributes of an instance
    attrName - The name of the attribute to get the TS_Union from
    
    Returns:
    The attribute value as a String
  - getAttributeIndex
```
protected int getAttributeIndex(NameValueUnit[] nvu,
                    java.lang.String attrName)
```
    Get the index on an attribute in the NameValueUnit[] of an instance
    
    Parameters:
    nvu - The NameValueUnit[] holding the attributes of an instance
    attrName - The attribute name
    
    Returns:
    The index of the attribute within the array. -1 if not found.
  - insertNewValuesToExisting
```
public short[] insertNewValuesToExisting(DataType dt,
                                TS_Value vNew,
                                TS_ValueSeq vOld,
                                short[] newFlags,
                                int indexToInsert)
```
    Insert the new points in the correct position.
    
    Parameters:
    dt - DataType of the values
    vNew - The TS_Value structure with the new values
    vOld - The TS_ValueSeq struchture with the existing values
    newFlags - The flags for the new values
    indexToInsert - The index where the new values must be inserted
    
    Returns:
    The short [] containing the flags of all values (old + inserted new)
  - appendInvalidValues
```
protected void appendInvalidValues(ValueMatrix vm,
                       java.lang.String name,
                       int nrOfNewValues)
                            throws AoException,
                                   RuleException
```
    Append invalid values to a local column that was removed from an existing submatrix
    
    Parameters:
    vm - The valuematrix with the existing values
    name - The name of the local columns
    nrOfNewValues - The number of new values
    
    Throws:
    
    AoException
    
    RuleException
  - createInvalidValueSeq
```
protected TS_ValueSeq createInvalidValueSeq(DataType dt,
                                int nrOfNewValues)
                                     throws RuleException
```
    Create a TS_ValueSeq with invalid values of the specified data type
    
    Parameters:
    dt - The data type of the values
    nrOfNewValues - The number of values to create
    
    Returns:
    The TS_ValueSeq with the invalid values
    
    Throws:
    
    RuleException
  - getExistingColumns
```
protected java.util.Hashtable<java.lang.String,java.lang.Integer> getExistingColumns(ValueMatrix vm)
                                                                              throws AoException
```
    Throws:
    
    AoException
  - getIndependentColumns
```
protected java.util.HashSet<java.lang.String> getIndependentColumns(ValueMatrix vm)
                                                             throws AoException
```
    Throws:
    
    AoException
  - checkUnits
```
protected void checkUnits(ElementHolder[] meqHolders,
              ElementHolder unitHolder)
                   throws RuleException
```
    Throws:
    
    RuleException
  - checkQuantities
```
protected void checkQuantities(ElementHolder[] meqHolders,
                   ElementHolder qtyHolder)
                        throws RuleException
```
    Throws:
    
    RuleException
  - elementToOdsCache
```
protected void elementToOdsCache(java.lang.String baseElement,
                     NameValueUnit[][] nvu)
                          throws RuleException
```
    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()

Class MeasurementToRule

Field Summary

Fields inherited from class com.highqsoft.xsd.AbstractSequencerRule

Fields inherited from class com.highqsoft.xsd.AbstractRule

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

Constructor Summary

Method Summary

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

Methods inherited from class com.highqsoft.xsd.AbstractRule

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

Methods inherited from class java.lang.Object

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

Field Detail

odsCache

meaHolderRef

keyword

rememberInstancesId

insertMode

writeCatalogs

performCleanup

logExisting

versionIsLong

defaultUnit

defaultQuantity

abortOnMissingTargetAttr

ignoreMissingValuesToAppend

errorReasonProperty

allowColumnMismatch

odsCacheRef

Constructor Detail

MeasurementToRule

Method Detail

getValue

setValue

getAttributeValueAsString

getAttributeIndex

insertNewValuesToExisting

appendInvalidValues

createInvalidValueSeq

getExistingColumns

getIndependentColumns

checkUnits

checkQuantities

elementToOdsCache

init

terminate