com.highqsoft.moma.rules.utils

Class PropertyAttributeRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.utils.PropertyAttributeRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class PropertyAttributeRule
extends AbstractRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_PropertyAttributeRule PropertyAttributeRule \addindex PropertyAttributeRule \addindex property attribute This rule loads or stores the string representation of an attribute in a NameValueUnit[][] as a property 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 in the context. When the rule is used as FROM-rule (getValue) the rule loads the property 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 property. The property must be a String. \see rules_com_highqsoft_moma_rules_utils_AttributeToPropertyRule Type: FromRule-ToRule \par Properties \li \b AttributeName (required, no default, DT_STRING)
The name of the Attribute to read the value from. \li \b PropertyName (required, no default, DT_STRING)
The name of the property where the value is stored. \li \b DefaultValue (optional, no default, DT_STRING)
The default value to use if the attribute does not exist. \par Example The example below is called in a sequence of rules in the \ sequence of a modelmapper control file. It stores the attribute "iProject" of the first instance found in the property "iProject". If the attribute is not found or has no value the default "Common" is written to the property \code \endcode

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

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() Read the property and make a data set of it with the attribute name
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.
void	terminate() Terminate the execution.

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

PropertyAttributeRule

public PropertyAttributeRule()

Method Detail

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

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Read the property and make a data set of it with the attribute name

Returns:

The name value of the rule.

Throws:

RuleException

See Also:

RuleIF.setValue(NameValueUnit[][] nvu)

init

public void init()
          throws InitializationFailedException

Description copied from class: AbstractImplementation

Initialize the work.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

terminate

public void terminate()
               throws TerminationException

Description copied from class: AbstractRule

Terminate the execution. This implementation does nothing by default. Can be overridden.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.