AbstractFilteredColumnFinder (adams-pom 24.11.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.weka.columnfinder.AbstractColumnFinder
      - adams.data.weka.columnfinder.AbstractTrainableColumnFinder
        
        adams.data.weka.columnfinder.AbstractFilteredColumnFinder

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, 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.weka.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

All Methods Instance Methods Concrete Methods
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(weka.core.Instances data)`	Performs the actual training of the column finder with the specified dataset.
`ColumnFinder`	`getColumnFinder()`	Returns the column finder in use.
`void`	`setColumnFinder(ColumnFinder value)`	Sets the column finder to use.

Methods inherited from class adams.data.weka.columnfinder.AbstractTrainableColumnFinder
check, isColumnFinderTrained, reset, trainColumnFinder

Methods inherited from class adams.data.weka.columnfinder.AbstractColumnFinder
arrayToHashSet, compareTo, doFindColumns, equals, 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.weka.columnfinder.ColumnFinder
findColumns

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine

- 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
  - doTrainColumnFinder
```
protected boolean doTrainColumnFinder(weka.core.Instances data)
```
    Performs the actual training of the column finder with the specified dataset.
    
    Specified by:
    
    doTrainColumnFinder in class AbstractTrainableColumnFinder
    
    Parameters:
    
    data - the training data
    
    Returns:
    
    true if successfully trained