com.highqsoft.moma.rules.utils

Class OccurrenceFilterRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.OccurrenceFilterRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class OccurrenceFilterRule
extends AbstractSequencerRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_OccurrenceFilterRule OccurrenceFilterRule \addindex filter occurrences \addindex occurrence filter This rule filters the nvu dataset according to the specified 'occurrence filter condition'. Nvu records, that fulfill the filter condition are accepted and passed to the output. Filter condition can be "FIRST" or "LAST". In this rule subsequent valid (flag == 15) records with equal values of a specified attribute are checked. If condition "FIRST" is chosen, each first record of such subsequent records is output, if condition "LAST" is chosen, each last record of such subsequent records is output. Type: SequencerRule \par Properties \li \b AttributeName (required, no default, DT_STRING)
The name of the attribute whose values are checked. \li \b Condition (required, no default, DT_STRING)
Condition that has to be checked by the rule. Condition can be "FIRST" or "LAST" \li \b Restrictions: the datatype of the specified attribute can be: _DT_STRING, _DT_DATE _DT_LONG, _DT_SHORT, _DT_BYTE, _DT_FLOAT, _DT_DOUBLE and _DT_LONGLONG \par Test 1 \addindex OccurrenceFilterRule Example This is called from the \ sequence in a modelmapper control file. Records are passed, that are the first ones in a sequence of valid records with equal attribute values of the attribute with name 'Block'. \li Input \code \endcode \li Configuration \code \endcode \li Expected Output \code \endcode

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

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkValidCondition(java.lang.String condition) Check if the condition is a valid string
protected int	compareU(TS_Union u1, TS_Union u2)
protected int	compareV(TS_Value v1, TS_Value v2)
void	init() Get the required arguments.
void	setValue(NameValueUnit[][] nvu) Filter the nvu array according given filter condition.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

execute, getValue, 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

Constructor Detail

OccurrenceFilterRule

public OccurrenceFilterRule()

Method Detail

compareV

protected int compareV(TS_Value v1,
           TS_Value v2)
                throws RuleException

Throws:

RuleException

compareU

protected int compareU(TS_Union u1,
           TS_Union u2)
                throws RuleException

Throws:

RuleException

setValue

public void setValue(NameValueUnit[][] nvu)
              throws RuleException

Filter the nvu array according given filter condition.

Parameters:

nvu - The NameValueUnit[][] containing the instances

Throws:

RuleException

See Also:

RuleIF.setValue(org.asam.ods.NameValueUnit[][])

checkValidCondition

protected boolean checkValidCondition(java.lang.String condition)

Check if the condition is a valid string

Parameters:

condition - the condition string

Returns:

the condition is valid.

init

public void init()
          throws InitializationFailedException

Get the required arguments.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()