Package adams.flow.control.flowrestart.operation

Class RestartItself

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.control.flowrestart.operation.AbstractRestartOperation

adams.flow.control.flowrestart.operation.RestartItself

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class RestartItself
extends AbstractRestartOperation

Restarts the flow as defined in variable ActorUtils.FLOW_FILENAME_LONG.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_UseFlowFileVariable	whether to use the ActorUtils.FLOW_FILENAME_LONG or just the flow itself.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
boolean	getUseFlowFileVariable()	Returns whether to just restart the flow or execute from file (ActorUtils.FLOW_FILENAME_LONG).
String	globalInfo()	Returns a string describing the object.
String	restart(Flow flow)	Restarts the flow.
void	setUseFlowFileVariable(boolean value)	Sets whether to just restart the flow or execute from file (ActorUtils.FLOW_FILENAME_LONG).
String	useFlowFileVariableTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.control.flowrestart.operation.AbstractRestartOperation

getQuickInfo, stopFlow

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_UseFlowFileVariable

protected boolean m_UseFlowFileVariable

whether to use the ActorUtils.FLOW_FILENAME_LONG or just the flow itself.

Constructor Detail

RestartItself

public RestartItself()

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 AbstractOptionHandler

setUseFlowFileVariable

public void setUseFlowFileVariable(boolean value)

Sets whether to just restart the flow or execute from file (ActorUtils.FLOW_FILENAME_LONG).

Parameters:

value - true if to use variable

getUseFlowFileVariable

public boolean getUseFlowFileVariable()

Returns whether to just restart the flow or execute from file (ActorUtils.FLOW_FILENAME_LONG).

Returns:

true if to use variable

useFlowFileVariableTipText

public String useFlowFileVariableTipText()

Returns the tip text for this property.

Returns:

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

restart

public String restart(Flow flow)

Restarts the flow.

Specified by:

restart in class AbstractRestartOperation

Parameters:

flow - the flow to handle

Returns:

null if successfully restarted, otherwise the error message