Package adams.data.spreadsheet.rowfinder

Class AbstractTrainableRowFinder

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractFilteredRowFinder, MultiRowFinder

public abstract class AbstractTrainableRowFinder
extends AbstractRowFinder
implements TrainableRowFinder

Ancestor for RowFinder algorithms that can be trained.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Trained	whether the row finder was trained already.

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

Method Summary

Modifier and Type	Method	Description
protected void	check(SpreadSheet data)	Checks the data.
protected abstract boolean	doTrainRowFinder(SpreadSheet data)	Performs the actual training of the row finder with the specified spreadsheet.
boolean	isRowFinderTrained()	Checks whether the row finder has been trained.
protected void	reset()	Resets the object, including the trained state.
boolean	trainRowFinder(SpreadSheet data)	Trains the row finder with the specified spreadsheet.

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

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

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, 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.core.QuickInfoSupporter

getQuickInfo

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

findRows

Field Detail

m_Trained

protected boolean m_Trained

whether the row finder was trained already.

Constructor Detail

AbstractTrainableRowFinder

public AbstractTrainableRowFinder()

Method Detail

reset

protected void reset()

Resets the object, including the trained state.

Overrides:

reset in class AbstractOptionHandler

doTrainRowFinder

protected abstract boolean doTrainRowFinder(SpreadSheet data)

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

Parameters:

data - the training data

Returns:

true if successfully trained

trainRowFinder

public boolean trainRowFinder(SpreadSheet data)

Trains the row finder with the specified spreadsheet.

Specified by:

trainRowFinder in interface TrainableRowFinder

Parameters:

data - the training data

Returns:

true if successfully trained

isRowFinderTrained

public boolean isRowFinderTrained()

Checks whether the row finder has been trained.

Specified by:

isRowFinderTrained in interface TrainableRowFinder

Returns:

true if the row finder has been trained already

check

protected void check(SpreadSheet data)

Checks the data.

Trains the row finder with the given data if not yet trained.

Overrides:

check in class AbstractRowFinder

Parameters:

data - the data to check