com.highqsoft.moma.rules.xatf

Class ComponentFromRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.xatf.ComponentFromRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class ComponentFromRule
extends AbstractRule

\page AtfxRules \section implementation_com_highqsoft_moma_rules_xatf_ComponentFromRule ComponentFromRule \addindex ComponentFromRule This rule reads from the ATF/XML file the information of the components. The element must be of the base type AoLocalColumn, because the components are only used for the values and flags of the localcolumn.
The following table lists all the argument of this implementation. Keywords are case insensitive.

Argument Keyword	Datatype	Default	Description
ReferenceName	String	none	The name of reference in the context with the class XATFReader.
ElementName	String	none	The name of the application element. The element must be of the base type AoLocalColumn

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method, notting to do.
NameValueUnit[][]	getValue() The getValue method, read the values of the localcolumn from the PACReturnWriter.
void	init() The init method, get the element name and the reference from the PACReturnWriter from the context.
void	setValue(NameValueUnit[][] nvu) The setValue, notthing to do.
void	terminate() The terminate method reset the private 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

Constructor Detail

ComponentFromRule

public ComponentFromRule()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

The getValue method, read the values of the localcolumn from the PACReturnWriter.

Returns:

the values of all local column instances. The first attribute is the Id of the localcolumn, the following attributes are the values, when no component are given, the generation_parameters, and the flags.

Throws:

RuleException

See Also:

RuleIF.getValue()

setValue

public void setValue(NameValueUnit[][] nvu)

The setValue, notthing to do.

Parameters:

nvu - The name value of the rule.

See Also:

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

init

public void init()
          throws InitializationFailedException

The init method, get the element name and the reference from the PACReturnWriter 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()

execute

public void execute()
             throws ExecutableException

The execute method, notting 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 private variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()