Package adams.flow.sink.redisaction

Class Publish

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable
    public class Publish
extends AbstractRedisAction
    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 RedisDataType m_Type
      the data type.

      • 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
      Publish()  

    • Field Detail

      • m_Channel

        protected String m_Channel
        the name of the channel.

    • Constructor Detail

      • Publish

        public Publish()

    • 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 AbstractRedisAction
        Returns:
        null if no info available, otherwise short string

      • accepts

        public Class[] accepts()
        Returns the classes the action accepts as input.
        Specified by:
        accepts in class AbstractRedisAction
        Returns:
        the classes

      • doExecute

        protected String doExecute​(RedisConnection connection,
                           Object o)
        Performs the action on the specified object.
        Specified by:
        doExecute in class AbstractRedisAction
        Parameters:
        connection - the Redis connection
        o - the object to process
        Returns:
        null if successful, otherwise error message