Package adams.data.djl.outputdirgenerator

Class FixedDir

  • 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 FixedDir
extends AbstractOutputDirGenerator
    Uses the user-supplied output dir.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.io.PlaceholderDirectory m_OutputDir
      the output dir to use.

      • 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
      FixedDir()
      Default constructor.
      FixedDir​(adams.core.io.PlaceholderDirectory dir)
      Instantiates the generator and sets the dir to use.
      FixedDir​(String dir)
      Instantiates the generator and sets the dir to use.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      adams.core.io.PlaceholderDirectory generate()
      Generates the output directory.
      adams.core.io.PlaceholderDirectory getOutputDir()
      Gets the output dir.
      String globalInfo()
      Returns a string describing the object.
      String outputDirTipText()
      Returns the tip text for this property.
      void setOutputDir​(adams.core.io.PlaceholderDirectory value)
      Sets the output dir.

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

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

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

        setLoggingLevel

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

        protected adams.core.io.PlaceholderDirectory m_OutputDir
        the output dir to use.

    • Constructor Detail

      • FixedDir

        public FixedDir()
        Default constructor.

      • FixedDir

        public FixedDir​(String dir)
        Instantiates the generator and sets the dir to use.
        Parameters:
        dir - the dir to use

      • FixedDir

        public FixedDir​(adams.core.io.PlaceholderDirectory dir)
        Instantiates the generator and sets the dir to use.
        Parameters:
        dir - the dir 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.core.io.PlaceholderDirectory value)
        Sets the output dir.
        Parameters:
        value - the dir

      • getOutputDir

        public adams.core.io.PlaceholderDirectory 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