Package adams.flow.control.postflowexecution

Class AbstractPostFlowExecution

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.control.postflowexecution.AbstractPostFlowExecution

All Implemented Interfaces:

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

Direct Known Subclasses:

FromFile, Null, RemoveFiles

public abstract class AbstractPostFlowExecution
extends AbstractOptionHandler
implements PostFlowExecution

Ancestor for plugins that generate/configure actors to execute when the flow stops with an error.

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

Method Summary

Modifier and Type	Method	Description
Actor	configureExecution(MessageCollection errors)	Configures the actor to execute after the flow has run (including calling setUp()).
protected abstract Actor	doConfigureExecution(MessageCollection errors)	Configures the actor to execute after the flow has run (without calling setUp()).
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.

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

AbstractPostFlowExecution

public AbstractPostFlowExecution()

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

doConfigureExecution

protected abstract Actor doConfigureExecution(MessageCollection errors)

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

Parameters:

errors - for collecting errors during configuration

Returns:

the actor, null if none generated

configureExecution

public Actor configureExecution(MessageCollection errors)

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

Specified by:

configureExecution in interface PostFlowExecution

Parameters:

errors - for collecting errors during configuration

Returns:

the actor, null if none generated