Package adams.data.spreadsheet.filter

Class AbstractSpreadSheetFilter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.filter.AbstractSpreadSheetFilter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, SpreadSheetFilter, Serializable

Direct Known Subclasses:

AbstractTrainableSpreadSheetFilter, PassThrough

public abstract class AbstractSpreadSheetFilter
extends AbstractOptionHandler
implements SpreadSheetFilter, QuickInfoSupporter

Ancestor for spreadsheet filters.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(SpreadSheet data)	Hook method for checks.
protected abstract SpreadSheet	doFilter(SpreadSheet data)	Performs the actual filtering of the spreadsheet.
SpreadSheet	filter(SpreadSheet data)	Filters the spreadsheet.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.

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

Constructor Detail

AbstractSpreadSheetFilter

public AbstractSpreadSheetFilter()

Method Detail

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.
Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected String check(SpreadSheet data)

Hook method for checks.

Parameters:

data - the spreadsheet to filter

Returns:

the filtered spreadsheet

doFilter

protected abstract SpreadSheet doFilter(SpreadSheet data)
                                 throws Exception

Performs the actual filtering of the spreadsheet.

Parameters:

data - the spreadsheet to filter

Returns:

the filtered spreadsheet

Throws:

Exception - if filtering fails

filter

public SpreadSheet filter(SpreadSheet data)
                   throws Exception

Filters the spreadsheet.

Specified by:

filter in interface SpreadSheetFilter

Parameters:

data - the spreadsheet to filter

Returns:

the filtered spreadsheet

Throws:

Exception - if filtering fails