AbstractCurrentHeatmapFilter (adams-addons-pom 25.11.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.gui.plugin.AbstractToolPlugin<HeatmapPanel>
  - - adams.gui.visualization.heatmap.plugins.AbstractHeatmapViewerPlugin
    - - adams.gui.visualization.heatmap.plugins.AbstractCurrentHeatmapFilter

All Implemented Interfaces:

adams.core.logging.LoggingSupporter, adams.core.SizeOfHandler, Serializable

Direct Known Subclasses:

AbstractCurrentHeatmapFilterWithGOE
```
public abstract class AbstractCurrentHeatmapFilter
extends AbstractHeatmapViewerPlugin
```
Ancestor for plugins that filter the current heatmap.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected String m_FilterError
for storing filtering errors.
- Fields inherited from class adams.gui.plugin.AbstractToolPlugin
  m_CanceledByUser, m_CurrentPanel, m_LastSetup
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

AbstractCurrentHeatmapFilter()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canExecute(HeatmapPanel panel)`	Checks whether the plugin can be executed given the specified heatmap panel.
`protected String`	`doExecute()`	Executes the plugin.
`protected abstract Heatmap`	`filter(Heatmap heatmap)`	Filters the heatmap.

Methods inherited from class adams.gui.visualization.heatmap.plugins.AbstractHeatmapViewerPlugin
doLog

Methods inherited from class adams.gui.plugin.AbstractToolPlugin
createLogEntry, execute, getCanceledByUser, getCaption, getIcon, getIconName, getLastSetup, getMenu, hasLastSetup, log, setLastSetup

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - m_FilterError
```
protected String m_FilterError
```
    for storing filtering errors.
- Constructor Detail
  - AbstractCurrentHeatmapFilter
```
public AbstractCurrentHeatmapFilter()
```
- Method Detail
  - canExecute
```
public boolean canExecute(HeatmapPanel panel)
```
    Checks whether the plugin can be executed given the specified heatmap panel.
    
    Panel must be non-null and must contain an heatmap.
    
    Specified by:
    
    canExecute in class adams.gui.plugin.AbstractToolPlugin<HeatmapPanel>
    
    Parameters:
    
    panel - the panel to use as basis for decision
    
    Returns:
    
    true if plugin can be executed
  - filter
```
protected abstract Heatmap filter(Heatmap heatmap)
```
    Filters the heatmap.
    
    Parameters:
    
    heatmap - the heatmap to filter
    
    Returns:
    
    the processed heatmap
  - doExecute
```
protected String doExecute()
```
    Executes the plugin.
    
    Specified by:
    
    doExecute in class adams.gui.plugin.AbstractToolPlugin<HeatmapPanel>
    
    Returns:
    
    null if OK, otherwise error message