Package adams.data.spreadsheet.columnfinder

Class AbstractTrainableColumnFinder

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.columnfinder.AbstractColumnFinder

adams.data.spreadsheet.columnfinder.AbstractTrainableColumnFinder

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<ColumnFinder>, SizeOfHandler, ColumnFinder, TrainableColumnFinder, Serializable

Direct Known Subclasses:

AbstractFilteredColumnFinder, MultiColumnFinder

public abstract class AbstractTrainableColumnFinder
extends AbstractColumnFinder
implements TrainableColumnFinder

Ancestor for ColumnFinder 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 column 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
AbstractTrainableColumnFinder()

Method Summary

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

Methods inherited from class adams.data.spreadsheet.columnfinder.AbstractColumnFinder

arrayToHashSet, compareTo, doFindColumns, equals, filter, filter, findColumns, forCommandLine, forName, getColumnFinders, getQuickInfo, 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.data.spreadsheet.columnfinder.ColumnFinder

findColumns

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.QuickInfoSupporter

getQuickInfo

Field Detail

m_Trained

protected boolean m_Trained

whether the column finder was trained already.

Constructor Detail

AbstractTrainableColumnFinder

public AbstractTrainableColumnFinder()

Method Detail

reset

protected void reset()

Resets the object, including the trained state.

Overrides:

reset in class AbstractOptionHandler

doTrainColumnFinder

protected abstract boolean doTrainColumnFinder(SpreadSheet data)

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

Parameters:

data - the training data

Returns:

true if successfully trained

trainColumnFinder

public boolean trainColumnFinder(SpreadSheet data)

Trains the column finder with the specified spreadsheet.

Specified by:

trainColumnFinder in interface TrainableColumnFinder

Parameters:

data - the training data

Returns:

true if successfully trained

isColumnFinderTrained

public boolean isColumnFinderTrained()

Checks whether the column finder has been trained.

Specified by:

isColumnFinderTrained in interface TrainableColumnFinder

Returns:

true if the column finder has been trained already

check

protected void check(SpreadSheet data)

Checks the data.

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

Overrides:

check in class AbstractColumnFinder

Parameters:

data - the data to check