TrainableSpreadSheetFilter (adams-pom 24.5.0-SNAPSHOT API)

All Superinterfaces:

SpreadSheetFilter

All Known Implementing Classes:

AbstractTrainableSpreadSheetFilter, Normalize, Standardize, WekaFilter
```
public interface TrainableSpreadSheetFilter
extends SpreadSheetFilter
```
Interface for filters that can be trained.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`isTrained()`	Whether the filter has already been trained.
`void`	`resetFilter()`	Invalidates the training.
`SpreadSheet`	`train(SpreadSheet data)`	(Re-)Trains on the spreadsheet.

Methods inherited from interface adams.data.spreadsheet.filter.SpreadSheetFilter
filter

- Method Detail
  - resetFilter
```
void resetFilter()
```
    Invalidates the training.
  - isTrained
```
boolean isTrained()
```
    Whether the filter has already been trained.
    
    Returns:
    
    true if trained
  - train
```
SpreadSheet train(SpreadSheet data)
           throws Exception
```
    (Re-)Trains on the spreadsheet.
    
    Parameters:
    
    data - the spreadsheet to train with and filter
    
    Returns:
    
    the filtered spreadsheet
    
    Throws:
    
    Exception - if training fails