Package adams.flow.execution

Class RemoteFlowListener

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.execution.AbstractFlowExecutionListener

adams.flow.execution.RemoteFlowListener

All Implemented Interfaces:

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

public class RemoteFlowListener
extends AbstractFlowExecutionListener

Listens on the specified port, returns the currently running flow setup.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoteFlowListener.ListenerRunnable	The runnable that listens to the

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_PORT	the default port.
protected int	m_Port	the port to listen on.
protected RemoteFlowListener.ListenerRunnable	m_Runnable	the runnable in use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
void	finishListening()	Gets called when the flow execution ends.
int	getPort()	Returns the port to listen on.
String	globalInfo()	Returns a string describing the object.
String	portTipText()	Returns the tip text for this property.
void	setPort(int value)	Sets the port to listen on.
void	startListening()	Gets called when the flow execution starts.

Methods inherited from class adams.flow.execution.AbstractFlowExecutionListener

cleanUp, 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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

the default port.

See Also:

Constant Field Values

m_Port

protected int m_Port

the port to listen on.

m_Runnable

protected transient RemoteFlowListener.ListenerRunnable m_Runnable

the runnable in use.

Constructor Detail

RemoteFlowListener

public RemoteFlowListener()

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

setPort

public void setPort(int value)

Sets the port to listen on.

Parameters:

value - the port to listen on

getPort

public int getPort()

Returns the port to listen on.

Returns:

the port

portTipText

public String portTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

startListening

public void startListening()

Gets called when the flow execution starts.

Specified by:

startListening in interface FlowExecutionListener

Overrides:

startListening in class AbstractFlowExecutionListener

finishListening

public void finishListening()

Gets called when the flow execution ends.

Specified by:

finishListening in interface FlowExecutionListener

Overrides:

finishListening in class AbstractFlowExecutionListener