Package adams.flow.standalone.rats.log

Class SimpleStringGenerator

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    public class SimpleStringGenerator
extends AbstractLogObjectGenerator<String>
    Generates a simple string from actor path, type and message.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_ErrorKey
      the key to use for the error.

      • 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 Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      String errorKeyTipText()
      Returns the tip text for this property.
      String generate​(Rat rat, adams.flow.core.Actor source, String type, String msg)
      Handles the given error message.
      String getErrorKey()
      Returns the key to use for the error in the message.
      String globalInfo()
      Returns a string describing the object.
      void setErrorKey​(String value)
      Sets the key to use for the error in the message.

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

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

    • Field Detail

      • m_ErrorKey

        protected String m_ErrorKey
        the key to use for the error.

    • Constructor Detail

      • SimpleStringGenerator

        public SimpleStringGenerator()

    • 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

      • setErrorKey

        public void setErrorKey​(String value)
        Sets the key to use for the error in the message.
        Parameters:
        value - the key

      • getErrorKey

        public String getErrorKey()
        Returns the key to use for the error in the message.
        Returns:
        the key

      • errorKeyTipText

        public String errorKeyTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • generate

        public String generate​(Rat rat,
                       adams.flow.core.Actor source,
                       String type,
                       String msg)
        Handles the given error message.
        Specified by:
        generate in class AbstractLogObjectGenerator<String>
        Parameters:
        rat - the rat that captured this error
        source - the source of the error
        type - the type of error
        msg - the error message to log
        Returns:
        the generated string