Package adams.flow.control.flowrestart.operation

Class AbstractRestartOperation

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.control.flowrestart.operation.AbstractRestartOperation

All Implemented Interfaces:

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

Direct Known Subclasses:

ExternalCommand, FlowFile, MultiOperation, Null, RestartItself

public abstract class AbstractRestartOperation
extends AbstractOptionHandler
implements QuickInfoSupporter

Ancestor for restart operations.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
abstract String	restart(Flow flow)	Restarts the flow.
protected void	stopFlow(Flow flow)	Stops the flow.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

Constructor Detail

AbstractRestartOperation

public AbstractRestartOperation()

Method Detail

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.
Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

stopFlow

protected void stopFlow(Flow flow)

Stops the flow.

Parameters:

flow - the flow to stop

restart

public abstract String restart(Flow flow)

Restarts the flow.

Parameters:

flow - the flow to handle

Returns:

null if successfully restarted, otherwise the error message