Package adams.flow.execution

Class Time

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

adams.flow.execution.Time

All Implemented Interfaces:

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

public class Time
extends AbstractTimedFlowExecutionListenerWithTable

Shows how much time actors are taking in their method calls (gets accumulated).

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

-update-interval <int> (property: updateInterval)
    The update interval (= number of method executions) after which the GUI
    gets refreshed.
    default: 100
    minimum: 1
 

-log-file <adams.core.io.PlaceholderFile> (property: logFile)
    The CSV log file to write to; writing is disabled if pointing to a directory.
    default: ${CWD}
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderFile	m_LogFile	the file to write to.
protected Map<String,Long>	m_Overall	keeps track of the time that actors used up.
protected Map<String,Long>	m_Start	keeps track of the start time of an actor.
static String	SUFFIX_EXECUTE	the suffix for "execute".
static String	SUFFIX_INPUT	the suffix for "input".
static String	SUFFIX_OUTPUT	the suffix for "output".

Fields inherited from class adams.flow.execution.AbstractTimedFlowExecutionListenerWithTable

m_Counter, m_UpdateInterval

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

Method Summary

Modifier and Type	Method	Description
protected void	addDuration(String key)	Adds the duration to the overall count.
protected void	addStart(String key)	Adds the start time.
void	cleanUp()	Cleans up data structures, frees up memory.
protected TableModel	createTableModel()	Creates a new table model with the current data.
void	defineOptions()	Adds options to the internal list of options.
void	finishListening()	Gets called when the flow execution ends.
protected int	getDefaultUpdateInterval()	Returns the default update interval.
String	getListenerTitle()	The title of this listener.
PlaceholderFile	getLogFile()	Returns the log file.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
String	logFileTipText()	Returns the tip text for this property.
void	postExecute(Actor actor)	Gets called after the actor was executed.
void	postInput(Actor actor)	Gets called after the actor received the token.
void	postOutput(Actor actor, Token token)	Gets called after a token was acquired from the actor.
void	preExecute(Actor actor)	Gets called before the actor gets executed.
void	preInput(Actor actor, Token token)	Gets called before the actor receives the token.
void	preOutput(Actor actor)	Gets called before a token gets obtained from the actor.
void	setLogFile(PlaceholderFile value)	Sets the log file.
void	startListening()	Gets called when the flow execution starts.
String	updateIntervalTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.execution.AbstractTimedFlowExecutionListenerWithTable

getUpdateInterval, incCounter, setUpdateInterval

Methods inherited from class adams.flow.execution.AbstractFlowExecutionListenerWithTable

getFileChooser, getSheet, newListenerPanel, updateGUI

Methods inherited from class adams.flow.execution.AbstractGraphicalFlowExecutionListener

getDefaultFrameSize, getDisposeOnFinish, newListenerPanelIfNecessary

Methods inherited from class adams.flow.execution.AbstractFlowExecutionListener

compareTo, equals, getListeners, getOwner, setOwner, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

getOwner, setOwner

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

SUFFIX_INPUT

public static final String SUFFIX_INPUT

the suffix for "input".

See Also:

Constant Field Values

SUFFIX_EXECUTE

public static final String SUFFIX_EXECUTE

the suffix for "execute".

See Also:

Constant Field Values

SUFFIX_OUTPUT

public static final String SUFFIX_OUTPUT

the suffix for "output".

See Also:

Constant Field Values

m_Start

protected Map<String,Long> m_Start

keeps track of the start time of an actor.

m_Overall

protected Map<String,Long> m_Overall

keeps track of the time that actors used up.

m_LogFile

protected PlaceholderFile m_LogFile

the file to write to.

Constructor Detail

Time

public Time()

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 AbstractTimedFlowExecutionListenerWithTable

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractFlowExecutionListenerWithTable

updateIntervalTipText

public String updateIntervalTipText()

Returns the tip text for this property.

Specified by:

updateIntervalTipText in interface TimedFlowExecutionListener

Specified by:

updateIntervalTipText in class AbstractTimedFlowExecutionListenerWithTable

Returns:

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

setLogFile

public void setLogFile(PlaceholderFile value)

Sets the log file.

Parameters:

value - the file

getLogFile

public PlaceholderFile getLogFile()

Returns the log file.

Returns:

the condition

logFileTipText

public String logFileTipText()

Returns the tip text for this property.

Returns:

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

getListenerTitle

public String getListenerTitle()

The title of this listener.

Returns:

the title

startListening

public void startListening()

Gets called when the flow execution starts.

Specified by:

startListening in interface FlowExecutionListener

Overrides:

startListening in class AbstractTimedFlowExecutionListenerWithTable

addStart

protected void addStart(String key)

Adds the start time.

Parameters:

key - the key in the hashtable

addDuration

protected void addDuration(String key)

Adds the duration to the overall count.

Parameters:

key - the key in the hashtable

getDefaultUpdateInterval

protected int getDefaultUpdateInterval()

Returns the default update interval.

Overrides:

getDefaultUpdateInterval in class AbstractTimedFlowExecutionListenerWithTable

createTableModel

protected TableModel createTableModel()

Creates a new table model with the current data.

Specified by:

createTableModel in class AbstractFlowExecutionListenerWithTable

Returns:

the model with the current data

preInput

public void preInput(Actor actor,
                     Token token)

Gets called before the actor receives the token.

Specified by:

preInput in interface FlowExecutionListener

Overrides:

preInput in class AbstractFlowExecutionListener

Parameters:

actor - the actor that will receive the token

token - the token that the actor will receive

postInput

public void postInput(Actor actor)

Gets called after the actor received the token.

Specified by:

postInput in interface FlowExecutionListener

Overrides:

postInput in class AbstractFlowExecutionListener

Parameters:

actor - the actor that received the token

preExecute

public void preExecute(Actor actor)

Gets called before the actor gets executed.

Specified by:

preExecute in interface FlowExecutionListener

Overrides:

preExecute in class AbstractFlowExecutionListener

Parameters:

actor - the actor that gets executed

postExecute

public void postExecute(Actor actor)

Gets called after the actor was executed.

Specified by:

postExecute in interface FlowExecutionListener

Overrides:

postExecute in class AbstractFlowExecutionListener

Parameters:

actor - the actor that was executed

preOutput

public void preOutput(Actor actor)

Gets called before a token gets obtained from the actor.

Specified by:

preOutput in interface FlowExecutionListener

Overrides:

preOutput in class AbstractFlowExecutionListener

Parameters:

actor - the actor the token gets obtained from

postOutput

public void postOutput(Actor actor,
                       Token token)

Gets called after a token was acquired from the actor.

Specified by:

postOutput in interface FlowExecutionListener

Overrides:

postOutput in class AbstractFlowExecutionListener

Parameters:

actor - the actor that the token was acquired from

token - the token that was acquired from the actor

finishListening

public void finishListening()

Gets called when the flow execution ends.

Specified by:

finishListening in interface FlowExecutionListener

Overrides:

finishListening in class AbstractGraphicalFlowExecutionListener

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler

Overrides:

cleanUp in class AbstractTimedFlowExecutionListenerWithTable