com.highqsoft.asamcommander.momax.rules

Class MoMaXAbstractRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.asamcommander.momax.rules.MoMaXAbstractRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

Direct Known Subclasses:

MoMaXEmptyRule, MoMaXInputRule

public abstract class MoMaXAbstractRule
extends AbstractRule

\page Rules \section rules_com_highqsoft_asamcommander_momax_rules_MoMaXAbstractRule MoMaXAbstractRule \addindex input instance \addindex instance input Package com.highqsoft.asamcommander.momax.rules This rule is a basis for other MoMaX Rules. It gets the source and target session from the context.It also takes the ElemId(s) String provided by the arguments and stores them in an ElemId Object Array so that they can be used by Rule Implementations. The following table lists all the argument of this implementation. Keywords are case insensitive.

Argument Keyword	Datatype	Default	Description
instanceId	String	none	The Id of the instance element in the ASAM ODS service.
sourcesession	String	source	The reference for the AoSession of the Source.
targetsession	String	target	The reference for the AoSession of the Target.

Futher arguments are inherit from the super class. An example of the usages of this rule is given below.

 <rule id="getElement" pointto="copyElement">
    <procedure name="com.highqsoft.ascoba.AscobaInputRule">
       <arguments>
          <property name="ElementName" value="${SelectElement}"/>
          <property name="InstanceId" value="${InstanceMeaId}"/>
          <property name="sourcesession" value="source"/>
       </arguments>
    </procedure>
 </rule>
 

Version:

$Revision: 1.8 $

Author:

Alexander Ziller, HighQSoft GmbH

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	messenger The messenger logger of the context
protected AoSession	sourceSess The source session
protected AoSession	targetSess The target session

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

Method Summary

Methods

Modifier and Type	Method and Description
abstract NameValueUnit[][]	getValue() Get the named value from rule.
void	init() Sets the source and target session and the messenger.
abstract void	setValue(NameValueUnit[][] nvu) Set the named values to rule.

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

messenger

protected java.util.logging.Logger messenger

The messenger logger of the context

sourceSess

protected AoSession sourceSess

The source session

targetSess

protected AoSession targetSess

The target session

Constructor Detail

MoMaXAbstractRule

public MoMaXAbstractRule()

Method Detail

init

public void init()
          throws InitializationFailedException

Sets the source and target session and the messenger.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - @see ImplementationIF.init()

getValue

public abstract NameValueUnit[][] getValue()
                                    throws RuleException

Get the named value from rule.

Returns:

The name value of the rule.

Throws:

RuleException

See Also:

RuleIF.setValue(NameValueUnit[][] nvu)

setValue

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

Set the named values to rule. The rule decides how to organize the array structur. To have a homogenous environment try to hold in mind that the first index should assign something like instances and the second the attributes belong to the instances.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException