Package adams.data.spreadsheet.rowfinder

Class AbstractFilteredRowFinder

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.rowfinder.AbstractRowFinder

adams.data.spreadsheet.rowfinder.AbstractTrainableRowFinder

adams.data.spreadsheet.rowfinder.AbstractFilteredRowFinder

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<RowFinder>, SizeOfHandler, RowFinder, TrainableRowFinder, Serializable

Direct Known Subclasses:

Invert

public abstract class AbstractFilteredRowFinder
extends AbstractTrainableRowFinder

Ancestor for row finders that pre-filter the rows.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected RowFinder	m_RowFinder	the RowFinder to apply.

Fields inherited from class adams.data.spreadsheet.rowfinder.AbstractTrainableRowFinder

m_Trained

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected boolean	doTrainRowFinder(SpreadSheet data)	Performs the actual training of the row finder with the specified spreadsheet.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
RowFinder	getRowFinder()	Returns the row finder in use.
String	rowFinderTipText()	Returns the tip text for this property.
void	setRowFinder(RowFinder value)	Sets the row finder to use.

Methods inherited from class adams.data.spreadsheet.rowfinder.AbstractTrainableRowFinder

check, isRowFinderTrained, reset, trainRowFinder

Methods inherited from class adams.data.spreadsheet.rowfinder.AbstractRowFinder

arrayToHashSet, compareTo, doFindRows, equals, filter, findRows, forCommandLine, forName, getRowFinders, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.data.spreadsheet.rowfinder.RowFinder

findRows

Field Detail

m_RowFinder

protected RowFinder m_RowFinder

the RowFinder to apply.

Constructor Detail

AbstractFilteredRowFinder

public AbstractFilteredRowFinder()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setRowFinder

public void setRowFinder(RowFinder value)

Sets the row finder to use.

Parameters:

value - the row finder

getRowFinder

public RowFinder getRowFinder()

Returns the row finder in use.

Returns:

the row finder

rowFinderTipText

public String rowFinderTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractRowFinder

Returns:

null if no info available, otherwise short string

doTrainRowFinder

protected boolean doTrainRowFinder(SpreadSheet data)

Performs the actual training of the row finder with the specified spreadsheet.

Specified by:

doTrainRowFinder in class AbstractTrainableRowFinder

Parameters:

data - the training data

Returns:

true if successfully trained