Package adams.flow.standalone.rats.generator

Class AbstractScriptedRatGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.generator.AbstractRatGenerator

adams.flow.standalone.rats.generator.AbstractScriptedRatGenerator

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.scripting.FileBasedScripting, adams.core.scripting.FileBasedScriptingWithOptions, adams.core.SizeOfHandler, Serializable

Direct Known Subclasses:

Scripted

public abstract class AbstractScriptedRatGenerator
extends AbstractRatGenerator
implements adams.core.scripting.FileBasedScriptingWithOptions

Abstract ancestor for rat generators that execute external 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 adams.core.io.PlaceholderFile	m_ScriptFile	the script.
protected Object	m_ScriptObject	the loaded script object.
protected String	m_ScriptOptions	the options for the script.

Fields inherited from class adams.flow.standalone.rats.generator.AbstractRatGenerator

m_Log, m_SendErrorQueue, m_ShowInControl

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

Method Summary

Modifier and Type	Method	Description
protected void	check()	Hook method for checks.
protected abstract String	checkScriptObject()	Checks the script object.
void	defineOptions()	Adds options to the internal list of options.
void	destroy()	Frees up memory in a "destructive" non-reversible way.
adams.core.io.PlaceholderFile	getScriptFile()	Gets the script file.
adams.core.base.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.
void	reset()	Resets the conversion.
String	scriptFileTipText()	Returns the tip text for this property.
String	scriptOptionsTipText()	Returns the tip text for this property.
void	setScriptFile(adams.core.io.PlaceholderFile value)	Sets the script file.
void	setScriptOptions(adams.core.base.BaseText value)	Sets the script options.

Methods inherited from class adams.flow.standalone.rats.generator.AbstractRatGenerator

doGenerate, generate, getLog, getSendErrorQueue, getShowInControl, logTipText, sendErrorQueueTipText, setLog, setSendErrorQueue, setShowInControl, showInControlTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_ScriptFile

protected adams.core.io.PlaceholderFile m_ScriptFile

the script.

m_ScriptOptions

protected String m_ScriptOptions

the options for the script.

m_ScriptObject

protected transient Object m_ScriptObject

the loaded script object.

Constructor Detail

AbstractScriptedRatGenerator

public AbstractScriptedRatGenerator()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class AbstractRatGenerator

reset

public void reset()

Resets the conversion.

Overrides:

reset in class adams.core.option.AbstractOptionHandler

setScriptFile

public void setScriptFile(adams.core.io.PlaceholderFile value)

Sets the script file.

Specified by:

setScriptFile in interface adams.core.scripting.FileBasedScripting

Parameters:

value - the script

getScriptFile

public adams.core.io.PlaceholderFile getScriptFile()

Gets the script file.

Specified by:

getScriptFile in interface adams.core.scripting.FileBasedScripting

Returns:

the script

scriptFileTipText

public String scriptFileTipText()

Returns the tip text for this property.

Specified by:

scriptFileTipText in interface adams.core.scripting.FileBasedScripting

Returns:

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

setScriptOptions

public void setScriptOptions(adams.core.base.BaseText value)

Sets the script options.

Specified by:

setScriptOptions in interface adams.core.scripting.FileBasedScriptingWithOptions

Parameters:

value - the options

getScriptOptions

public adams.core.base.BaseText getScriptOptions()

Gets the script options.

Specified by:

getScriptOptions in interface adams.core.scripting.FileBasedScriptingWithOptions

Returns:

the options

scriptOptionsTipText

public String scriptOptionsTipText()

Returns the tip text for this property.

Specified by:

scriptOptionsTipText in interface adams.core.scripting.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

check

protected void check()

Hook method for checks.

Overrides:

check in class AbstractRatGenerator

destroy

public void destroy()

Frees up memory in a "destructive" non-reversible way.

Specified by:

destroy in interface adams.core.Destroyable

Overrides:

destroy in class adams.core.option.AbstractOptionHandler