Package adams.data.djl.idgenerator

Class StringExpressionID

  • 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, IDGenerator, adams.flow.core.FlowContextHandler, Serializable
    public class StringExpressionID
extends AbstractIDGenerator
    Expands any variables in the supplied string expression, evaluates it and returns the result as ID.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.parser.StringExpressionText m_ID
      the expression to use as ID.

      • 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 generate()
      Generates the ID.
      adams.parser.StringExpressionText getID()
      Gets the ID.
      String globalInfo()
      Returns a string describing the object.
      String IDTipText()
      Returns the tip text for this property.
      protected boolean requiresFlowContext()
      Returns whether flow context is required.
      void setID​(adams.parser.StringExpressionText value)
      Sets the ID.

      • 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_ID

        protected adams.parser.StringExpressionText m_ID
        the expression to use as ID.

    • Constructor Detail

      • StringExpressionID

        public StringExpressionID()
        Default constructor.

      • StringExpressionID

        public StringExpressionID​(String id)
        Initializes the generator with the specified ID.
        Parameters:
        id - the ID to use

      • StringExpressionID

        public StringExpressionID​(adams.parser.StringExpressionText id)
        Initializes the generator with the specified ID.
        Parameters:
        id - the ID to use

    • 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

      • setID

        public void setID​(adams.parser.StringExpressionText value)
        Sets the ID.
        Parameters:
        value - the ID

      • getID

        public adams.parser.StringExpressionText getID()
        Gets the ID.
        Returns:
        the ID

      • IDTipText

        public String IDTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • requiresFlowContext

        protected boolean requiresFlowContext()
        Returns whether flow context is required.
        Overrides:
        requiresFlowContext in class AbstractIDGenerator
        Returns:
        true if required

      • generate

        public String generate()
        Generates the ID.
        Returns:
        the ID