com.highqsoft.moma.rules.utils

Class SetPropertyRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.SetPropertyRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class SetPropertyRule
extends AbstractSequencerRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_SetPropertyRule SetPropertyRule \addindex SetPropertyRule \addindex property attribute This rule sets a property. It is designed as a sequencer rule and if used in a ruleseq it leaves the NameValueUnit[][] untouched. \see rules_com_highqsoft_moma_rules_utils_SetPropertyRule Type: FromRule-ToRule \par Properties \li \b PropertyName (required, no default, DT_STRING)
The name of the property where the value is stored. \li \b Value (required, no default, DT_STRING)
The value to store in the property. \par Example The example below is called in a sequence of rules in the \ sequence of a modelmapper control file. It stores the value "Common" in the property "iProject". \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
SetPropertyRule()

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() The terminate method reset the class variables.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

execute

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

SetPropertyRule

public SetPropertyRule()

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

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractSequencerRule

Returns:

the values.

Throws:

RuleException

See Also:

RuleIF.getValue()

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.

terminate

public void terminate()
               throws TerminationException

Description copied from class: AbstractSequencerRule

The terminate method reset the class variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractSequencerRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()