com.highqsoft.moma.rules.utils

Class GroovyScriptRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.GroovyScriptRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class GroovyScriptRule
extends AbstractSequencerRule
implements ExecutableIF

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_GroovyScriptRule GroovyScriptRule \addindex GroovyScriptRule \addindex execute groovy script This rule executes a groovy script. The script can be passed as a separate file with the property: ScriptFile, or passed with the property Script from inside the moma job file. Inside the groovy script, the following bind variable are passed to groovy script: - "moma" represents the instance of the GroovyScriptRule class, so all methods of this class are available. - "messenger" the messenger for writing strings to current messenger - "logger" for writing log messanges - "statistic" reference to a hashmap for caching statistic informations - "session" current instance of AoSession, only when the rule tag has the attribute: sessionref="..." - "odsCache" current instance of the OdsCache This is only available, if the property: OdsCacheRef is defined. - "nvuIn" The nvu array, which was passed to GroovyScriptRule instance (setValue...) For compatibility to old scripts, the following objects are safed in context: - "JAVA_NVU" The passed nvu array (setValue) - "JAVA_MESSENGER" The messenger instance Type: SequencerRule \par Properties \li \b ScriptFile (optional, no default, DT_STRING)
This property contains the name of the file with the groovy script to execute. \li \b Script (required if 'ScriptFile' is not used, no default, DT_STRING)
This property contains the groovy script to execute. \li \b UseGetValueMethod (optional, default false, DT_BOOLEAN)
When parameter is true, in a sequence the method \em getValue is used instead of \em setValue. \li \b UniqueID (optional, default no, DT_STRING)
When parameter is passed, it is used as key for caching parsed and compiled groovy scripts. This parameter should be used, when the script is executed several times. \li \b OdsCacheRef (optional, no default, DT_STRING)
The name of the ODS Cache reference in the context. \par Test 1 The example below is called from the sequence in a modelmapper control file. It searches the filesystem for a specific directory \li Input \code \endcode \li Configuration \code // Check the name of the directory if(dir.getPath().endsWith(searchdir)) { foundDirectory = dir.getPath() } } if(foundDirectory != null) { moma.ctx.setProperty("FoundDirectory", foundDirectory) messenger.info("Found directory: '" + moma.ctx.getProperty("FoundDirectory") + "'.") } else { messenger.warning ("Directory with string: " + searchdir + " was not found.") } ]]> \endcode \li Expected output \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
GroovyScriptRule()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the shell script
NameValueUnit[][]	getValue() Get the value of the rule.
void	init() Initialize the rule.
void	setValue(NameValueUnit[][] nvu) Get the value of the rule.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

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.ExecutableIF

terminate

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Constructor Detail

GroovyScriptRule

public GroovyScriptRule()

Method Detail

init

public void init()
          throws InitializationFailedException

Initialize the rule.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

execute

public void execute()
             throws ExecutableException

Execute the shell script

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractSequencerRule

Throws:

ExecutableException

See Also:

AbstractRule.execute()

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Get the value of the rule.

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractSequencerRule

Returns:

an array of NameValueUnit sequences.

Throws:

RuleException

See Also:

RuleIF.getValue()

setValue

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

Get the value of the rule.

Specified by:

setValue in interface RuleIF

Parameters:

nvu - an array of NameValueUnit sequences.

Throws:

RuleException