weka.filters

Class SimpleFilter

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

All Implemented Interfaces:

Serializable, CapabilitiesHandler, OptionHandler, RevisionHandler

Direct Known Subclasses:

SimpleBatchFilter, SimpleStreamFilter

public abstract class SimpleFilter
extends Filter
implements OptionHandler

This filter contains common behavior of the SimpleBatchFilter and the SimpleStreamFilter.

Version:

$Revision: 1.4 $

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

SimpleBatchFilter, SimpleStreamFilter, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_Debug Whether debugging is on

Fields inherited from class weka.filters.Filter

m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

Constructor Summary

Constructors

Constructor and Description
SimpleFilter()

Method Summary

Modifier and Type	Method and Description
String	debugTipText() Returns the tip text for this property
protected abstract Instances	determineOutputFormat(Instances inputFormat) Determines the output format based on the input format and returns this.
boolean	getDebug() Returns the current debugging mode state.
String[]	getOptions() Gets the current settings of the filter.
abstract String	globalInfo() Returns a string describing this classifier.
protected abstract boolean	hasImmediateOutputFormat() returns true if the output format is immediately available after the input format has been set and not only after all the data has been seen (see batchFinished())
Enumeration	listOptions() Returns an enumeration describing the available options.
protected abstract Instances	process(Instances instances) Processes the given data (may change the provided dataset) and returns the modified version.
protected void	reset() resets the filter, i.e., m_NewBatch to true and m_FirstBatchDone to false.
void	setDebug(boolean value) Sets the debugging mode
boolean	setInputFormat(Instances instanceInfo) Sets the format of the input instances.
void	setOptions(String[] options) Parses a list of options for this object.

Methods inherited from class weka.filters.Filter

batchFilterFile, batchFinished, bufferInput, copyValues, copyValues, filterFile, flushInput, getCapabilities, getCapabilities, getInputFormat, getOutputFormat, getRevision, initInputLocators, initOutputLocators, input, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, main, makeCopies, makeCopy, numPendingOutput, output, outputFormatPeek, outputPeek, push, resetQueue, runFilter, setOutputFormat, testInputFormat, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Debug

protected boolean m_Debug

Whether debugging is on

Constructor Detail

SimpleFilter

public SimpleFilter()

Method Detail

globalInfo

public abstract String globalInfo()

Returns a string describing this classifier.

Returns:

a description of the classifier suitable for displaying in the explorer/experimenter gui

listOptions

public Enumeration listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(String[] options)
                throws Exception

Parses a list of options for this object. Also resets the state of the filter (this reset doesn't affect the options).

Specified by:

setOptions in interface OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

Exception - if an option is not supported

See Also:

reset()

getOptions

public String[] getOptions()

Gets the current settings of the filter.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

setDebug

public void setDebug(boolean value)

Sets the debugging mode

Parameters:

value - if true, debugging information is output

getDebug

public boolean getDebug()

Returns the current debugging mode state.

Returns:

true if debugging mode is on

debugTipText

public String debugTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

reset

protected void reset()

resets the filter, i.e., m_NewBatch to true and m_FirstBatchDone to false.

See Also:

Filter.m_NewBatch, Filter.m_FirstBatchDone

hasImmediateOutputFormat

protected abstract boolean hasImmediateOutputFormat()

returns true if the output format is immediately available after the input format has been set and not only after all the data has been seen (see batchFinished())

Returns:

true if the output format is immediately available

See Also:

Filter.batchFinished(), setInputFormat(Instances)

determineOutputFormat

protected abstract Instances determineOutputFormat(Instances inputFormat)
                                            throws Exception

Determines the output format based on the input format and returns this. In case the output format cannot be returned immediately, i.e., immediateOutputFormat() returns false, then this method will be called from batchFinished().

Parameters:

inputFormat - the input format to base the output format on

Returns:

the output format

Throws:

Exception - in case the determination goes wrong

See Also:

hasImmediateOutputFormat(), Filter.batchFinished()

process

protected abstract Instances process(Instances instances)
                              throws Exception

Processes the given data (may change the provided dataset) and returns the modified version. This method is called in batchFinished().

Parameters:

instances - the data to process

Returns:

the modified data

Throws:

Exception - in case the processing goes wrong

See Also:

Filter.batchFinished()

setInputFormat

public boolean setInputFormat(Instances instanceInfo)
                       throws Exception

Sets the format of the input instances. Also resets the state of the filter (this reset doesn't affect the options).

Overrides:

setInputFormat in class Filter

Parameters:

instanceInfo - an Instances object containing the input instance structure (any instances contained in the object are ignored - only the structure is required).

Returns:

true if the outputFormat may be collected immediately

Throws:

Exception - if the inputFormat can't be set successfully

See Also:

reset()