Package adams.data.io.input

Class AbstractHeatmapReader

  • 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<Heatmap>, Serializable, Comparable
    Direct Known Subclasses:
    FloatMatrixHeatmapReader, SimpleHeatmapReader, SimpleImageHeatmapReader, SpreadSheetHeatmapReader
    public abstract class AbstractHeatmapReader
extends adams.data.io.input.AbstractDataContainerReader<Heatmap>
    Ancestor for readers that read heatmaps.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_UseAbsoluteSource
      whether to use absolute filename for the source report field or just the file's name.

      • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected boolean getDefaultUseAbsoluteSource()
      Returns the default for using absolute source filename.
      static String[] getReaders()
      Returns a list with classnames of readers.
      boolean getUseAbsoluteSource()
      Returns whether to use absolute source filename rather than just name.
      protected void postProcessData()
      For performing post-processing.
      void setUseAbsoluteSource​(boolean value)
      Sets whether to use absolute source filename rather than just name.
      String useAbsoluteSourceTipText()
      Returns the tip text for this property.

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

        checkData, cleanUp, compareTo, createDummyReport, createDummyReportTipText, destroy, doRead, equals, getAdditionalInformation, getCreateDummyReport, getDefaultFormatExtension, getFormatDescription, getFormatExtensions, getInput, initialize, inputTipText, isInputFile, read, readData, reset, setCreateDummyReport, setInput, shallowCopy, shallowCopy

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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_UseAbsoluteSource

        protected boolean m_UseAbsoluteSource
        whether to use absolute filename for the source report field or just the file's name.

    • Constructor Detail

      • AbstractHeatmapReader

        public AbstractHeatmapReader()

    • Method Detail

      • 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.data.io.input.AbstractDataContainerReader<Heatmap>

      • getDefaultUseAbsoluteSource

        protected boolean getDefaultUseAbsoluteSource()
        Returns the default for using absolute source filename.
        Returns:
        the default

      • setUseAbsoluteSource

        public void setUseAbsoluteSource​(boolean value)
        Sets whether to use absolute source filename rather than just name.
        Parameters:
        value - true if to use absolute source

      • getUseAbsoluteSource

        public boolean getUseAbsoluteSource()
        Returns whether to use absolute source filename rather than just name.
        Returns:
        true if to use absolute source

      • useAbsoluteSourceTipText

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

      • postProcessData

        protected void postProcessData()
        For performing post-processing.
        Overrides:
        postProcessData in class adams.data.io.input.AbstractDataContainerReader<Heatmap>

      • getReaders

        public static String[] getReaders()
        Returns a list with classnames of readers.
        Returns:
        the reader classnames