Package adams.flow.standalone.rats.output

Class RedisPublish

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.output.AbstractRatOutput

adams.flow.standalone.rats.output.RedisPublish

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<AbstractRatOutput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, RatOutput, Serializable

public class RedisPublish
extends AbstractRatOutput

Publishes the incoming message to the specified channel.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Channel	the name of the channel.
protected RedisConnection	m_Connection	the redis connection to use.
protected RedisDataType	m_Type	the data type.

Fields inherited from class adams.flow.standalone.rats.output.AbstractRatOutput

m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_Input, m_LoggingPrefix, m_Owner, m_Stopped, m_VariablesUpdated

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

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the type of data that gets accepted.
String	channelTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doTransmit()	Performs the actual transmission.
String	getChannel()	Returns the name of the channel.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
RedisDataType	getType()	Returns the type of the data.
String	globalInfo()	Returns a string describing the object.
void	setChannel(String value)	Sets the name of the channel.
void	setType(RedisDataType value)	Sets the type of the data.
String	setUp()	Hook method for performing checks at setup time.
String	typeTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.standalone.rats.output.AbstractRatOutput

backupState, canInput, check, cleanUp, configureLogger, doWait, findVariables, getAdditionalInformation, getFullName, getOwner, getQueue, getVariables, handleException, initialize, initTransmission, input, isBackedUp, isStopped, pruneBackup, pruneBackup, restoreState, setOwner, shallowCopy, shallowCopy, stopExecution, transmit, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

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_Channel

protected String m_Channel

the name of the channel.

m_Type

protected RedisDataType m_Type

the data type.

m_Connection

protected transient RedisConnection m_Connection

the redis connection to use.

Constructor Detail

RedisPublish

public RedisPublish()

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

setChannel

public void setChannel(String value)

Sets the name of the channel.

Parameters:

value - the name

getChannel

public String getChannel()

Returns the name of the channel.

Returns:

the name

channelTipText

public String channelTipText()

Returns the tip text for this property.

Returns:

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

setType

public void setType(RedisDataType value)

Sets the type of the data.

Parameters:

value - the type

getType

public RedisDataType getType()

Returns the type of the data.

Returns:

the type

typeTipText

public String typeTipText()

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 AbstractRatOutput

Returns:

null if no info available, otherwise short string

accepts

public Class[] accepts()

Returns the type of data that gets accepted.

Specified by:

accepts in interface RatOutput

Specified by:

accepts in class AbstractRatOutput

Returns:

the type of data

setUp

public String setUp()

Hook method for performing checks at setup time.

Specified by:

setUp in interface RatOutput

Overrides:

setUp in class AbstractRatOutput

Returns:

null if successful, otherwise error message

doTransmit

protected String doTransmit()

Performs the actual transmission.

Specified by:

doTransmit in class AbstractRatOutput

Returns:

null if successful, otherwise error message