com.highqsoft.moma.rules.utils

Class MergeDataSetRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.MergeDataSetRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class MergeDataSetRule
extends AbstractSequencerRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_MergeDataSetRule MergeDataSetRule \addindex nvu to context \addindex store nvu to context This rule merge the dataset stored in the context with a dataset given at \e setValue(). The merged dataset is created and returned at \e getValue(). The merging the dataset means the values of the key attributes of both datasets are compared, when in both dataset are the same values the result dataset get the all attributes from both dataset. It is configuration which dataset is the master so in case in both dataset are the same attributes given the attribute of the master dataset is used. Lines which are available in only one dataset will be part of the merged dataset. In case there is no dataset in the context or no input dataset there is nothing and the other dataset will be returned. The order of the lines in the resulting dataset is arbitrary, the order of the attributes in the lines are identical, missing attributes get an invalid value. Type: SequencerRule \par Properties \li \b ReferenceName (required, no default, DT_STRING)
The name of the reference where the NameValueUnit[][] is stored. \li \b KeyAttributes (required , default: false, String)
The list with attributes which will be used to find the instances in the different data sets. \li \b SplitChar (optional, default " ", DT_STRING)
The character used to split the lists with \e KeyAttributes. If there are list entries with spaces another split character must be used. \li \b ContextIsMaster (optional, Default: FALSE)\n When this flag is set the dataset in the context is the master dataset otherwise the input dataset is the master. \li \b KeyCompose (optional, default "~", DT_STRING)
The string which will be used to compose the values of the key attributes to one string. \par Example The example below is called from the \ sequence in a modelmapper control file. It stores the NameValueUnit[][] returned by the fromrule in the context reference MeaToWriteRef. \code \endcode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	contextIsMaster
protected java.lang.String[]	keyAttributes
protected java.lang.String	keyCompose
protected java.lang.String	refName

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

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	getKeyOfLine(NameValueUnit[] line, java.util.HashMap<java.lang.String,NameValueUnit> lineToMerge)
NameValueUnit[][]	getValue() The getValue method, return the values of the AbstractSequencerRule.localNVU field.
void	init() Initialize the work.
void	setValue(NameValueUnit[][] nvu) Set the named values to rule.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

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

Field Detail

refName

protected java.lang.String refName

keyAttributes

protected java.lang.String[] keyAttributes

keyCompose

protected java.lang.String keyCompose

contextIsMaster

protected java.lang.Boolean contextIsMaster

Constructor Detail

MergeDataSetRule

public MergeDataSetRule()

Method Detail

setValue

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

Description copied from interface: RuleIF

Set the named values to rule. The rule decides how to organize the array structur. To have a homogenous environment try to hold in mind that the first index should assign something like instances and the second the attributes belong to the instances.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

getKeyOfLine

protected java.lang.String getKeyOfLine(NameValueUnit[] line,
                            java.util.HashMap<java.lang.String,NameValueUnit> lineToMerge)

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Description copied from class: AbstractSequencerRule

The getValue method, return the values of the AbstractSequencerRule.localNVU field. If rule property 'CLEANAFTERGET' was set to true, the nvu field of the rule is wiped to clear memory.

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.