Package adams.data.spreadsheet.columnfinder

Class MultiColumnFinder

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

All Implemented Interfaces:

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

public class MultiColumnFinder
extends AbstractTrainableColumnFinder

Applies multiple column 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.columnfinder.ColumnFinder> [-finder ...] (property: finders)
    The column 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	MultiColumnFinder.Combination	How combine the indices.

Field Summary

Fields

Modifier and Type	Field	Description
protected MultiColumnFinder.Combination	m_Combination	how the indices are combined.
protected ColumnFinder[]	m_Finders	the column finders to use.

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

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[]	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	findersTipText()	Returns the tip text for this property.
MultiColumnFinder.Combination	getCombination()	Returns how the indices are combined.
ColumnFinder[]	getFinders()	Returns the column 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(MultiColumnFinder.Combination value)	Sets how the indices are combined.
void	setFinders(ColumnFinder[] value)	Sets the column finders 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, 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_Finders

protected ColumnFinder[] m_Finders

the column finders to use.

m_Combination

protected MultiColumnFinder.Combination m_Combination

how the indices are combined.

Constructor Detail

MultiColumnFinder

public MultiColumnFinder()

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(ColumnFinder[] value)

Sets the column finders to use.

Parameters:

value - the column finders

getFinders

public ColumnFinder[] getFinders()

Returns the column finders in use.

Returns:

the column 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(MultiColumnFinder.Combination value)

Sets how the indices are combined.

Parameters:

value - the combination type

getCombination

public MultiColumnFinder.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 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

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