weka.filters

Class SimpleFilter

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

All Implemented Interfaces:

java.io.Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler

Direct Known Subclasses:

SimpleBatchFilter, SimpleStreamFilter

public abstract class SimpleFilter
extends Filter

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

See Also:

SimpleBatchFilter, SimpleStreamFilter, Serialized Form

Field Summary

Fields inherited from class weka.filters.Filter

m_Debug, m_DoNotCheckCapabilities, 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
protected abstract Instances	determineOutputFormat(Instances inputFormat) Determines the output format based on the input format and returns this.
abstract java.lang.String	globalInfo() Returns a string describing this filter.
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())
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.
boolean	setInputFormat(Instances instanceInfo) Sets the format of the input instances.

Methods inherited from class weka.filters.Filter

batchFilterFile, batchFinished, bufferInput, copyValues, copyValues, debugTipText, doNotCheckCapabilitiesTipText, filterFile, flushInput, getCapabilities, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getInputFormat, getOptions, getOutputFormat, getRevision, initInputLocators, initOutputLocators, input, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, listOptions, main, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputFormatPeek, outputPeek, postExecution, preExecution, push, push, resetQueue, run, runFilter, setDebug, setDoNotCheckCapabilities, setOptions, setOutputFormat, testInputFormat, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleFilter

public SimpleFilter()

Method Detail

globalInfo

public abstract java.lang.String globalInfo()

Returns a string describing this filter.

Returns:

a description of the filter 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 java.lang.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:

java.lang.Exception - in case the determination goes wrong

See Also:

hasImmediateOutputFormat(), Filter.batchFinished()

process

protected abstract Instances process(Instances instances)
                              throws java.lang.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:

java.lang.Exception - in case the processing goes wrong

See Also:

Filter.batchFinished()

setInputFormat

public boolean setInputFormat(Instances instanceInfo)
                       throws java.lang.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:

java.lang.Exception - if the inputFormat can't be set successfully

See Also:

reset()