Package adams.data.spreadsheet.rowfinder

Class MultiRowFinder

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.MultiRowFinder

All Implemented Interfaces:

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

public class MultiRowFinder
extends AbstractTrainableRowFinder

Applies multiple row finding algorithms to the data.
The indices can be either joined or intersected.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-finder <adams.data.weka.rowfinder.RowFinder> [-finder ...] (property: finders)
    The row finders to use.
    default: 
 

-combination <JOIN|INTERSECT> (property: combination)
    Defines how the indices are combined.
    default: JOIN
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiRowFinder.Combination	How combine the indices.

Field Summary

Fields

Modifier and Type	Field	Description
protected MultiRowFinder.Combination	m_Combination	how the indices are combined.
protected RowFinder[]	m_Finders	the row finders to use.

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

Method Summary

Modifier and Type	Method	Description
String	combinationTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected int[]	doFindRows(SpreadSheet data)	Returns the rows of interest in the spreadsheet.
protected boolean	doTrainRowFinder(SpreadSheet data)	Performs the actual training of the row finder with the specified spreadsheet.
String	findersTipText()	Returns the tip text for this property.
MultiRowFinder.Combination	getCombination()	Returns how the indices are combined.
RowFinder[]	getFinders()	Returns the row finders in use.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setCombination(MultiRowFinder.Combination value)	Sets how the indices are combined.
void	setFinders(RowFinder[] value)	Sets the row finders 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, equals, filter, findRows, forCommandLine, forName, getRowFinders, 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.core.logging.LoggingLevelHandler

getLoggingLevel

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

findRows

Field Detail

m_Finders

protected RowFinder[] m_Finders

the row finders to use.

m_Combination

protected MultiRowFinder.Combination m_Combination

how the indices are combined.

Constructor Detail

MultiRowFinder

public MultiRowFinder()

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 AbstractOptionHandler

setFinders

public void setFinders(RowFinder[] value)

Sets the row finders to use.

Parameters:

value - the row finders

getFinders

public RowFinder[] getFinders()

Returns the row finders in use.

Returns:

the row finders

findersTipText

public String findersTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setCombination

public void setCombination(MultiRowFinder.Combination value)

Sets how the indices are combined.

Parameters:

value - the combination type

getCombination

public MultiRowFinder.Combination getCombination()

Returns how the indices are combined.

Returns:

the combination type

combinationTipText

public String combinationTipText()

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

doFindRows

protected int[] doFindRows(SpreadSheet data)

Returns the rows of interest in the spreadsheet.

Specified by:

doFindRows in class AbstractRowFinder

Parameters:

data - the dataset to inspect

Returns:

the rows of interest