com.highqsoft.moma.rules.utils

Class PropertiesToNVURule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.utils.PropertiesToNVURule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class PropertiesToNVURule
extends AbstractRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_PropertiesToNVURule \addindexPropertiesToNVURule \addindex properties to attribute This rule loads the properties from the context which match the given reqular expression and put these in the dataset. It is configurable to store all found properties as attributes in one line or for each found property an own line with two attributes called \e Name and \e Value. \see rules_com_highqsoft_moma_rules_utils_AttributeToPropertyRule Type: Rule is FROM-Rule \par Properties \li \b PropertyNamepattern (required, no default, DT_STRING)
The regular expression of the property name. \li \b CreateOneLine (optional, default true, DT_BOOLEAN)
The name of the property where the value is stored. \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

Modifier and Type	Field and Description
protected boolean	createOneLine
protected java.util.logging.Logger	messenger
protected java.lang.String	propertyNamePattern

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

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) Set the values
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

Field Detail

propertyNamePattern

protected java.lang.String propertyNamePattern

createOneLine

protected boolean createOneLine

messenger

protected java.util.logging.Logger messenger

Constructor Detail

PropertiesToNVURule

public PropertiesToNVURule()

Method Detail

setValue

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

Set the values

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.