Package adams.core.command.stdout

Class CallableActorSink

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.command.stdout.AbstractStdOutProcessor

adams.core.command.stdout.CallableActorSink

All Implemented Interfaces:

CleanUpHandler, StdOutProcessor, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, CallableActorUser, Serializable

public class CallableActorSink
extends AbstractStdOutProcessor
implements CallableActorUser

Forwards the data to the callable actor sink.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Actor	m_CallableActor	the callable actor.
protected CallableActorReference	m_CallableName	the callable name.
protected CallableActorHelper	m_Helper	the helper class.

Fields inherited from class adams.core.command.stdout.AbstractStdOutProcessor

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

Method Summary

Modifier and Type	Method	Description
String	callableNameTipText()	Returns the tip text for this property.
void	cleanUp()	Cleans up data structures, frees up memory.
void	defineOptions()	Adds options to the internal list of options.
Actor	getCallableActor()	Returns the currently set callable actor.
CallableActorReference	getCallableName()	Returns the name of the callable actor in use.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
void	processAsync(String output)	Processes the stdout output received when in async mode.
void	processBlocking(String output)	Processes the stdout output received when in blocking mode.
void	setCallableName(CallableActorReference value)	Sets the name of the callable actor to use.
String	setUp(FlowContextHandler owner)	Configures the handler.

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, 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_CallableName

protected CallableActorReference m_CallableName

the callable name.

m_Helper

protected CallableActorHelper m_Helper

the helper class.

m_CallableActor

protected Actor m_CallableActor

the callable actor.

Constructor Detail

CallableActorSink

public CallableActorSink()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

setCallableName

public void setCallableName(CallableActorReference value)

Sets the name of the callable actor to use.

Parameters:

value - the callable name

getCallableName

public CallableActorReference getCallableName()

Returns the name of the callable actor in use.

Returns:

the callable name

callableNameTipText

public String callableNameTipText()

Returns the tip text for this property.

Returns:

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

getCallableActor

public Actor getCallableActor()

Returns the currently set callable actor.

Specified by:

getCallableActor in interface CallableActorUser

Returns:

the actor, can be null

setUp

public String setUp(FlowContextHandler owner)

Configures the handler.

Specified by:

setUp in interface StdOutProcessor

Overrides:

setUp in class AbstractStdOutProcessor

Parameters:

owner - the owning command

Returns:

null if successfully setup, otherwise error message

processAsync

public void processAsync(String output)

Processes the stdout output received when in async mode.

Specified by:

processAsync in interface StdOutProcessor

Specified by:

processAsync in class AbstractStdOutProcessor

Parameters:

output - the output to process

processBlocking

public void processBlocking(String output)

Processes the stdout output received when in blocking mode.

Specified by:

processBlocking in interface StdOutProcessor

Specified by:

processBlocking in class AbstractStdOutProcessor

Parameters:

output - the output to process

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler

Overrides:

cleanUp in class AbstractStdOutProcessor