Package adams.flow.control.postflowexecution

Class FromFile

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.control.postflowexecution.AbstractPostFlowExecution

adams.flow.control.postflowexecution.FromFile

All Implemented Interfaces:

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

public class FromFile
extends AbstractPostFlowExecution

Loads the actor from the specified file.

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 flow to load and configure.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected Actor	doConfigureExecution(MessageCollection errors)	Configures the actor to execute after the flow has run (without calling setUp()).
String	flowFileTipText()	Returns the tip text for this property.
FlowFile	getFlowFile()	Returns the external flow to execute in case the flow finishes with an error.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setFlowFile(FlowFile value)	Sets the external flow to execute in case the flow finishes with an error.

Methods inherited from class adams.flow.control.postflowexecution.AbstractPostFlowExecution

configureExecution

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 flow to load and configure.

Constructor Detail

FromFile

public FromFile()

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 external flow to execute in case the flow finishes with an error.

Parameters:

value - the external flow

getFlowFile

public FlowFile getFlowFile()

Returns the external flow to execute in case the flow finishes with an error.

Returns:

the external flow

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 AbstractPostFlowExecution

Returns:

null if no info available, otherwise short string

doConfigureExecution

protected Actor doConfigureExecution(MessageCollection errors)

Configures the actor to execute after the flow has run (without calling setUp()).

Specified by:

doConfigureExecution in class AbstractPostFlowExecution

Parameters:

errors - for collecting errors during configuration

Returns:

the actor, null if none generated