Package adams.data.djl.idgenerator

Class VariableID

  • 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 VariableID
extends AbstractIDGenerator
    Expands any variables in the supplied string and returns that 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.core.base.BaseString m_ID
      the text 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

    • Constructor Summary

      Constructors 
      Constructor Description
      VariableID()
      Default constructor.
      VariableID​(adams.core.base.BaseString id)
      Initializes the generator with the specified ID.
      VariableID​(String id)
      Initializes the generator with the specified ID.

    • Field Detail

      • m_ID

        protected adams.core.base.BaseString m_ID
        the text to use as ID.

    • Constructor Detail

      • VariableID

        public VariableID()
        Default constructor.

      • VariableID

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

      • VariableID

        public VariableID​(adams.core.base.BaseString 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.core.base.BaseString value)
        Sets the ID.
        Parameters:
        value - the ID

      • getID

        public adams.core.base.BaseString 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