com.highqsoft.moma.rules.utils

Class SimpleFilterRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.SimpleFilterRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

Direct Known Subclasses:

OrFilterRule

public class SimpleFilterRule
extends AbstractSequencerRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_SimpleFilterRule SimpleFilterRule \addindex SimpleFilterRule \addindex simple filter This rule filters the nvu dataset according to a specified filter condition. Nvu records, that fulfill the filter condition are accepted and passed to the output. The rule is called 'simple' since only one condition about one attribute can be specified. Type: SequencerRule \par Properties \li \b AttributeName (required, no default, DT_STRING)
The name of the attribute whose values are checked. \li \b AttributeValues (optional, no default, DT_STRING)
Can be one value or a list of values, according to the condition string. This property is only optional when no values are required for the condition. \li \b SplitChar (optional, default " ", DT_STRING)
The character is used to separate the list items. \li \b DataType (optional, no default, DT_STRING)
DataType string according to ASAM ODS datatype enums (DT_STRING, DT_BYTE, DT_LONG etc...) for single values, corresponding sequence types (DS_STRING, DS_BYTE, DS_LONG etc...) for value lists. This property is only optional when no values are required for the condition. \li \b Condition (required, no default, DT_STRING)
Condition that has to be checked by the rule. For single values in the AttributeValues property, this can be one of the following: "EQ" = equal, "NE" = not equal, "LT" = less than, "GT" = greater than, "LE" = less or equal, "GE" = greater or equal, "LIKE" = string representation of value match regular expression, "NOT_LIKE" = string representation of value doesn't match regular expression, For more values in the AttributeValues property, it can be: "IN" = in list, "NOT_IN" = not in list. \li \b Restrictions: the following datatypes can be handled with this rule: _DT_STRING, _DT_DATE _DT_LONG, _DT_SHORT, _DT_BYTE, _DT_FLOAT, _DT_DOUBLE and _DT_LONGLONG for single values, _DS_STRING, _DS_DATE _DS_LONG, _DS_SHORT, _DS_BYTE, _DS_FLOAT, _DS_DOUBLE and _DS_LONGLONG for a value sequence. For none values in the AttributeValues property, it can be: "IS_NULL" = is null the attribute does not exist or has no valid value, "IS_NOT_NULL" = is not null the attribute does exist and has a valid value. \par Test 1 Records are passed, whose attribute values of attribute HA (with datatype DT_STRING) are one of values in the valuelist. Please note, that the DataType-property is specified as DS_STRING, since we have a list of values. \li Input \code \endcode \li Configuration \code \endcode \li Expected Output \code \endcode \par Test 2 In the example above, records are passed, whose attribute value of attribute DATVON (with datatype DT_STRING) are greater than "199812". (For strings lexigraphical order is used.) \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
SimpleFilterRule()

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 boolean	compareB(TS_Union v1, TS_Union v2, java.lang.String cond)
protected boolean	compareB(TS_Value v1, TS_Value v2, java.lang.String cond)
protected boolean	compareS(TS_Union v1, TS_Union v2)
protected int	compareU(TS_Union v1, TS_Union v2)
void	init() Get the required arguments.
void	setValue(NameValueUnit[][] nvu) Filter the nvu array according given filter condition.
void	terminate() The terminate method reset the private variables.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

execute, getValue

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

SimpleFilterRule

public SimpleFilterRule()

Method Detail

compareU

protected int compareU(TS_Union v1,
           TS_Union v2)
                throws RuleException

Throws:

RuleException

compareS

protected boolean compareS(TS_Union v1,
               TS_Union v2)
                    throws RuleException

Throws:

RuleException

compareB

protected boolean compareB(TS_Value v1,
               TS_Value v2,
               java.lang.String cond)
                    throws RuleException

Throws:

RuleException

compareB

protected boolean compareB(TS_Union v1,
               TS_Union v2,
               java.lang.String cond)
                    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()

terminate

public void terminate()
               throws TerminationException

The terminate method reset the private variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractSequencerRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractSequencerRule.terminate()