com.highqsoft.moma.rules.utils

Class MoMaLoopRuleWithSwitch

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.utils.MoMaLoopRule

com.highqsoft.moma.rules.utils.MoMaLoopRuleWithSwitch

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class MoMaLoopRuleWithSwitch
extends MoMaLoopRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_util_MoMaLoopRuleWithSwitch MoMaLoopRuleWithSwitch \addindex moma call \addindex loop moma \addindex switch moma \addindex select / case moma This rule works similar the MomaLoopRule. The difference is, the name of the executed moma jobfile depends on the property: \b SwitchProperty. Type: ToRule \par Properties Additional to MomaLoopRule, this rule uses properties in a different way or additional properties. \li \b JobFilename (required, no default, DT_STRING)
Against in MomaLoopRule, here the property contains a list of moma job files separated by \b SplitChar. \li \b KeysForJobFilename (required, no default, DT_STRING)
Contains a list of keys for evaluation which jobfile should be executed. \li \b SwitchProperty (required, no default, DT_STRING)
Contains a key, which is used to decide which moma jobfile to execute. In case \b AllwaysEvaluateSwitchProperty is false the property is read from the context and the value is the key to select the job-file. In case \b AllwaysEvaluateSwitchProperty is true the value in the context will be used as the name of the attributes in the dataset and the value of the attribute is the key to select the job-file. \li \b DefaultJobFilename (optional, no default, DT_STRING)
The default job file which will be executed in case the value of the attribute given with \e SwitchProperty does not lead to an match in the list of \e KeysForJobFilename. In case the property is not given there is no default handling and an error will be reported for the missing value of the key. This job file will be used also when the attribute given with \e SwitchProperty is not found in the data set. \li \b AllwaysEvaluateSwitchProperty (optional, default false, DT_BOOLEAN)
When this property is set to true, on every row in the nvu array, the 'SwitchProperty' is evaluated and the corresponding jobfile is executed. Otherwise, the all rows will be executed with the same rule. When the rule is executed, the property \b SwitchProperty is read. This value will be matched with the values from property: KeysForJobFilename. Then the corresponding moma jobfile from property: JobFilename will be executed.

Field Summary

Fields inherited from class com.highqsoft.moma.rules.utils.MoMaLoopRule

createCoSession, decoratedProperties, jobFilename, maxAllowedErrors, refVars, returnProperties, returnRefVars, splitChar

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

Method Summary

Methods

Modifier and Type	Method and Description
void	init() The init method, get the JOB-Filenames, read the JOB-File, get the name of the session reference and the names of the arguments.
void	setValue(NameValueUnit[][] nvu) The setValue method, execute the Job-File for every row in the dataset.

Methods inherited from class com.highqsoft.moma.rules.utils.MoMaLoopRule

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

MoMaLoopRuleWithSwitch

public MoMaLoopRuleWithSwitch()

Method Detail

init

public void init()
          throws InitializationFailedException

The init method, get the JOB-Filenames, read the JOB-File, get the name of the session reference and the names of the arguments.

Specified by:

init in interface ImplementationIF

Overrides:

init in class MoMaLoopRule

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

setValue

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

The setValue method, execute the Job-File for every row in the dataset.

Specified by:

setValue in interface RuleIF

Overrides:

setValue in class MoMaLoopRule

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

See Also:

RuleIF.setValue(org.asam.ods.NameValueUnit[][])