Package adams.flow.transformer.generatefilebaseddataset

Class TensorFlowFileLists

  • 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, Serializable
    public class TensorFlowFileLists
extends adams.flow.transformer.generatefilebaseddataset.AbstractFileBasedDatasetGeneration<String[]>
    Generates simple file lists in the specified directory.
    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 directory for the lists.
      protected adams.core.base.BaseString[] m_Values
      the values in the container 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected String check​(adams.flow.container.FileBasedDatasetContainer cont)
      Performs checks on the container.
      void defineOptions()
      Adds options to the internal list of options.
      protected String[] doGenerate​(adams.flow.container.FileBasedDatasetContainer cont)
      Generates the dataset.
      Class generates()
      Returns the class that gets generated.
      adams.core.io.PlaceholderDirectory getOutputDir()
      Returns the output directory.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      adams.core.base.BaseString[] getValues()
      Returns the name(s) of the container value(s) to save.
      String globalInfo()
      Returns a string describing the object.
      String outputDirTipText()
      Returns the tip text for this property.
      protected String[] requiredValues()
      The keys of the values that need to be present in the container.
      void setOutputDir​(adams.core.io.PlaceholderDirectory value)
      Sets the output directory.
      void setValues​(adams.core.base.BaseString[] value)
      Sets the name(s) of the container value(s) to save.
      String valueTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.flow.transformer.generatefilebaseddataset.AbstractFileBasedDatasetGeneration

        generate

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

        protected adams.core.base.BaseString[] m_Values
        the values in the container to use.

      • m_OutputDir

        protected adams.core.io.PlaceholderDirectory m_OutputDir
        the output directory for the lists.

    • Constructor Detail

      • TensorFlowFileLists

        public TensorFlowFileLists()

    • 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

      • setValues

        public void setValues​(adams.core.base.BaseString[] value)
        Sets the name(s) of the container value(s) to save.
        Parameters:
        value - the value(s)

      • getValues

        public adams.core.base.BaseString[] getValues()
        Returns the name(s) of the container value(s) to save.
        Returns:
        the value(s)

      • valueTipText

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

      • setOutputDir

        public void setOutputDir​(adams.core.io.PlaceholderDirectory value)
        Sets the output directory.
        Parameters:
        value - the dir

      • getOutputDir

        public adams.core.io.PlaceholderDirectory getOutputDir()
        Returns the output directory.
        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 GUI or for listing the options.

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.transformer.generatefilebaseddataset.AbstractFileBasedDatasetGeneration<String[]>
        Returns:
        null if no info available, otherwise short string

      • generates

        public Class generates()
        Returns the class that gets generated.
        Specified by:
        generates in class adams.flow.transformer.generatefilebaseddataset.AbstractFileBasedDatasetGeneration<String[]>
        Returns:
        the generated class

      • requiredValues

        protected String[] requiredValues()
        The keys of the values that need to be present in the container.
        Specified by:
        requiredValues in class adams.flow.transformer.generatefilebaseddataset.AbstractFileBasedDatasetGeneration<String[]>
        Returns:
        the keys

      • check

        protected String check​(adams.flow.container.FileBasedDatasetContainer cont)
        Performs checks on the container.
        Overrides:
        check in class adams.flow.transformer.generatefilebaseddataset.AbstractFileBasedDatasetGeneration<String[]>
        Parameters:
        cont - the container to check
        Returns:
        null if successful, otherwise error message

      • doGenerate

        protected String[] doGenerate​(adams.flow.container.FileBasedDatasetContainer cont)
        Generates the dataset.
        Specified by:
        doGenerate in class adams.flow.transformer.generatefilebaseddataset.AbstractFileBasedDatasetGeneration<String[]>
        Parameters:
        cont - the container to use
        Returns:
        the generated output