Package adams.data.io.output

Class AbstractHeatmapWriter

  • 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.output.AbstractDataContainerWriter>, adams.core.SizeOfHandler, Serializable, Comparable
    Direct Known Subclasses:
    FloatMatrixHeatmapWriter, SimpleHeatmapWriter, SimpleImageHeatmapWriter, SpreadSheetHeatmapWriter
    public abstract class AbstractHeatmapWriter
extends adams.data.io.output.AbstractDataContainerWriter<Heatmap>
    Ancestor for writers that output heatmaps.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class adams.data.io.output.AbstractDataContainerWriter

        m_Output, m_OutputIsFile

      • 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
      boolean canWriteMultiple()
      Returns whether writing of multiple containers is supported.
      protected void checkData​(List<Heatmap> data)
      The default implementation only checks whether the provided file is an actual file and whether it exists (if m_OutputIsFile is TRUE).
      static String[] getWriters()
      Returns a list with classnames of writers.

      • Methods inherited from class adams.data.io.output.AbstractDataContainerWriter

        cleanUp, compareTo, defineOptions, destroy, equals, forCommandLine, forName, getAdditionalInformation, getDefaultFormatExtension, getFormatDescription, getFormatExtensions, getOutput, isOutputFile, outputTipText, reset, setOutput, shallowCopy, shallowCopy, write, write, writeData

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

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

    • Constructor Detail

      • AbstractHeatmapWriter

        public AbstractHeatmapWriter()

    • Method Detail

      • canWriteMultiple

        public boolean canWriteMultiple()
        Returns whether writing of multiple containers is supported.
        Specified by:
        canWriteMultiple in class adams.data.io.output.AbstractDataContainerWriter<Heatmap>
        Returns:
        true if multiple containers are supported

      • checkData

        protected void checkData​(List<Heatmap> data)
        The default implementation only checks whether the provided file is an actual file and whether it exists (if m_OutputIsFile is TRUE). Otherwise the directory has to exist.
        Overrides:
        checkData in class adams.data.io.output.AbstractDataContainerWriter<Heatmap>
        Parameters:
        data - the data to write

      • getWriters

        public static String[] getWriters()
        Returns a list with classnames of writers.
        Returns:
        the writer classnames