Package adams.gui.core.spreadsheettable

Class Histogram

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.core.spreadsheettable.Histogram

All Implemented Interfaces:

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

public class Histogram
extends AbstractOptionHandler
implements PlotColumn, PlotRow

Allows to generate a histogram from a column or row.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_COLUMNS
static String	KEY_HISTOGRAM

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

Method Summary

Modifier and Type	Method	Description
int	compareTo(SpreadSheetTablePopupMenuItem o)	For sorting the menu items.
String	getIconName()	Returns the name of the icon.
String	getMenuItem()	Returns the name for the menu item.
String	globalInfo()	Returns a string describing the object.
boolean	handlesRowRange(TableRowRange range)	Checks whether the row range can be handled.
protected void	plot(SpreadSheetTablePopupMenuItemHelper.TableState state, boolean isColumn)	Allows the user to generate a plot from either a row or a column.
boolean	plotColumn(SpreadSheetTablePopupMenuItemHelper.TableState state)	Plots the specified column.
boolean	plotRow(SpreadSheetTablePopupMenuItemHelper.TableState state)	Plots the specified row.
protected Properties	promptParameters(SpreadSheetTable table, boolean isColumn)	Prompts the user to configure the parameters.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

Field Detail

KEY_COLUMNS

public static final String KEY_COLUMNS

See Also:

Constant Field Values

KEY_HISTOGRAM

public static final String KEY_HISTOGRAM

See Also:

Constant Field Values

Constructor Detail

Histogram

public Histogram()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getMenuItem

public String getMenuItem()

Returns the name for the menu item.

Specified by:

getMenuItem in interface SpreadSheetTablePopupMenuItem

Returns:

the name

getIconName

public String getIconName()

Returns the name of the icon.

Specified by:

getIconName in interface SpreadSheetTablePopupMenuItem

Returns:

the name, null if none available

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

handlesRowRange

public boolean handlesRowRange(TableRowRange range)

Checks whether the row range can be handled.

Specified by:

handlesRowRange in interface TableRowRangeCheck

Parameters:

range - the range to check

Returns:

true if handled

promptParameters

protected Properties promptParameters(SpreadSheetTable table,
                                      boolean isColumn)

Prompts the user to configure the parameters.

Parameters:

table - the table to do this for

isColumn - whether column or row(s)

Returns:

the parameters, null if cancelled

plot

protected void plot(SpreadSheetTablePopupMenuItemHelper.TableState state,
                    boolean isColumn)

Allows the user to generate a plot from either a row or a column.

Parameters:

state - the table state

isColumn - whether the to use column or row

plotColumn

public boolean plotColumn(SpreadSheetTablePopupMenuItemHelper.TableState state)

Plots the specified column.

Specified by:

plotColumn in interface PlotColumn

Parameters:

state - the table state

Returns:

true if successful

plotRow

public boolean plotRow(SpreadSheetTablePopupMenuItemHelper.TableState state)

Plots the specified row.

Specified by:

plotRow in interface PlotRow

Parameters:

state - the table state

Returns:

true if successful