Package adams.flow.source.redisaction

Class Get

  • 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 Get
extends AbstractRedisAction
    Retrieves the object stored under the specified key.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_Key
      the key of the object to get.
      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
      Get()  

    • Field Detail

      • m_Key

        protected String m_Key
        the key of the object to get.

    • Constructor Detail

      • Get

        public Get()

    • 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

      • setKey

        public void setKey​(String value)
        Sets the name of the Key.
        Parameters:
        value - the name

      • getKey

        public String getKey()
        Returns the name of the Key.
        Returns:
        the name

      • keyTipText

        public String keyTipText()
        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

      • generates

        public Class generates()
        Returns the classes the action generates as output.
        Specified by:
        generates in class AbstractRedisAction
        Returns:
        the classes

      • doExecute

        protected Object doExecute​(RedisConnection connection,
                           adams.core.MessageCollection errors)
        Performs the action.
        Specified by:
        doExecute in class AbstractRedisAction
        Parameters:
        connection - the Redis connection
        errors - for collecting errors
        Returns:
        the generated object