Package adams.data.spreadsheet.columnfinder

Class AbstractFilteredColumnFinder

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

adams.data.spreadsheet.columnfinder.AbstractFilteredColumnFinder

All Implemented Interfaces:

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

Direct Known Subclasses:

Invert, RowFilteredColumnFinder

public abstract class AbstractFilteredColumnFinder
extends AbstractTrainableColumnFinder

Ancestor for column finders that pre-filter the columns.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ColumnFinder	m_ColumnFinder	the ColumnFinder to apply.

Fields inherited from class adams.data.spreadsheet.columnfinder.AbstractTrainableColumnFinder

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

Method Summary

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

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

check, isColumnFinderTrained, reset, trainColumnFinder

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

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

findColumns

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_ColumnFinder

protected ColumnFinder m_ColumnFinder

the ColumnFinder to apply.

Constructor Detail

AbstractFilteredColumnFinder

public AbstractFilteredColumnFinder()

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

setColumnFinder

public void setColumnFinder(ColumnFinder value)

Sets the column finder to use.

Parameters:

value - the column finder

getColumnFinder

public ColumnFinder getColumnFinder()

Returns the column finder in use.

Returns:

the column finder

columnFinderTipText

public String columnFinderTipText()

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 AbstractColumnFinder

Returns:

null if no info available, otherwise short string

doTrainColumnFinder

protected boolean doTrainColumnFinder(SpreadSheet data)

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

Specified by:

doTrainColumnFinder in class AbstractTrainableColumnFinder

Parameters:

data - the training data

Returns:

true if successfully trained