com.highqsoft.moma.rules.utils

Class DecorateAttributeRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.DecorateAttributeRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class DecorateAttributeRule
extends AbstractSequencerRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_DecorateAttributeRule DecorateAttributeRule \addindex DecorateAttributeRule \addindex decorate attribute \addindex attribute decoration This rule loads or stores the string representation of an attribute in a NameValueUnit[][] as a reference in the context. If there is more than one instance only the first one is processed. If the attribute does not exist or has no value the specified default value is used. If no default value is given and no attribute value is found the property is not set at all. When the rule is used as a TO-rule (setValue) the rule stores the attribute value in the context. When the rule is used as FROM-rule (getValue) the rule loads the reference from the context and returns a dataset with one row and one column, the name is the attribute name and the value is the value of the reference. The reference must be a String. Type: SequencerRule \par Properties \li \b AttributeName (required, no default, DT_STRING)
The name of the Attribute, which value should be decorated. \par Example \code \endcode

Field Summary

Fields inherited from class com.highqsoft.xsd.AbstractSequencerRule

cleanAfterGet, localNVU

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

Method Summary

Methods

Modifier and Type	Method and Description
void	init() Initialize the work.
void	setValue(NameValueUnit[][] nvu) Search for the attribute and store the first occurrence in the context with the property name.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

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

DecorateAttributeRule

public DecorateAttributeRule()

Method Detail

init

public void init()
          throws InitializationFailedException

Description copied from class: AbstractImplementation

Initialize the work.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

setValue

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

Search for the attribute and store the first occurrence in the context with the property name.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException