com.highqsoft.moma.rules.mearules

Class InsertPointsInExistingMeasurement

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.mearules.AbstractMeasurementRule

com.highqsoft.moma.rules.mearules.InsertPointsInExistingMeasurement

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class InsertPointsInExistingMeasurement
extends AbstractMeasurementRule

\page MeasurementRules \section rules_com_highqsoft_moma_rules_mearules_InsertPointsInExistingMeasurements InsertPointsInExistingMeasurements \addindex InsertPointsInExistingMeasurements This rule is used to insert the values of local columns in a MeasurementHolder in a measurement that already exists in an ODS storage. It can simply append them at the end of the existing values or it can insert them somewhere in the existing values. In this case there must be a \e SortColumn which is used to find the place where the new values must be inserted. If inserted \e SortColumn values already exist in the existing measurement an error is thrown. The functionality of this rule was part of the \e MeasurementToRule, but it turned out that inserting the new values before they are written to the server is too late and inefficient in some situations. If \e InsertPointsInExistingMeasurements is used, the \e MeasurementToRule must be configured to use insert mode \e replace. The rule reads the ValueMatrix from the existing measurement and merges the values with the MeasurementHolder to insert. The local columns for the submatrices must match, otherwise an error is thrown. \subsection InsertPointsInExistingMeasurementsProperties Properties \addindex InsertPointsInExistingMeasurements Properties The InsertPointsInExistingMeasurements is initzialized with the following properties: \li \b MeasurementHolderRef (required)
Reference to the MeasurementHolder containing the new values. \li \b OdsCacheRef (required)
Reference to the ODSCache instance of the target service. \li \b ExistingMeaId (required, no default)
The id of the existing measurement in the ODS storage (target). If there is not yet an existing measurement, \e ExistingMeaId must be an empty String or 0. \li \b InsertMode (optional, default="insert")
This property defines how the new values are inserted in the existing submatrices. - \b append: In mode append the values are appended after the existing values. - \b insert: In mode insert the values and flags are inserted somewhere in the existing submatrices. The property "SortColumns" must contain one or more local columns used to sort the rows. \li \b ErrorReasonProperty (optional, no default)\n If this property exists and an exception is thrown in the InsertPointsInExistingMeasurements 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 AllowChannelMismatch (optional, default "No") \n If this property is set to "Yes" the rule allowes added or removed channels in the measurement to append and sets invalid values for the missing point values.. \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 InsertPointsInExistingMeasurementsExample Example \addindex InsertPointsInExistingMeasurements 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 InsertPointsInExistingMeasurementsMomaMethods Methods used within the Modelmapper \addindex InsertPointsInExistingMeasurements Modelmapper Methods \li void execute()
The execute reads the values from the existing measurement and inserts the new points.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	errorReasonProperty
protected boolean	ignoreMissingValuesToAppend
protected java.lang.String	insertMode
protected ODSCache	odsCache
protected java.lang.String	odsCacheRef

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

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 TS_ValueSeq	createInvalidValueSeq(DataType dt, int nrOfNewValues) Create a TS_ValueSeq with invalid values of the specified data type
void	execute() Execute the program.
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) Get a Hashtable with name and Index of all columns in a valuematrix.
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	terminate() Terminate the execution.

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

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

Field Detail

odsCache

protected ODSCache odsCache

insertMode

protected java.lang.String insertMode

ignoreMissingValuesToAppend

protected boolean ignoreMissingValuesToAppend

errorReasonProperty

protected java.lang.String errorReasonProperty

odsCacheRef

protected java.lang.String odsCacheRef

Constructor Detail

InsertPointsInExistingMeasurement

public InsertPointsInExistingMeasurement()

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 AbstractMeasurementRule

Throws:

ExecutableException - if execution fails.

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

Get a Hashtable with name and Index of all columns in a valuematrix.

Parameters:

vm - The valueMatrix.

Returns:

The hashtable with the index.

Throws:

AoException

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 AbstractMeasurementRule

Throws:

InitializationFailedException - if the initialization fails.

terminate

public void terminate()
               throws TerminationException

Description copied from class: AbstractRule

Terminate the execution. This implementation does nothing by default. Can be overridden.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.