Package adams.flow.standalone.rats.generator

Class AbstractScript

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

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.flow.core.AdditionalOptionsHandler, Serializable

public abstract class AbstractScript
extends AbstractRatGenerator
implements adams.flow.core.AdditionalOptionsHandler

Ancestor for rat generator scripts.

Scripts of scripting languages like Jython or Groovy need to be derived from this class.

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.flow.core.AdditionalOptions	m_AdditionalOptions	for storing the additional options.

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

Method Summary

Modifier and Type	Method	Description
adams.flow.core.AdditionalOptions	getAdditionalOptions()	Returns the value associated with the (additional) option.
protected void	initialize()	Initializes the members.
void	setAdditionalOptions(adams.flow.core.AdditionalOptions options)	Sets the additional options.

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

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

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, reset, 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_AdditionalOptions

protected adams.flow.core.AdditionalOptions m_AdditionalOptions

for storing the additional options.

Constructor Detail

AbstractScript

public AbstractScript()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class adams.core.option.AbstractOptionHandler

setAdditionalOptions

public void setAdditionalOptions(adams.flow.core.AdditionalOptions options)

Sets the additional options.

Specified by:

setAdditionalOptions in interface adams.flow.core.AdditionalOptionsHandler

Parameters:

options - the options (name <->value relation)

getAdditionalOptions

public adams.flow.core.AdditionalOptions getAdditionalOptions()

Returns the value associated with the (additional) option.

Specified by:

getAdditionalOptions in interface adams.flow.core.AdditionalOptionsHandler

Returns:

the options (name <->value relation)