Package adams.flow.source.redisaction

Class AbstractRedisAction

  • 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
    Direct Known Subclasses:
    Get, Null
    public abstract class AbstractRedisAction
extends adams.core.option.AbstractOptionHandler
implements adams.core.QuickInfoSupporter
    Ancestor for Redis source actions.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      String check​(RedisConnection connection)
      For checking the state before executing the action.
      protected abstract Object doExecute​(RedisConnection connection, adams.core.MessageCollection errors)
      Performs the action.
      Object execute​(RedisConnection connection, adams.core.MessageCollection errors)
      Performs the action on the specified object.
      abstract Class generates()
      Returns the classes the action generates as output.
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Constructor Detail

      • AbstractRedisAction

        public AbstractRedisAction()

    • Method Detail

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.

        Default implementation returns null.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Returns:
        null if no info available, otherwise short string

      • generates

        public abstract Class generates()
        Returns the classes the action generates as output.
        Returns:
        the classes

      • check

        public String check​(RedisConnection connection)
        For checking the state before executing the action.
        Parameters:
        connection - the Redis connection
        Returns:
        null if successful, otherwise error message

      • doExecute

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

      • execute

        public Object execute​(RedisConnection connection,
                      adams.core.MessageCollection errors)
        Performs the action on the specified object.
        Parameters:
        connection - the Redis connection
        errors - for collecting errors
        Returns:
        the generated object