com.highqsoft.moma.rules.mearules

Class RenameColumns

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.mearules.AbstractMeasurementRule

com.highqsoft.moma.rules.mearules.RenameColumns

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class RenameColumns
extends AbstractMeasurementRule

\page MeasurementRules \section rules_com_highqsoft_moma_rules_mearules_RenameColumns RenameColumns \addindex RenameColumns This rule renames "channels" (local columns and measurement quantities) from all submatrices within all measurement of a MeasurementHolder object. The old names and the new names can be defined either static in an xml file or can be created by another rule and stored in the context to be used in this rule. \subsection RenameColumnsProperties Properties \addindex RenameColumns Properties The RenameColumns rule is initzialized with the following properties: \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)
The directory where the dumpfiles are created. If this Property is set and is not an empty string the rule creates a dump of all modified ElementHolders. The dump files are named "\_\_*.dmp. \li \b MappingFile (required if a mapping definition file is used)
The name of the XML file containing the mapping rules for the channel names. This file can be the same as the configuration file for the FilterColumns rule. \li \b MappingName (required if a mapping definition file is used)
The name of the mapping rule block within the mapping file. \li \b MappingType (optional, default SIMPLE)
The mapping type defines which method is used to rename the columns. Possible values are - SIMPLE
Mapping is done with string replacement. Channel names that do not match any name in the mapping table are left untouched. - MAPPED_ONLY
Like SIMPLE, but channel names that do not match any name in the mapping table are removed from the measurements. - REGEXP_FIRST The old and new name in the mapping table is treated as a regular expression. The mapping is done only on the first occurence within each channel name. See the java regular expression syntax for details on using expressions for string substitution. - REGEXP_ALL Like REGEXP_FIRST, but the mapping is done for all occurences within the channel name. \li \b CaseConversion (optional, default "Keep")
Used to change the case of the source names. This may be useful if the data aource is not case sensitive. Case Conversion is unly used for MappingType SIMPLE and MAPPED_ONLY! Possible values are - \b Keep: Do not change the case - \b ToUpper: Convert the source names to uppercase before mapping - \b ToLower: Convert the source names to lowercase before mapping \li \b MappingTableReference (required if the mapping table comes from the context)
The name of a reference in the context where the Mapping table is stored. The object stored there must be of type Hashtable. \subsection RenameColumnsExample Example \addindex RenameColumns Example The example below is called from the fromrules sequence in a modelmapper control file. It is used to truncate the suffix "_Avg" from all channel names of all measurements in the MeasurementHolder object. \code \endcode The exmample mapping file below shows the configuration for the example above. The attribute new="$1" contains the content of the first pair of braces in old="(.*)_Avg". This means everything before the string "_Avg". \code \endcode \subsection RenameColumnsMomaMethods Methods used within the Modelmapper \addindex RenameColumns Modelmapper Methods \li void execute()
Depending on the combination of properties the execute() method reades either the mapping file and creates the mapping table or fetches the mapping table directly from the context. Afterwards the mapping is performed for all local column and measurement quantity names. \li NameValueUnit[][] getValue()
Calls execute().

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Load the mapping table and perform the mapping
NameValueUnit[][]	getValue() Get the result of the previous rule in a sequence
void	init() Get the required arguments.
void	terminate() The terminate method does nothing here

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

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

Constructor Detail

RenameColumns

public RenameColumns()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Get the result of the previous rule in a sequence

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractMeasurementRule

Returns:

The result of the previous rule in a sequence

Throws:

RuleException

See Also:

RuleIF.getValue()

execute

public void execute()
             throws ExecutableException

Load the mapping table and perform the mapping

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractMeasurementRule

Throws:

ExecutableException - if execution fails.

init

public void init()
          throws InitializationFailedException

Get the required arguments.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractMeasurementRule

Throws:

InitializationFailedException - if the initialization fails.

terminate

public void terminate()
               throws TerminationException

The terminate method does nothing here

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractSequencerRule.terminate()