Package adams.flow.template

Class RestoreVariable

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.template.AbstractActorTemplate

adams.flow.template.RestoreVariable

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractActorTemplate>, SizeOfHandler, Serializable

public class RestoreVariable
extends AbstractActorTemplate

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_RestoreFile	the name of the restore file.
protected VariableName	m_RestoreVar	the name of the restore variable.

Fields inherited from class adams.flow.template.AbstractActorTemplate

m_Name

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected Actor	doGenerate()	Generates the actor.
String	getRestoreFile()	Returns the file to store the settings in.
VariableName	getRestoreVar()	Returns the variable name to use for the restore file.
String	globalInfo()	Returns a string describing the object.
boolean	isInteractive()	Whether the flow generated is an interactive one.
String	restoreFileTipText()	Returns the tip text for this property.
String	restoreVarTipText()	Returns the tip text for this property.
void	setRestoreFile(String value)	Sets the file to store the settings in.
void	setRestoreVar(VariableName value)	Sets the variable name to use for the restore file.

Methods inherited from class adams.flow.template.AbstractActorTemplate

compareTo, equals, forCommandLine, forName, generate, getBaselineCorrections, getDefaultName, getName, nameTipText, postGenerate, preGenerate, setName, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_RestoreVar

protected VariableName m_RestoreVar

the name of the restore variable.

m_RestoreFile

protected String m_RestoreFile

the name of the restore file.

Constructor Detail

RestoreVariable

public RestoreVariable()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActorTemplate

setRestoreVar

public void setRestoreVar(VariableName value)

Sets the variable name to use for the restore file.

Parameters:

value - the variable name

getRestoreVar

public VariableName getRestoreVar()

Returns the variable name to use for the restore file.

Returns:

the variable name

restoreVarTipText

public String restoreVarTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setRestoreFile

public void setRestoreFile(String value)

Sets the file to store the settings in.

Parameters:

value - the settings file

getRestoreFile

public String getRestoreFile()

Returns the file to store the settings in.

Returns:

the settings file

restoreFileTipText

public String restoreFileTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

isInteractive

public boolean isInteractive()

Whether the flow generated is an interactive one.

Specified by:

isInteractive in class AbstractActorTemplate

Returns:

true if interactive

doGenerate

protected Actor doGenerate()

Generates the actor.

Specified by:

doGenerate in class AbstractActorTemplate

Returns:

the generated acto