AbstractCurrentHeatmapFilterWithGOE (adams-addons-pom 24.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
      - adams.gui.visualization.heatmap.plugins.AbstractCurrentHeatmapFilterWithGOE

All Implemented Interfaces:

adams.core.logging.LoggingSupporter, adams.core.SizeOfHandler, Serializable
```
public abstract class AbstractCurrentHeatmapFilterWithGOE
extends AbstractCurrentHeatmapFilter
```
Ancestor for heatmap filters that process the current heatmap with a setup obtained from a GenericObjectEditorDialog.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.gui.visualization.heatmap.plugins.AbstractCurrentHeatmapFilter
  m_FilterError
- 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

AbstractCurrentHeatmapFilterWithGOE()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract Heatmap`	`doFilter(Heatmap heatmap)`	Performs the actual filtering of the heatmap.
`protected Heatmap`	`filter(Heatmap heatmap)`	Filters the heatmap.
`protected boolean`	`getCanChangeClassInDialog()`	Returns whether the class can be changed in the GOE.
`protected abstract Object`	`getDefaultValue()`	Returns the default object to use in the GOE if no last setup is yet available.
`protected abstract Class`	`getEditorType()`	Returns the class to use as type (= superclass) in the GOE.

Methods inherited from class adams.gui.visualization.heatmap.plugins.AbstractCurrentHeatmapFilter
canExecute, doExecute

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

- Constructor Detail
  - AbstractCurrentHeatmapFilterWithGOE
```
public AbstractCurrentHeatmapFilterWithGOE()
```
- Method Detail
  - getEditorType
```
protected abstract Class getEditorType()
```
    Returns the class to use as type (= superclass) in the GOE.
    
    Returns:
    
    the class
  - getDefaultValue
```
protected abstract Object getDefaultValue()
```
    Returns the default object to use in the GOE if no last setup is yet available.
    
    Returns:
    
    the object
  - getCanChangeClassInDialog
```
protected boolean getCanChangeClassInDialog()
```
    Returns whether the class can be changed in the GOE.
    
    Returns:
    
    true if class can be changed by the user
  - doFilter
```
protected abstract Heatmap doFilter(Heatmap heatmap)
```
    Performs the actual filtering of the heatmap.
    
    Parameters:
    
    heatmap - the heatmap to filter
    
    Returns:
    
    the processed heatmap
  - filter
```
protected Heatmap filter(Heatmap heatmap)
```
    Filters the heatmap.
    
    Specified by:
    
    filter in class AbstractCurrentHeatmapFilter
    
    Parameters:
    
    heatmap - the heatmap to filter
    
    Returns:
    
    the processed heatmap