com.highqsoft.asamcommander.momax.rules

Class MoMaXInputRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.asamcommander.momax.rules.MoMaXAbstractRule

com.highqsoft.asamcommander.momax.rules.MoMaXInputRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class MoMaXInputRule
extends MoMaXAbstractRule

This rule will delete the selected instances together with the child instances. For more details see \ref rules_com_highqsoft_ascoba_AscobaInputRule It requires the following arguments:

Argument Keyword	Datatype	Default	Description
ELEMENTIDS	String	none	The ElemId String passed on by the Plugin to the moma.

Since:

$Date: 2017/04/06 13:29:32 $

Version:

$Revision: 1.9 $

Author:

Alexander Ziller

Field Summary

Fields inherited from class com.highqsoft.asamcommander.momax.rules.MoMaXAbstractRule

messenger, sourceSess, targetSess

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

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() This method returns an double array of NVU.
void	init() The initialization of the rule.
void	setValue(NameValueUnit[][] nvu) Does nothing.
void	terminate() The terminat method, reset the local variables.

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, 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

MoMaXInputRule

public MoMaXInputRule()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

This method returns an double array of NVU. This arrays is designed to return ElemIds. The syntax is the following:

[0]AID [1]AID [2]AID
[1]IID [1]IID [2]IID

Specified by:

getValue in interface RuleIF

Specified by:

getValue in class MoMaXAbstractRule

Returns:

the ElemIds as a double NVU array

Throws:

RuleException - @see RuleIF.getValue()

See Also:

RuleIF.setValue(NameValueUnit[][] nvu)

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

Overrides:

init in class MoMaXAbstractRule

Throws:

InitializationFailedException - @see ImplementationIF.init()

See Also:

AbstractImplementation.init()

terminate

public void terminate()
               throws TerminationException

The terminat method, reset the local variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - @see ExecutableIF.terminate()

See Also:

AbstractRule.terminate()

setValue

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

Does nothing. This is a FROM Rule.

Specified by:

setValue in interface RuleIF

Specified by:

setValue in class MoMaXAbstractRule

Parameters:

nvu - a NVU array

Throws:

RuleException - @see RuleIF.setValue(NameValueUnit[][])