Package adams.flow.control.flowrestart.operation

Class FlowFile

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

All Implemented Interfaces:

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

public class FlowFile
extends AbstractRestartOperation

Starts the specified flow.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected FlowFile	m_FlowFile	the command to start.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	flowFileTipText()	Returns the tip text for this property.
FlowFile	getFlowFile()	Returns the flow to start.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	restart(Flow flow)	Restarts the flow.
void	setFlowFile(FlowFile value)	Sets the flow to start.

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

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_FlowFile

protected FlowFile m_FlowFile

the command to start.

Constructor Detail

FlowFile

public FlowFile()

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

setFlowFile

public void setFlowFile(FlowFile value)

Sets the flow to start.

Parameters:

value - the file

getFlowFile

public FlowFile getFlowFile()

Returns the flow to start.

Returns:

the file

flowFileTipText

public String flowFileTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractRestartOperation

Returns:

null if no info available, otherwise short string

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