Package adams.data.io.input

Class InstanceReader

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.FileFormatHandler, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.data.io.input.DataContainerReader>, adams.core.SizeOfHandler, adams.data.io.input.DataContainerReader<Instance>, adams.data.io.input.IncrementalDataContainerReader, Serializable, Comparable
    public class InstanceReader
extends adams.data.io.input.AbstractDataContainerReader<Instance>
implements adams.data.io.input.IncrementalDataContainerReader
    Reads WEKA datasets in various formats.

    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 
    -input <adams.core.io.PlaceholderFile> (property: input)
    The file to read and turn into a container.
    default: .
 
    -create-dummy-report (property: createDummyReport)
    If true, then a dummy report is created if none present.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int m_Index
      the current index.
      protected weka.core.converters.ConverterUtils.DataSource m_Source
      the data source for reading.
      protected weka.core.Instances m_Structure
      the current data structure.

      • Fields inherited from class adams.data.io.input.AbstractDataContainerReader

        m_CreateDummyReport, m_Input, m_InputIsFile, m_Processed, m_ReadData

      • 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
      InstanceReader()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getFormatDescription()
      Returns a string describing the format (used in the file chooser).
      String[] getFormatExtensions()
      Returns the extension(s) of the format.
      String globalInfo()
      Returns a string describing the object.
      boolean hasMoreData()
      Returns whether there is more data available.
      protected void readData()
      Uses the named setup to read the data.
      void reset()
      Resets the filter.

      • Methods inherited from class adams.data.io.input.AbstractDataContainerReader

        checkData, cleanUp, compareTo, createDummyReport, createDummyReportTipText, defineOptions, destroy, doRead, equals, getAdditionalInformation, getCreateDummyReport, getDefaultFormatExtension, getInput, initialize, inputTipText, isInputFile, postProcessData, read, setCreateDummyReport, setInput, shallowCopy, shallowCopy

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, 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

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_Source

        protected weka.core.converters.ConverterUtils.DataSource m_Source
        the data source for reading.

      • m_Structure

        protected weka.core.Instances m_Structure
        the current data structure.

      • m_Index

        protected int m_Index
        the current index.

    • Constructor Detail

      • InstanceReader

        public InstanceReader()

    • 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

      • getFormatDescription

        public String getFormatDescription()
        Returns a string describing the format (used in the file chooser).
        Specified by:
        getFormatDescription in interface adams.core.io.FileFormatHandler
        Specified by:
        getFormatDescription in class adams.data.io.input.AbstractDataContainerReader<Instance>
        Returns:
        a description suitable for displaying in the file chooser

      • getFormatExtensions

        public String[] getFormatExtensions()
        Returns the extension(s) of the format.
        Specified by:
        getFormatExtensions in interface adams.core.io.FileFormatHandler
        Specified by:
        getFormatExtensions in class adams.data.io.input.AbstractDataContainerReader<Instance>
        Returns:
        the extension(s) (without the dot!)

      • reset

        public void reset()
        Resets the filter.
        Overrides:
        reset in class adams.data.io.input.AbstractDataContainerReader<Instance>

      • readData

        protected void readData()
        Uses the named setup to read the data.
        Specified by:
        readData in class adams.data.io.input.AbstractDataContainerReader<Instance>

      • hasMoreData

        public boolean hasMoreData()
        Returns whether there is more data available.
        Specified by:
        hasMoreData in interface adams.data.io.input.IncrementalDataContainerReader
        Returns:
        true if there is more data available