Package adams.gui.core.spreadsheettable

Class AbstractPlotColumn

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.core.spreadsheettable.AbstractPlotColumn

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, PlotColumn, SpreadSheetTablePopupMenuItem, TableRowRangeCheck, Serializable, Comparable<SpreadSheetTablePopupMenuItem>

public abstract class AbstractPlotColumn
extends AbstractOptionHandler
implements PlotColumn

Ancestor for plugins that plot a column.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractPlotColumn()

Method Summary

Modifier and Type	Method	Description
protected String	check(SpreadSheetTable table, SpreadSheet sheet, int column)	Hook method for checks before attempting the plot.
int	compareTo(SpreadSheetTablePopupMenuItem o)	For sorting the menu items.
protected abstract boolean	doPlotColumn(SpreadSheetTable table, SpreadSheet sheet, int column)	Plots the specified column.
String	getIconName()	Returns the name of the icon.
boolean	plotColumn(SpreadSheetTable table, SpreadSheet sheet, int column)	Plots the specified column.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.gui.core.spreadsheettable.PlotColumn

plotColumn

Methods inherited from interface adams.gui.core.spreadsheettable.SpreadSheetTablePopupMenuItem

getMenuItem

Methods inherited from interface adams.gui.core.spreadsheettable.TableRowRangeCheck

handlesRowRange

Constructor Detail

AbstractPlotColumn

public AbstractPlotColumn()

Method Detail

compareTo

public int compareTo(SpreadSheetTablePopupMenuItem o)

For sorting the menu items.

Specified by:

compareTo in interface Comparable<SpreadSheetTablePopupMenuItem>

Parameters:

o - the other item

Returns:

-1 if less than, 0 if equal, +1 if larger than this menu item name

getIconName

public String getIconName()

Returns the name of the icon.

Specified by:

getIconName in interface SpreadSheetTablePopupMenuItem

Returns:

the name, null if none available

check

protected String check(SpreadSheetTable table,
                       SpreadSheet sheet,
                       int column)

Hook method for checks before attempting the plot.

Parameters:

table - the source table

sheet - the spreadsheet to use as basis

column - the column in the spreadsheet

Returns:

null if passed, otherwise error message

doPlotColumn

protected abstract boolean doPlotColumn(SpreadSheetTable table,
                                        SpreadSheet sheet,
                                        int column)

Plots the specified column.

Parameters:

table - the source table

sheet - the spreadsheet to use as basis

column - the column in the spreadsheet

Returns:

true if successful

plotColumn

public boolean plotColumn(SpreadSheetTable table,
                          SpreadSheet sheet,
                          int column)

Plots the specified column.

Parameters:

table - the source table

sheet - the spreadsheet to use as basis

column - the column in the spreadsheet

Returns:

true if successful