com.highqsoft.ascoba

Class HandledInstancesRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.ascoba.AscobaAbstractRule

com.highqsoft.ascoba.HandledInstancesRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class HandledInstancesRule
extends AscobaAbstractRule

This rule returns the Ids of the handled instances of an element. For more details see \ref rules_com_highqsoft_ascoba_HandledInstancesRule

Since:

$Date: 2017/04/06 13:28:21 $

Version:

$Revision: 1.4 $

Author:

Karst Schaap

Field Summary

Fields inherited from class com.highqsoft.ascoba.AscobaAbstractRule

elementName, handledMap, messenger, sourceSess, useDestroy

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

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() Get the Id's of the handled instances of the element from the map.
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.ascoba.AscobaAbstractRule

addCopied, addHandledId, checkHandledId, destroy, destroy, execute, getCopiedTarget, getIds, getIds, getIdValue, getTargetApplicationRelation, init, setValue, stactTraceToString, 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

HandledInstancesRule

public HandledInstancesRule()

Method Detail

setValue

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

Set the value.

Specified by:

setValue in interface RuleIF

Overrides:

setValue in class AscobaAbstractRule

Parameters:

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

Throws:

RuleException

See Also:

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

getValue

public NameValueUnit[][] getValue()

Get the Id's of the handled instances of the element from the map. The Id's are normally the Id's of the instances of the source. The value name of the attributes is the name of the Id attribute from the element in the source.

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AscobaAbstractRule

Returns:

The name value of the rule.

See Also:

RuleIF.getValue()

init

public void init()
          throws InitializationFailedException

The initialization of the rule. The element name, the reference of the OdsCache and the insert mode is loaded from the context.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

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 AbstractRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()