All Superinterfaces:

CapabilitiesHandler, Filter

All Known Implementing Classes:

AbstractColumnSubsetBatchFilter, AbstractColumnSubsetFilter, AbstractColumnSubsetStreamFilter, PCA, PLS, SavitzkyGolay
```
public interface ColumnSubsetFilter
extends Filter
```
Filter with column subset handling.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`colRangeTipText()`	Returns the tip text for this property.
`String`	`colRegExpTipText()`	Returns the tip text for this property.
`String`	`columnSubsetTipText()`	Returns the tip text for this property.
`String`	`dropOtherColumnsTipText()`	Returns the tip text for this property.
`SpreadSheetColumnRange`	`getColRange()`	Returns the range of columns to use for filtering (if `ColumnSubset.RANGE`).
`BaseRegExp`	`getColRegExp()`	Returns the regular expression to use on the column names to determine whether to use a column for filtering (if `ColumnSubset.REGEXP`).
`ColumnSubset`	`getColumnSubset()`	Returns how to determine columns for filtering.
`boolean`	`getDropOtherColumns()`	Returns whether to drop other columns that aren't used for filtering from the output.
`Dataset`	`getOutputFormat()`	Returns the output format.
`boolean`	`isInitialized()`	Returns whether the filter has been initialized.
`void`	`setColRange(SpreadSheetColumnRange value)`	Sets the range of columns to use for filtering (if `ColumnSubset.RANGE`).
`void`	`setColRegExp(BaseRegExp value)`	Sets the regular expression to use on the column names to determine whether * to use a column for filtering (if `ColumnSubset.REGEXP`).
`void`	`setColumnSubset(ColumnSubset value)`	Sets how to determine columns for filtering.
`void`	`setDropOtherColumns(boolean value)`	Sets whether to drop other columns that aren't used for filtering from the output.

Methods inherited from interface adams.ml.preprocessing.Filter
getCapabilities

- Method Detail
  - setColumnSubset
```
void setColumnSubset(ColumnSubset value)
```
    Sets how to determine columns for filtering.
    
    Parameters:
    
    value - the type
  - getColumnSubset
```
ColumnSubset getColumnSubset()
```
    Returns how to determine columns for filtering.
    
    Returns:
    
    the type
  - columnSubsetTipText
```
String columnSubsetTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setColRange
```
void setColRange(SpreadSheetColumnRange value)
```
    Sets the range of columns to use for filtering (if ColumnSubset.RANGE).
    
    Parameters:
    
    value - the range
  - getColRange
```
SpreadSheetColumnRange getColRange()
```
    Returns the range of columns to use for filtering (if ColumnSubset.RANGE).
    
    Returns:
    
    the range
  - colRangeTipText
```
String colRangeTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setColRegExp
```
void setColRegExp(BaseRegExp value)
```
    Sets the regular expression to use on the column names to determine whether * to use a column for filtering (if ColumnSubset.REGEXP).
    
    Parameters:
    
    value - the expression
  - getColRegExp
```
BaseRegExp getColRegExp()
```
    Returns the regular expression to use on the column names to determine whether to use a column for filtering (if ColumnSubset.REGEXP).
    
    Returns:
    
    the expression
  - colRegExpTipText
```
String colRegExpTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setDropOtherColumns
```
void setDropOtherColumns(boolean value)
```
    Sets whether to drop other columns that aren't used for filtering from the output. Does not affect any class columns.
    
    Parameters:
    
    value - true if to drop
  - getDropOtherColumns
```
boolean getDropOtherColumns()
```
    Returns whether to drop other columns that aren't used for filtering from the output. Does not affect any class columns.
    
    Returns:
    
    true if to drop
  - dropOtherColumnsTipText
```
String dropOtherColumnsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - isInitialized
```
boolean isInitialized()
```
    Returns whether the filter has been initialized.
    
    Specified by:
    
    isInitialized in interface Filter
    
    Returns:
    
    true if initialized
  - getOutputFormat
```
Dataset getOutputFormat()
```
    Returns the output format.
    
    Specified by:
    
    getOutputFormat in interface Filter
    
    Returns:
    
    the format, null if not yet defined

Interface ColumnSubsetFilter

Method Summary

Methods inherited from interface adams.ml.preprocessing.Filter

Method Detail

setColumnSubset

getColumnSubset

columnSubsetTipText

setColRange

getColRange

colRangeTipText

setColRegExp

getColRegExp

colRegExpTipText

setDropOtherColumns

getDropOtherColumns

dropOtherColumnsTipText

isInitialized

getOutputFormat