com.highqsoft.moma.rules.ods

Class FilterExistingRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.ods.FilterExistingRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class FilterExistingRule
extends AbstractSequencerRule

\page OdsRules \section rules_com_highqsoft_moma_rules_ods_FilterExistingRule FilterExistingRule \addindex FilterExistingRule \addindex instance check This rule checks if an instance exists in the database and stores the Id of the found instance in the ods cache for further use. When the instance is not found the instance will be available in the output dataset. The instance will be searched within the parent instance. The rule compares all attributes except the Id and the attributes given with the property AttributeNames. The compare is done on datatype specific, so there may be some problems comparing float and double values. Type: SequencerRule \par Properties \li \b OdsCacheRef (required, no default, DT_STRING)
The reference to the target ODS Cache. \li \b ElementName (required, no default, DT_STRING)
The name of the application element. \li \b SplitChar (optional, default " ", DT_STRING)
The character used to split the lists below. If there are list entries with spaces another split character must be used. \li \b AttributeNames (required, no default, DT_STRING)
A list of attribute names that will ignored during the compare. The names must be separated with \e SplitChar. \par Example The example below is called from the \ sequence in a modelmapper control file. It checks if there is an instance of Project where the attribute value of ProjectId given in the dataset exist in the database. \code \endcode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	attributeNames
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
FilterExistingRule()

Method Summary

Methods

Modifier and Type	Method and Description
void	init() The initialization of the rule.
void	setValue(NameValueUnit[][] nvu) Set the value.
void	terminate() The terminate method, reset the local 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

Field Detail

elementName

protected java.lang.String elementName

attributeNames

protected java.lang.String[] attributeNames

odsCache

protected ODSCache odsCache

Constructor Detail

FilterExistingRule

public FilterExistingRule()

Method Detail

setValue

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

Set the value.

Parameters:

nvu - - the attribute values of the instances of the element of the rule.

Throws:

RuleException

See Also:

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

init

public void init()
          throws InitializationFailedException

The initialization of the rule. The element name, the reference of the ODSCache.

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 local variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractSequencerRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()