Package adams.data.djl.outputdirgenerator

Class StringExpressionDir

  • 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, OutputDirGenerator, adams.flow.core.FlowContextHandler, Serializable
    public class StringExpressionDir
extends AbstractOutputDirGenerator
    Expands any variables in the supplied string expression, evaluates it and returns the result as directory.
    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_OutputDir
      the expression to use as dir.

      • 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
      StringExpressionDir()
      Default constructor.
      StringExpressionDir​(adams.parser.StringExpressionText exp)
      Instantiates the generator and sets the expression to use.
      StringExpressionDir​(String exp)
      Instantiates the generator and sets the expression to use.

    • Field Detail

      • m_OutputDir

        protected adams.parser.StringExpressionText m_OutputDir
        the expression to use as dir.

    • Constructor Detail

      • StringExpressionDir

        public StringExpressionDir()
        Default constructor.

      • StringExpressionDir

        public StringExpressionDir​(String exp)
        Instantiates the generator and sets the expression to use.
        Parameters:
        exp - the expression to use

      • StringExpressionDir

        public StringExpressionDir​(adams.parser.StringExpressionText exp)
        Instantiates the generator and sets the expression to use.
        Parameters:
        exp - the expression 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

      • setOutputDir

        public void setOutputDir​(adams.parser.StringExpressionText value)
        Sets the output dir.
        Parameters:
        value - the dir

      • getOutputDir

        public adams.parser.StringExpressionText getOutputDir()
        Gets the output dir.
        Returns:
        the dir

      • outputDirTipText

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

      • generate

        public adams.core.io.PlaceholderDirectory generate()
        Generates the output directory.
        Returns:
        the directory