com.highqsoft.moma.rules.ods

Class ReadNumberOfRows

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.ods.ReadNumberOfRows

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class ReadNumberOfRows
extends AbstractSequencerRule

\page OdsRules \section rules_com_highqsoft_moma_rules_ods_ReadNumberOfRows ReadNumberOfRows \addindex ReadNumberOfRows ReadNumberOfRows is used read the number of rows of the submatrix from the data storage and set this value in the data set. This rule is a sequence rule. \subsection ReadNumberOfRowsProperties Properties \addindex ReadNumberOfRows Properties The ReadNumberOfRows is initialized with the following properties: \li \b ElementName (optional)
The name of the application Element. \li \b OdsCacheRef (required, no default)
The name of the ODSCache reference in the context. \li \b CacheAttribute (required, no id)
The name of the base attribute which will be used for the cache to find the attribute. \subsection ReadNumberOfRowsExample Example \addindex ReadNumberOfRows Example The example below is called from the sequence in a modelmapper control file. \code \endcode \subsection ReadNumberOfRowsMomaMethods Methods used within the Modelmapper \addindex ReadNumberOfRows Modelmapper Methods \li NameValueUnit[][] getValue()
The getValue() return the updated dataset \li setValue(NameValueUnit[][])
The setValue() method search for the target instance Id in the cache when the instance is not found ODS API calls to get the requested Ids and update the dataset.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	cacheAttribute
protected java.lang.String	elementName
protected ODSCache	odsCache

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

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() getValue is not implemented because it is a to-rule.
void	init() The init method.
void	setValue(NameValueUnit[][] nvu) Set the named values to rule.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

execute, terminate

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

elementName

protected java.lang.String elementName

odsCache

protected ODSCache odsCache

cacheAttribute

protected java.lang.String cacheAttribute

Constructor Detail

ReadNumberOfRows

public ReadNumberOfRows()

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.

See Also:

AbstractImplementation.init()

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

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

getValue is not implemented because it is a to-rule.

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractSequencerRule

Returns:

the values.

Throws:

RuleException

See Also:

RuleIF.getValue()