Package adams.gui.core.spreadsheettable

Class AbstractProcessColumn

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.core.spreadsheettable.AbstractProcessColumn

All Implemented Interfaces:

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

Direct Known Subclasses:

ChangeColumnType, ColumnStatistic, DataSort, UniqueValues

public abstract class AbstractProcessColumn
extends AbstractOptionHandler
implements ProcessColumn

Ancestor for plugins that process a column.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(SpreadSheetTablePopupMenuItemHelper.TableState state)	Hook method for checks before attempting processing.
int	compareTo(SpreadSheetTablePopupMenuItem o)	For sorting the menu items.
abstract boolean	doProcessColumn(SpreadSheetTablePopupMenuItemHelper.TableState state)	Processes the specified column.
String	getIconName()	Returns the name of the icon.
boolean	processColumn(SpreadSheetTablePopupMenuItemHelper.TableState state)	Processes 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.SpreadSheetTablePopupMenuItem

getMenuItem

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

handlesRowRange

Constructor Detail

AbstractProcessColumn

public AbstractProcessColumn()

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(SpreadSheetTablePopupMenuItemHelper.TableState state)

Hook method for checks before attempting processing.

Parameters:

state - the table state

Returns:

null if passed, otherwise error message

doProcessColumn

public abstract boolean doProcessColumn(SpreadSheetTablePopupMenuItemHelper.TableState state)

Processes the specified column.

Parameters:

state - the table state

Returns:

true if successful

processColumn

public boolean processColumn(SpreadSheetTablePopupMenuItemHelper.TableState state)

Processes the specified column.

Specified by:

processColumn in interface ProcessColumn

Parameters:

state - the table state

Returns:

true if successful