Package adams.gui.visualization.trail.plugins

Class AbstractTrailViewerPluginWithGOE

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.plugin.AbstractToolPlugin<TrailPanel>

adams.gui.visualization.trail.plugins.AbstractTrailViewerPlugin

adams.gui.visualization.trail.plugins.AbstractTrailViewerPluginWithGOE

All Implemented Interfaces:

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

public abstract class AbstractTrailViewerPluginWithGOE
extends AbstractTrailViewerPlugin

Ancestor for plugins that require a GOE.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected String	doExecute()	Executes the plugin.
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.
protected abstract String	process()	Processes the trail.

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

doLog

Methods inherited from class adams.gui.plugin.AbstractToolPlugin

canExecute, 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

AbstractTrailViewerPluginWithGOE

public AbstractTrailViewerPluginWithGOE()

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

process

protected abstract String process()

Processes the trail.

doExecute

protected String doExecute()

Executes the plugin.

Specified by:

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

Returns:

null if OK, otherwise error message. Using an empty string will suppress the error message display and the creation of a log entry.