com.highqsoft.ascoba

Class AscobaAbstractRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.ascoba.AscobaAbstractRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

Direct Known Subclasses:

AscobaInputRule, CopyInstancesAbstractRule, DeleteInstancesRule, GetInstancesRule, HandledInstancesRule, RelatedInstancesRule

public abstract class AscobaAbstractRule
extends AbstractRule

This rule is an abstract rule for ASCOBA. For more detail see \ref rules_com_highqsoft_ascoba_AscobaAbstractRule

Since:

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

Version:

$Revision: 1.6 $

Author:

Karst Schaap

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	elementName The name of the application element.
protected HandledInstancesMap	handledMap Map with the handled instances.
protected java.util.logging.Logger	messenger The messenger
protected AoSession	sourceSess The ASAM ODS session of the source.
protected boolean	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
AscobaAbstractRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCopied(java.lang.String aeName, T_LONGLONG ieId, InstanceElement ieTarget) Add the target instances from the source instance.
protected void	addHandledId(java.lang.String aeName, T_LONGLONG ieId) Add the Id of the instances to the list with handled Id's.
protected boolean	checkHandledId(java.lang.String aeName, T_LONGLONG ieId) Check the Id of the instances is already in the the list with handled Id's.
protected void	destroy(InstanceElement ie) Destroy the instance.
protected void	destroy(InstanceElementIterator ieIter) Destroy the instance iterator.
void	execute() The execute method, nothing to do.
protected InstanceElement	getCopiedTarget(java.lang.String aeName, T_LONGLONG ieId) Get the target instances element when the instances is already copied from source instance.
protected T_LONGLONG[]	getIds() Get the List with the Id's of the handled instances of an element.
protected T_LONGLONG[]	getIds(java.lang.String aeName) Get the id of the handled instances from a given element.
protected T_LONGLONG	getIdValue(TS_Value val) Returns the Id value in the type T_LONGLONG independent of the datatype of the input value.
protected ApplicationRelation	getTargetApplicationRelation(ApplicationRelation ar, ApplicationRelation[] arTarList, java.lang.String aeName) Get the relation from the target corresponding the relation from the source
NameValueUnit[][]	getValue() AscobaAbstractRule, nothing to do at getValue()
void	init(java.lang.String logger_name) The initialization of the rule.
void	setValue(NameValueUnit[][] nvu) AscobaAbstractRule, , nothing to do at setValue()
void	setValue(java.lang.String logger_name, NameValueUnit[][] nvu) Set the value.
protected java.lang.String	stactTraceToString(java.lang.Exception e) Generate the string of exception stack trace.
void	terminate(java.lang.String logger_name) 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, terminate, 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, init, 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, init, setArguments, setContext, setDescriptor

Field Detail

sourceSess

protected AoSession sourceSess

The ASAM ODS session of the source.

elementName

protected java.lang.String elementName

The name of the application element.

useDestroy

protected boolean useDestroy

messenger

protected java.util.logging.Logger messenger

The messenger

handledMap

protected HandledInstancesMap handledMap

Map with the handled instances.

Constructor Detail

AscobaAbstractRule

public AscobaAbstractRule()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

AscobaAbstractRule, nothing to do at getValue()

Returns:

The name value of the rule.

Throws:

RuleException

See Also:

RuleIF.getValue()

setValue

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

AscobaAbstractRule, , nothing to do at setValue()

Parameters:

nvu - - the attribute values.

Throws:

RuleException

See Also:

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

getIdValue

protected T_LONGLONG getIdValue(TS_Value val)

Returns the Id value in the type T_LONGLONG independent of the datatype of the input value.

Parameters:

val - the input value.

Returns:

the Id

init

public void init(java.lang.String logger_name)
          throws InitializationFailedException

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

Throws:

InitializationFailedException

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(java.lang.String logger_name)
               throws TerminationException

The terminate method, reset the local variables.

Throws:

TerminationException

See Also:

AbstractRule.terminate()

getTargetApplicationRelation

protected ApplicationRelation getTargetApplicationRelation(ApplicationRelation ar,
                                               ApplicationRelation[] arTarList,
                                               java.lang.String aeName)
                                                    throws AoException

Get the relation from the target corresponding the relation from the source

Parameters:

ar - the relation from the source.

arTarList - the list with relations from the target

aeName - the name of the application element

Returns:

the relation from the target.

Throws:

AoException - any ASAM ODS exception

setValue

public void setValue(java.lang.String logger_name,
            NameValueUnit[][] nvu)
              throws RuleException

Set the value.

Parameters:

logger_name - the name of the logger

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

Throws:

RuleException

See Also:

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

addHandledId

protected void addHandledId(java.lang.String aeName,
                T_LONGLONG ieId)

Add the Id of the instances to the list with handled Id's.

Parameters:

aeName - the name of the application element.

ieId - the Id of the instance.

addCopied

protected void addCopied(java.lang.String aeName,
             T_LONGLONG ieId,
             InstanceElement ieTarget)

Add the target instances from the source instance.

Parameters:

aeName - the name of the application element.

ieId - the Id of the instance.

ieTarget - the target instance

getCopiedTarget

protected InstanceElement getCopiedTarget(java.lang.String aeName,
                              T_LONGLONG ieId)

Get the target instances element when the instances is already copied from source instance.

Parameters:

aeName - name of the element.

ieId - Id of the source instance

Returns:

the target instance element.

checkHandledId

protected boolean checkHandledId(java.lang.String aeName,
                     T_LONGLONG ieId)

Check the Id of the instances is already in the the list with handled Id's.

Parameters:

aeName - the name of the application element.

ieId - the Id of the instance.

Returns:

true when the instance is already in the list.

getIds

protected T_LONGLONG[] getIds()

Get the List with the Id's of the handled instances of an element.

Returns:

the list with the Id's.

getIds

protected T_LONGLONG[] getIds(java.lang.String aeName)

Get the id of the handled instances from a given element.

Parameters:

aeName - the name of the element.

Returns:

the list with the Id's.

stactTraceToString

protected java.lang.String stactTraceToString(java.lang.Exception e)

Generate the string of exception stack trace.

Parameters:

e - the exception.

Returns:

the stack trace.

destroy

protected void destroy(InstanceElement ie)
                throws AoException

Destroy the instance.

Parameters:

ie - the instance

Throws:

AoException - any occurring ASAM ODS exception.

destroy

protected void destroy(InstanceElementIterator ieIter)
                throws AoException

Destroy the instance iterator.

Parameters:

ie - the instance iterator.

Throws:

AoException - any occurring ASAM ODS exception.