Package adams.gui.visualization.heatmap.plugins

Class AbstractSelectedHeatmapsViewerPlugin

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.plugin.AbstractToolPlugin<HeatmapPanel>

adams.gui.visualization.heatmap.plugins.AbstractHeatmapViewerPlugin

adams.gui.visualization.heatmap.plugins.AbstractSelectedHeatmapsViewerPlugin

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSelectedHeatmapsFilter, AbstractSelectedHeatmapsViewerPluginWithGOE, Notes, SpreadSheetView, Statistics

public abstract class AbstractSelectedHeatmapsViewerPlugin
extends AbstractHeatmapViewerPlugin

Ancestor for plugins that work on selected heatmaps.

Version:

$Revision: 7171 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected HeatmapPanel[]	m_SelectedPanels	for panels to work on.

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
AbstractSelectedHeatmapsViewerPlugin()

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(HeatmapPanel panel)	Checks whether the plugin can be executed given the specified heatmap panel.
protected abstract JPanel	createConfigurationPanel(adams.gui.dialog.ApprovalDialog dialog)	Creates the panel with the configuration (return null to suppress display).
protected adams.gui.dialog.ApprovalDialog	createDialog()	Creates the dialog to display.
protected JPanel	createListPanel(adams.gui.dialog.ApprovalDialog dialog)	Creates the panel containing the list of all heatmaps.
protected String	doExecute()	Executes the plugin.
protected HeatmapPanel[]	getAllPanels()	Returns all the available panels in the heatmap viewer.
protected Dimension	getDialogSize()	Returns the size of the dialog.
protected boolean	hasApprovalButton()	Returns whether the dialog has an approval button.
protected boolean	hasCancelButton()	Returns whether the dialog has a cancel button.
protected String	process()	Processes all the selected panels.
protected abstract String	process(HeatmapPanel panel)	Processes the specified panel.
protected String	processFinish()	Finishes up the processing.
protected String	processInit()	Initializes the processing.

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_SelectedPanels

protected HeatmapPanel[] m_SelectedPanels

for panels to work on.

Constructor Detail

AbstractSelectedHeatmapsViewerPlugin

public AbstractSelectedHeatmapsViewerPlugin()

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

getAllPanels

protected HeatmapPanel[] getAllPanels()

Returns all the available panels in the heatmap viewer.

Returns:

the available panels

createListPanel

protected JPanel createListPanel(adams.gui.dialog.ApprovalDialog dialog)

Creates the panel containing the list of all heatmaps. Also updates the m_SelectedPanels property.

Parameters:

dialog - the dialog that is being created

Returns:

the generated panel

createConfigurationPanel

protected abstract JPanel createConfigurationPanel(adams.gui.dialog.ApprovalDialog dialog)

Creates the panel with the configuration (return null to suppress display).

Parameters:

dialog - the dialog that is being created

Returns:

the generated panel, null to suppress

getDialogSize

protected Dimension getDialogSize()

Returns the size of the dialog.

Returns:

the size

hasApprovalButton

protected boolean hasApprovalButton()

Returns whether the dialog has an approval button.

Returns:

true if approval button visible

hasCancelButton

protected boolean hasCancelButton()

Returns whether the dialog has a cancel button.

Returns:

true if cancel button visible

createDialog

protected adams.gui.dialog.ApprovalDialog createDialog()

Creates the dialog to display.

Returns:

the dialog

processInit

protected String processInit()

Initializes the processing.

Default implementation returns null.

Returns:

null if successful, otherwise error message

process

protected abstract String process(HeatmapPanel panel)

Processes the specified panel.

Parameters:

panel - the panel to process

Returns:

null if successful, error message otherwise

processFinish

protected String processFinish()

Finishes up the processing.

Default implementation returns null.

Returns:

null if successful, otherwise error message

process

protected String process()

Processes all the selected panels.

Returns:

null if successful, otherwise error message

doExecute

protected String doExecute()

Executes the plugin.

Specified by:

doExecute in class adams.gui.plugin.AbstractToolPlugin<HeatmapPanel>

Returns:

null if OK, otherwise error message