Package adams.flow.execution

Class AbstractTimedFlowExecutionListenerWithTable

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.execution.AbstractFlowExecutionListener

adams.flow.execution.AbstractGraphicalFlowExecutionListener

adams.flow.execution.AbstractFlowExecutionListenerWithTable

adams.flow.execution.AbstractTimedFlowExecutionListenerWithTable

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<FlowExecutionListener>, SizeOfHandler, FlowExecutionListener, GraphicalFlowExecutionListener, TimedFlowExecutionListener, Serializable, Comparable

Direct Known Subclasses:

CurrentlyExecuted, ExecutionCounter, Time

public abstract class AbstractTimedFlowExecutionListenerWithTable
extends AbstractFlowExecutionListenerWithTable
implements TimedFlowExecutionListener

Ancestor for listeners that use tables and update them at regular intervals.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Counter	the current execution counter.
protected int	m_UpdateInterval	the update interval.

Fields inherited from class adams.flow.execution.AbstractFlowExecutionListenerWithTable

m_FileChooser, m_PanelSearch, m_Table

Fields inherited from class adams.flow.execution.AbstractGraphicalFlowExecutionListener

m_ListenerPanel

Fields inherited from class adams.flow.execution.AbstractFlowExecutionListener

m_Owner

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

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Cleans up data structures, frees up memory.
void	defineOptions()	Adds options to the internal list of options.
protected int	getDefaultUpdateInterval()	Returns the default update interval.
int	getUpdateInterval()	Returns the interval after which the GUI gets refreshed.
protected void	incCounter()	Increments the counter and checks whether the GUI needs updating.
void	setUpdateInterval(int value)	Sets the interval after which the GUI gets refreshed.
void	startListening()	Gets called when the flow execution starts.
abstract String	updateIntervalTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.execution.AbstractFlowExecutionListenerWithTable

createTableModel, getFileChooser, getSheet, initialize, newListenerPanel, updateGUI

Methods inherited from class adams.flow.execution.AbstractGraphicalFlowExecutionListener

finishListening, getDefaultFrameSize, getDisposeOnFinish, newListenerPanelIfNecessary

Methods inherited from class adams.flow.execution.AbstractFlowExecutionListener

compareTo, equals, getListeners, getOwner, postExecute, postInput, postOutput, preExecute, preInput, preOutput, setOwner, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.execution.FlowExecutionListener

finishListening, getOwner, postExecute, postInput, postOutput, preExecute, preInput, preOutput, setOwner

Methods inherited from interface adams.flow.execution.GraphicalFlowExecutionListener

getListenerTitle

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_UpdateInterval

protected int m_UpdateInterval

the update interval.

m_Counter

protected int m_Counter

the current execution counter.

Constructor Detail

AbstractTimedFlowExecutionListenerWithTable

public AbstractTimedFlowExecutionListenerWithTable()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

getDefaultUpdateInterval

protected int getDefaultUpdateInterval()

Returns the default update interval.

setUpdateInterval

public void setUpdateInterval(int value)

Sets the interval after which the GUI gets refreshed.

Specified by:

setUpdateInterval in interface TimedFlowExecutionListener

Parameters:

value - the interval

getUpdateInterval

public int getUpdateInterval()

Returns the interval after which the GUI gets refreshed.

Specified by:

getUpdateInterval in interface TimedFlowExecutionListener

Returns:

the interval

updateIntervalTipText

public abstract String updateIntervalTipText()

Returns the tip text for this property.

Specified by:

updateIntervalTipText in interface TimedFlowExecutionListener

Returns:

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

startListening

public void startListening()

Gets called when the flow execution starts.

Specified by:

startListening in interface FlowExecutionListener

Overrides:

startListening in class AbstractFlowExecutionListener

incCounter

protected void incCounter()

Increments the counter and checks whether the GUI needs updating.

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler

Overrides:

cleanUp in class AbstractFlowExecutionListener