Package adams.flow.standalone.rats.input

Class RedisAction

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.input.AbstractRatInput

adams.flow.standalone.rats.input.RedisAction

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatInput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, RatInput, Serializable

public class RedisAction
extends AbstractRatInput

Executes the specified Redis action.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractRedisAction	m_Action	the name of the action.
protected RedisConnection	m_Connection	the redis connection to use.
protected Object	m_Data	the received data.

Fields inherited from class adams.flow.standalone.rats.input.AbstractRatInput

m_LoggingPrefix, m_Owner, m_ReceptionInterrupted, m_ReceptionRunning, m_Stopped

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

Method Summary

Modifier and Type	Method	Description
String	actionTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doReceive()	Performs the actual reception of data.
Class	generates()	Returns the type of data this scheme generates.
AbstractRedisAction	getAction()	Returns the name of the action.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
boolean	hasPendingOutput()	Checks whether any output can be collected.
Object	output()	Returns the received data.
void	setAction(AbstractRedisAction value)	Sets the name of the action.
String	setUp()	Hook method for performing checks at setup time.

Methods inherited from class adams.flow.standalone.rats.input.AbstractRatInput

canReceive, check, cleanUp, configureLogger, doWait, getAdditionalInformation, getFullName, getOwner, getQueue, getReceptionInterrupted, handleException, initialize, initReception, interruptReception, isReceptionRunning, isStopped, receive, setOwner, shallowCopy, shallowCopy, stopExecution, updatePrefix

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

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_Action

protected AbstractRedisAction m_Action

the name of the action.

m_Connection

protected transient RedisConnection m_Connection

the redis connection to use.

m_Data

protected transient Object m_Data

the received data.

Constructor Detail

RedisAction

public RedisAction()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setAction

public void setAction(AbstractRedisAction value)

Sets the name of the action.

Parameters:

value - the name

getAction

public AbstractRedisAction getAction()

Returns the name of the action.

Returns:

the name

actionTipText

public String actionTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractRatInput

Returns:

null if no info available, otherwise short string

generates

public Class generates()

Returns the type of data this scheme generates.

Specified by:

generates in interface RatInput

Specified by:

generates in class AbstractRatInput

Returns:

the type of data

setUp

public String setUp()

Hook method for performing checks at setup time.

Specified by:

setUp in interface RatInput

Overrides:

setUp in class AbstractRatInput

Returns:

null if successful, otherwise error message

doReceive

protected String doReceive()

Performs the actual reception of data.

Specified by:

doReceive in class AbstractRatInput

Returns:

null if successful, otherwise error message

hasPendingOutput

public boolean hasPendingOutput()

Checks whether any output can be collected.

Specified by:

hasPendingOutput in interface RatInput

Specified by:

hasPendingOutput in class AbstractRatInput

Returns:

true if output available

output

public Object output()

Returns the received data.

Specified by:

output in interface RatInput

Specified by:

output in class AbstractRatInput

Returns:

the data