Package adams.flow.sink.timeseriesdisplay

Class SimplePlotUpdater

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractDataPlotUpdater<TimeseriesPanel,TimeseriesContainer>

adams.flow.sink.timeseriesdisplay.AbstractPlotUpdater

adams.flow.sink.timeseriesdisplay.SimplePlotUpdater

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, DataPlotUpdater<TimeseriesPanel,TimeseriesContainer>, Serializable

public class SimplePlotUpdater
extends AbstractPlotUpdater

Updates the display after the specified number of tokens have been processed.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-update-interval <int> (property: updateInterval)
    Specifies the number of tokens after which the display is being updated; 
    <= 0 means no update until flow finished.
    default: 1
    minimum: -1
 

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_NumTokensAccepted	the number of tokens accepted.
protected int	m_UpdateInterval	the interval of tokens processed after which to update the display.

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canNotify(TimeseriesPanel panel, TimeseriesContainer cont)	Checks whether all conditions are met to notify the listeners for changes in the plot.
void	defineOptions()	Adds options to the internal list of options.
int	getUpdateInterval()	Returns the number of tokens after which the display is being updated.
String	globalInfo()	Returns a string describing the object.
protected void	reset()	Resets the object.
void	setUpdateInterval(int value)	Sets the number of tokens after which the display is being updated.
String	updateIntervalTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.core.AbstractDataPlotUpdater

doUpdate, update, update

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_UpdateInterval

protected int m_UpdateInterval

the interval of tokens processed after which to update the display.

m_NumTokensAccepted

protected int m_NumTokensAccepted

the number of tokens accepted.

Constructor Detail

SimplePlotUpdater

public SimplePlotUpdater()

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

reset

protected void reset()

Resets the object.

Overrides:

reset in class AbstractOptionHandler

setUpdateInterval

public void setUpdateInterval(int value)

Sets the number of tokens after which the display is being updated.

Parameters:

value - the number of tokens

getUpdateInterval

public int getUpdateInterval()

Returns the number of tokens after which the display is being updated.

Returns:

the number of tokens

updateIntervalTipText

public String updateIntervalTipText()

Returns the tip text for this property.

Returns:

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

canNotify

protected boolean canNotify(TimeseriesPanel panel,
                            TimeseriesContainer cont)

Checks whether all conditions are met to notify the listeners for changes in the plot.

Specified by:

canNotify in class AbstractDataPlotUpdater<TimeseriesPanel,TimeseriesContainer>

Parameters:

panel - the plotter to potentially update

cont - the current plot container

Returns:

true if the listeners can be notified