Package adams.data.spreadsheet.columnfinder

Class RowFilteredColumnFinder

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

adams.data.spreadsheet.columnfinder.RowFilteredColumnFinder

All Implemented Interfaces:

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

public class RowFilteredColumnFinder
extends AbstractFilteredColumnFinder

This column finder first filters the rows before finding any columns on the subset of 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 boolean	m_ColumnFinderTrained	whether the column finder was trained on the subset.
protected RowFinder	m_RowFinder	the RowFinder to use first.

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

m_ColumnFinder

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected int[]	doFindColumns(SpreadSheet data)	Returns the columns of interest in the spreadsheet.
protected boolean	doTrainColumnFinder(SpreadSheet data)	Performs the actual training of the column 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	globalInfo()	Returns a string describing the object.
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.columnfinder.AbstractFilteredColumnFinder

columnFinderTipText, getColumnFinder, setColumnFinder

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

check, isColumnFinderTrained, reset, trainColumnFinder

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

arrayToHashSet, compareTo, equals, filter, filter, findColumns, forCommandLine, forName, getColumnFinders, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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_RowFinder

protected RowFinder m_RowFinder

the RowFinder to use first.

m_ColumnFinderTrained

protected boolean m_ColumnFinderTrained

whether the column finder was trained on the subset.

Constructor Detail

RowFilteredColumnFinder

public RowFilteredColumnFinder()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractFilteredColumnFinder

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 AbstractFilteredColumnFinder

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.

Overrides:

doTrainColumnFinder in class AbstractFilteredColumnFinder

Parameters:

data - the training data

Returns:

true if successfully trained

doFindColumns

protected int[] doFindColumns(SpreadSheet data)

Returns the columns of interest in the spreadsheet.

Specified by:

doFindColumns in class AbstractColumnFinder

Parameters:

data - the spreadsheet to inspect

Returns:

the columns of interest