Package adams.scripting.requesthandler

Class CallableActorsHandler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.requesthandler.AbstractRequestHandler

adams.scripting.requesthandler.CallableActorsHandler

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, CallableActorUser, RequestHandler, Serializable

public class CallableActorsHandler
extends AbstractRequestHandler
implements CallableActorUser

Forwards the requests to the specified (optional) callable actor..

Version:

$Revision$

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 boolean	m_CallableActorInitialized	whether the callable actor has been initialized.
protected CallableActorReference	m_CallableName	the callable name.
protected CallableActorHelper	m_Helper	the helper class.

Fields inherited from class adams.scripting.requesthandler.AbstractRequestHandler

m_Enabled, 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
CallableActorsHandler()

Method Summary

Modifier and Type	Method	Description
String	callableNameTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Actor	findCallableActor()	Tries to find the callable actor referenced by its global name.
Actor	getCallableActor()	Returns the currently set callable actor.
CallableActorReference	getCallableName()	Returns the name of the callable transformer in use.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
void	requestFailed(RemoteCommand cmd, String msg)	Handles failed requests.
void	requestRejected(RemoteCommand cmd, String msg)	Handles rejected requests.
void	requestSuccessful(RemoteCommand cmd)	Handles successfuly requests.
protected void	reset()	Resets the scheme.
protected String	send(String event, RemoteCommand cmd, String msg)	Sends the remote command to the callable actor.
void	setCallableName(CallableActorReference value)	Sets the name of the callable transformer to use.

Methods inherited from class adams.scripting.requesthandler.AbstractRequestHandler

enabledTipText, getEnabled, getOwner, insertHandler, setEnabled, setOwner

Methods inherited from class adams.core.option.AbstractOptionHandler

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

getLoggingLevel

Field Detail

m_CallableName

protected CallableActorReference m_CallableName

the callable name.

m_CallableActorInitialized

protected boolean m_CallableActorInitialized

whether the callable actor has been initialized.

m_CallableActor

protected Actor m_CallableActor

the callable actor.

m_Helper

protected CallableActorHelper m_Helper

the helper class.

Constructor Detail

CallableActorsHandler

public CallableActorsHandler()

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 AbstractRequestHandler

reset

protected void reset()

Resets the scheme.

Overrides:

reset 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 transformer to use.

Parameters:

value - the callable name

getCallableName

public CallableActorReference getCallableName()

Returns the name of the callable transformer 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

findCallableActor

protected Actor findCallableActor()

Tries to find the callable actor referenced by its global name.

Returns:

the callable actor or null if not found

send

protected String send(String event,
                      RemoteCommand cmd,
                      String msg)

Sends the remote command to the callable actor.

Parameters:

event - the event type

cmd - the remote command

msg - the message, null if none available

Returns:

null if successful, otherwise error message

requestSuccessful

public void requestSuccessful(RemoteCommand cmd)

Handles successfuly requests.

Specified by:

requestSuccessful in interface RequestHandler

Parameters:

cmd - the command with the request

requestFailed

public void requestFailed(RemoteCommand cmd,
                          String msg)

Handles failed requests.

Specified by:

requestFailed in interface RequestHandler

Parameters:

cmd - the command with the request

msg - the optional error message, can be null

requestRejected

public void requestRejected(RemoteCommand cmd,
                            String msg)

Handles rejected requests.

Specified by:

requestRejected in interface RequestHandler

Parameters:

cmd - the command with the request

msg - the optional error message, can be null