Package adams.flow.transformer.multiheatmapoperation

Class AbstractMultiHeatmapOperation<O>

  • Type Parameters:
    O - the generated output type
    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
    Direct Known Subclasses:
    Add, AddConstant, PassThrough, Subtract
    public abstract class AbstractMultiHeatmapOperation<O>
extends adams.core.option.AbstractOptionHandler
implements adams.core.QuickInfoSupporter
    Abstract base class for operations that require multiple heatmaps.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      • 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 Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void check​(Heatmap[] maps)
      Checks the heatmaps.
      protected abstract O doProcess​(Heatmap[] maps, adams.core.MessageCollection errors)
      Performs the actual processing of the heatmaps.
      abstract Class generates()
      The type of data that is generated.
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.
      abstract int maxNumSheetsRequired()
      Returns the maximum number of heatmaps that are required for the operation.
      abstract int minNumSheetsRequired()
      Returns the minimum number of heatmaps that are required for the operation.
      O process​(Heatmap[] maps, adams.core.MessageCollection errors)
      Processes the heatmaps.

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

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

    • Constructor Detail

      • AbstractMultiHeatmapOperation

        public AbstractMultiHeatmapOperation()

    • Method Detail

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Default implementation returns null.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Returns:
        null if no info available, otherwise short string

      • minNumSheetsRequired

        public abstract int minNumSheetsRequired()
        Returns the minimum number of heatmaps that are required for the operation.
        Returns:
        the number of heatmaps that are required, <= 0 means no lower limit

      • maxNumSheetsRequired

        public abstract int maxNumSheetsRequired()
        Returns the maximum number of heatmaps that are required for the operation.
        Returns:
        the number of heatmaps that are required, <= 0 means no upper limit

      • generates

        public abstract Class generates()
        The type of data that is generated.
        Returns:
        the class

      • check

        protected void check​(Heatmap[] maps)
        Checks the heatmaps.

        Default implementation only ensures that heatmaps are present.
        Parameters:
        maps - the heatmaps to check

      • doProcess

        protected abstract O doProcess​(Heatmap[] maps,
                               adams.core.MessageCollection errors)
        Performs the actual processing of the heatmaps.
        Parameters:
        maps - the heatmaps to process
        errors - for collecting errors
        Returns:
        the generated data

      • process

        public O process​(Heatmap[] maps,
                 adams.core.MessageCollection errors)
        Processes the heatmaps.
        Parameters:
        maps - the heatmaps to process
        errors - for collecting errors
        Returns:
        the generated data