Package adams.flow.condition.test

Class AbstractScriptedCondition

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.condition.test.AbstractTestCondition

adams.flow.condition.test.AbstractScriptedCondition

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, FileBasedScripting, FileBasedScriptingWithOptions, ShallowCopySupporter<TestCondition>, SizeOfHandler, TestCondition, Serializable, Comparable

Direct Known Subclasses:

Groovy, Jython, Scripted

public abstract class AbstractScriptedCondition
extends AbstractTestCondition
implements FileBasedScriptingWithOptions

Abstract ancestor for test conditions that execute scripts.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderFile	m_ScriptFile	the Groovy module.
protected Object	m_ScriptObject	the loaded script object.
protected String	m_ScriptOptions	the options for the Groovy module.

Fields inherited from class adams.flow.condition.test.AbstractTestCondition

m_Tested, m_TestResult

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractScriptedCondition()

Method Summary

Modifier and Type	Method	Description
protected abstract String	checkScriptObject()	Checks the script object.
void	defineOptions()	Adds options to the internal list of options.
PlaceholderFile	getScriptFile()	Gets the Groovy module.
BaseText	getScriptOptions()	Gets the script options.
protected String	initScriptObject()	Tries to initialize the scripts object, sets its options and performs some checks.
protected abstract String	loadScriptObject()	Loads the scripts object and sets its options.
protected abstract String	performScriptTest()	Runs the script test.
protected String	performTest()	Performs the actual testing of the condition.
void	reset()	Resets the condition.
String	scriptFileTipText()	Returns the tip text for this property.
String	scriptOptionsTipText()	Returns the tip text for this property.
void	setScriptFile(PlaceholderFile value)	Sets the Groovy module.
void	setScriptOptions(BaseText value)	Sets the script options.

Methods inherited from class adams.flow.condition.test.AbstractTestCondition

compareTo, equals, forCommandLine, forName, getConditions, getQuickInfo, getTestResult, initialize, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_ScriptFile

protected PlaceholderFile m_ScriptFile

the Groovy module.

m_ScriptOptions

protected String m_ScriptOptions

the options for the Groovy module.

m_ScriptObject

protected transient Object m_ScriptObject

the loaded script object.

Constructor Detail

AbstractScriptedCondition

public AbstractScriptedCondition()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

reset

public void reset()

Resets the condition. Derived classes must call this method in set-methods of parameters to assure the invalidation of previously generated data.

Overrides:

reset in class AbstractTestCondition

setScriptFile

public void setScriptFile(PlaceholderFile value)

Sets the Groovy module.

Specified by:

setScriptFile in interface FileBasedScripting

Parameters:

value - the Groovy module

getScriptFile

public PlaceholderFile getScriptFile()

Gets the Groovy module.

Specified by:

getScriptFile in interface FileBasedScripting

Returns:

the Groovy module

scriptFileTipText

public String scriptFileTipText()

Returns the tip text for this property.

Specified by:

scriptFileTipText in interface FileBasedScripting

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setScriptOptions

public void setScriptOptions(BaseText value)

Sets the script options.

Specified by:

setScriptOptions in interface FileBasedScriptingWithOptions

Parameters:

value - the options

getScriptOptions

public BaseText getScriptOptions()

Gets the script options.

Specified by:

getScriptOptions in interface FileBasedScriptingWithOptions

Returns:

the options

scriptOptionsTipText

public String scriptOptionsTipText()

Returns the tip text for this property.

Specified by:

scriptOptionsTipText in interface FileBasedScriptingWithOptions

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

loadScriptObject

protected abstract String loadScriptObject()

Loads the scripts object and sets its options.

Returns:

null if OK, otherwise the error message

checkScriptObject

protected abstract String checkScriptObject()

Checks the script object.

Returns:

null if OK, otherwise the error message

initScriptObject

protected String initScriptObject()

Tries to initialize the scripts object, sets its options and performs some checks.

Returns:

null if OK, otherwise the error message

performScriptTest

protected abstract String performScriptTest()

Runs the script test.

Returns:

the test result, null if everything OK, otherwise the error message

performTest

protected String performTest()

Performs the actual testing of the condition.

Specified by:

performTest in class AbstractTestCondition

Returns:

the test result, null if everything OK, otherwise the error message