com.highqsoft.moma.rules.ods

Class GetLocalColumnsFromFromVmRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.ods.GetLocalColumnsFromFromVmRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class GetLocalColumnsFromFromVmRule
extends AbstractSequencerRule

\page OdsRules \section rules_com_highqsoft_moma_rules_ods_GetLocalColumnsFromFromVmRule GetLocalColumnsFromFromVmRule \addindex LocalColumn \addindex ValueMatrix This rule is used to read one or lc's of a mea instance from an ODS source. For each existing submatrix in the mea instance, a group in the returned nvu is created. Type: SequencerRule \par Properties \li \b OdsCacheRef (required, no default, DT_STRING)
The name of reference in the context with the ODSCache. \li \b ApplicationElement (required, no default, DT_STRING)
The name of the application Element. The application element must base on base type AoMeasurement \li \b InstanceElementId (required, no default, DT_STRING)
The id of the Instance Element. \li \b ResultRef (optional, no default, DT_STRING)
If this property exists an List with all retrieved attributes stored in the context with this name. \li \b IgnoreMissingApplElem (optional, default false, DT_BOOLEAN)
If this property exists and is set true the rule does not throw an exception if the ApplicationElement does not exist in the data model. Instead it behaves as if there were no instances. \li \b IgnoreMissingInstances (optional, default false, DT_BOOLEAN)
If this property exists and is set true the rule does not throw an exception if there is no instance found at all. \li \b LocalColumnNames (optional, no default, DT_STRING)
If this property exists, only the local columns with the matching names will be returned in the nvu[][], otherwise all local columns will be returned \li \b LocalColumnNamesSplitString (optional, default " ", DT_STRING)
If this property exists, it contains the seperator char to split the string with local column names. \par Example \code \endcode An automatic test is difficult, because it depends on the existing measurement instance of the databases.

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method, nothing to do.
TS_Value	getTsValueFromTsValueSeq(TS_ValueSeq valueSeq) Creates a TS_Vavlue from the passed TS_ValueSeq
NameValueUnit[][]	getValue() Get the instances from the ODS source.
void	init() The init method.
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.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

GetLocalColumnsFromFromVmRule

public GetLocalColumnsFromFromVmRule()

Method Detail

init

public void init()
          throws InitializationFailedException

The init method.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Get the instances from the ODS source.

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

execute

public void execute()
             throws ExecutableException

Description copied from class: AbstractSequencerRule

The execute method, nothing to do.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractSequencerRule

Throws:

ExecutableException - if execution fails.

See Also:

AbstractRule.execute()

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

getTsValueFromTsValueSeq

public TS_Value getTsValueFromTsValueSeq(TS_ValueSeq valueSeq)

Creates a TS_Vavlue from the passed TS_ValueSeq