Package adams.gui.visualization.trail.plugins

Class AbstractSelectedTrailsFilter

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.plugin.AbstractToolPlugin<TrailPanel>

adams.gui.visualization.trail.plugins.AbstractTrailViewerPlugin

adams.gui.visualization.trail.plugins.AbstractSelectedTrailsViewerPlugin

adams.gui.visualization.trail.plugins.AbstractSelectedTrailsFilter

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSelectedTrailsFilterWithGOE

public abstract class AbstractSelectedTrailsFilter
extends AbstractSelectedTrailsViewerPlugin

Ancestor for plugins that filter the selected trails.

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 String	m_FilterError	for storing filtering errors.

Fields inherited from class adams.gui.visualization.trail.plugins.AbstractSelectedTrailsViewerPlugin

m_SelectedPanels

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

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(TrailPanel panel)	Checks whether the plugin can be executed given the specified trail panel.
protected abstract Trail	filter(Trail trail)	Filters the trail.
protected String	process(TrailPanel panel)	Processes the panel.

Methods inherited from class adams.gui.visualization.trail.plugins.AbstractSelectedTrailsViewerPlugin

createConfigurationPanel, createDialog, createListPanel, doExecute, getAllPanels, getDialogSize, hasApprovalButton, hasCancelButton, process, processFinish, processInit

Methods inherited from class adams.gui.visualization.trail.plugins.AbstractTrailViewerPlugin

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

AbstractSelectedTrailsFilter

public AbstractSelectedTrailsFilter()

Method Detail

canExecute

public boolean canExecute(TrailPanel panel)

Checks whether the plugin can be executed given the specified trail panel.

Panel must be non-null and must contain an trail.

Overrides:

canExecute in class AbstractSelectedTrailsViewerPlugin

Parameters:

panel - the panel to use as basis for decision

Returns:

true if plugin can be executed

filter

protected abstract Trail filter(Trail trail)

Filters the trail.

Parameters:

trail - the trail to filter

Returns:

the processed trail

process

protected String process(TrailPanel panel)

Processes the panel.

Specified by:

process in class AbstractSelectedTrailsViewerPlugin

Parameters:

panel - the panel to process

Returns:

null if OK, otherwise error message