com.highqsoft.moma.rules.ods

Class CheckInstanceIdRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.ods.CheckInstanceIdRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class CheckInstanceIdRule
extends AbstractRule

\page OdsRules \section rules_com_highqsoft_moma_rules_ods_CheckInstanceIdRule CheckInstanceIdRule \addindex CheckInstanceIdRule \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 an exception is thrown to cancel the process. The instance will be searched within the parent instance. Type: ToRule \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 AttributeName (required when AttributeNames is not used, no default, DT_STRING)
The name of the application attribute which will be used as key. The datatype must be DT_STRING. \li \b AttributeNames (required when AttributeName is not used, no default, DT_STRING)
A list of attribute names that will be used as keys. The datatype of all given attributes must be DT_STRING. The names must be separated with \e SplitChar. \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 CompareCasesensitive (optional, default true, DT_BOOLEAN)
Switch to compare case sensitive. \li \b Replace (optional, default false, DT_BOOLEAN)
When this property is set the value in the dataset will be replaced with the values found in the database for the attributes given at AttributeName or AttributeNames. This is important when the compare is case insensitive and afterwards the database must be updated with the information from the input. \li \b acceptNew (optional, default false, DT_BOOLEAN)
When this property is set and the value in the dataset is not available in the datastorage no exception is thrown. \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 boolean	acceptNew
protected java.lang.String[]	attributeNames
protected boolean	compareCasesensitive
protected java.lang.String	elementName
protected ODSCache	odsCache
protected boolean	replace

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method, nothing to do.
NameValueUnit[][]	getValue() ElementToRule, nothing to do at getValue()
void	init() The initialization of the rule.
protected ElemId	loadParentInstance(ODSCache odsCache, java.lang.String parentElementName, java.lang.String name)
void	setValue(NameValueUnit[][] nvu) Set the value.
void	terminate() The terminate method, reset the local 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

Field Detail

elementName

protected java.lang.String elementName

attributeNames

protected java.lang.String[] attributeNames

odsCache

protected ODSCache odsCache

compareCasesensitive

protected boolean compareCasesensitive

replace

protected boolean replace

acceptNew

protected boolean acceptNew

Constructor Detail

CheckInstanceIdRule

public CheckInstanceIdRule()

Method Detail

getValue

public NameValueUnit[][] getValue()

ElementToRule, nothing to do at getValue()

Returns:

The name value of the rule.

See Also:

RuleIF.getValue()

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[][])

loadParentInstance

protected ElemId loadParentInstance(ODSCache odsCache,
                        java.lang.String parentElementName,
                        java.lang.String name)
                             throws RuleException

Throws:

RuleException

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

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

execute

public void execute()
             throws ExecutableException

The execute method, nothing to do.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractRule

Throws:

ExecutableException - if execution fails.

See Also:

AbstractRule.execute()

terminate

public void terminate()
               throws TerminationException

The terminate method, reset the local variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()