weka.filters

Class MultiFilter

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleStreamFilter

weka.filters.MultiFilter

All Implemented Interfaces:

java.io.Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler, StreamableFilter

public class MultiFilter
extends SimpleStreamFilter
implements WeightedAttributesHandler, WeightedInstancesHandler

Applies several filters successively. In case all supplied filters are StreamableFilters, it will act as a streamable one, too.

Valid options are:

 -D
  Turns on output of debugging information.
 

 -F <classname [options]>
  A filter to apply (can be specified multiple times).
 

See Also:

StreamableFilter, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Filter[]	m_Filters The filters
protected boolean	m_Streamable caches the streamable state
protected boolean	m_StreamableChecked whether we already checked the streamable state

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
MultiFilter()

Method Summary

Modifier and Type	Method and Description
boolean	batchFinished() Signify that this batch of input to the filter is finished.
protected Instances	determineOutputFormat(Instances inputFormat) Determines the output format based on the input format and returns this.
java.lang.String	filtersTipText() Returns the tip text for this property
Capabilities	getCapabilities() Returns the Capabilities of this filter.
Filter	getFilter(int index) Gets a single filter from the set of available filters.
Filter[]	getFilters() Gets the list of possible filters to choose from.
protected java.lang.String	getFilterSpec(Filter filter) returns the filter classname and the options as one string
java.lang.String[]	getOptions() Gets the current settings of the filter.
java.lang.String	getRevision() Returns the revision string.
java.lang.String	globalInfo() Returns a string describing this filter
protected 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()).
boolean	isStreamableFilter() tests whether all the enclosed filters are streamable
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] args) Main method for executing this class.
boolean	mayRemoveInstanceAfterFirstBatchDone() RemoveWithValues may return false from input() (thus not making an instance available immediately) even after the first batch has been completed due to matching a value that the user wants to remove.
protected Instance	process(Instance instance) processes the given instance (may change the provided instance) and returns the modified version.
protected 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	setFilters(Filter[] filters) Sets the list of possible filters to choose from.
void	setOptions(java.lang.String[] options) Parses a list of options for this object.

Methods inherited from class weka.filters.SimpleStreamFilter

input, preprocess

Methods inherited from class weka.filters.SimpleFilter

setInputFormat

Methods inherited from class weka.filters.Filter

batchFilterFile, bufferInput, copyValues, copyValues, debugTipText, doNotCheckCapabilitiesTipText, filterFile, flushInput, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, numPendingOutput, output, outputFormatPeek, outputPeek, postExecution, preExecution, push, push, resetQueue, run, runFilter, setDebug, setDoNotCheckCapabilities, 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_Filters

protected Filter[] m_Filters

The filters

m_Streamable

protected boolean m_Streamable

caches the streamable state

m_StreamableChecked

protected boolean m_StreamableChecked

whether we already checked the streamable state

Constructor Detail

MultiFilter

public MultiFilter()

Method Detail

globalInfo

public java.lang.String globalInfo()

Returns a string describing this filter

Specified by:

globalInfo in class SimpleFilter

Returns:

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

listOptions

public java.util.Enumeration<Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class Filter

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a list of options for this object.

Valid options are:

 -D
  Turns on output of debugging information.
 

 -F <classname [options]>
  A filter to apply (can be specified multiple times).
 

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class Filter

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the filter.

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class Filter

Returns:

an array of strings suitable for passing to setOptions

getCapabilities

public Capabilities getCapabilities()

Returns the Capabilities of this filter.

Specified by:

getCapabilities in interface CapabilitiesHandler

Overrides:

getCapabilities in class Filter

Returns:

the capabilities of this object

See Also:

Capabilities

reset

protected void reset()

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

Overrides:

reset in class SimpleFilter

See Also:

Filter.m_NewBatch, Filter.m_FirstBatchDone

setFilters

public void setFilters(Filter[] filters)

Sets the list of possible filters to choose from. Also resets the state of the filter (this reset doesn't affect the options).

Parameters:

filters - an array of filters with all options set.

See Also:

reset()

getFilters

public Filter[] getFilters()

Gets the list of possible filters to choose from.

Returns:

the array of Filters

filtersTipText

public java.lang.String filtersTipText()

Returns the tip text for this property

Returns:

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

getFilter

public Filter getFilter(int index)

Gets a single filter from the set of available filters.

Parameters:

index - the index of the filter wanted

Returns:

the Filter

getFilterSpec

protected java.lang.String getFilterSpec(Filter filter)

returns the filter classname and the options as one string

Parameters:

filter - the filter to get the specs for

Returns:

the classname plus options

isStreamableFilter

public boolean isStreamableFilter()

tests whether all the enclosed filters are streamable

Returns:

true if all the enclosed filters are streamable

hasImmediateOutputFormat

protected 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()). This method should normally return true for a stream filter, since the data will be processed in a batch manner instead (or at least for the second batch of files, see m_FirstBatchDone).

Overrides:

hasImmediateOutputFormat in class SimpleStreamFilter

Returns:

true if the output format is immediately available

See Also:

batchFinished(), SimpleFilter.setInputFormat(Instances), Filter.m_FirstBatchDone

determineOutputFormat

protected 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., hasImmediateOutputFormat() returns false, then this method will called from batchFinished() after the call of preprocess(Instances), in which, e.g., statistics for the actual processing step can be gathered.

Specified by:

determineOutputFormat in class SimpleStreamFilter

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(), batchFinished(), SimpleStreamFilter.preprocess(Instances)

process

protected Instance process(Instance instance)
                    throws java.lang.Exception

processes the given instance (may change the provided instance) and returns the modified version.

Specified by:

process in class SimpleStreamFilter

Parameters:

instance - the instance to process

Returns:

the modified data

Throws:

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

process

protected 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(). This implementation only calls process(Instance) for each instance in the given dataset.

Overrides:

process in class SimpleStreamFilter

Parameters:

instances - the data to process

Returns:

the modified data

Throws:

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

See Also:

batchFinished(), process(Instance)

batchFinished

public boolean batchFinished()
                      throws java.lang.Exception

Signify that this batch of input to the filter is finished. If the filter requires all instances prior to filtering, output() may now be called to retrieve the filtered instances. Any subsequent instances filtered should be filtered based on setting obtained from the first batch (unless the setInputFormat has been re-assigned or new options have been set).

Overrides:

batchFinished in class SimpleStreamFilter

Returns:

true if there are instances pending output

Throws:

java.lang.IllegalStateException - if no input format has been set.

java.lang.NullPointerException - if no input structure has been defined,

java.lang.Exception - if there was a problem finishing the batch.

mayRemoveInstanceAfterFirstBatchDone

public boolean mayRemoveInstanceAfterFirstBatchDone()

RemoveWithValues may return false from input() (thus not making an instance available immediately) even after the first batch has been completed due to matching a value that the user wants to remove. Therefore this method returns true.

Overrides:

mayRemoveInstanceAfterFirstBatchDone in class Filter

Returns:

true if one of the base filters returns true for this method.

getRevision

public java.lang.String getRevision()

Returns the revision string.

Specified by:

getRevision in interface RevisionHandler

Overrides:

getRevision in class Filter

Returns:

the revision

main

public static void main(java.lang.String[] args)

Main method for executing this class.

Parameters:

args - should contain arguments for the filter: use -h for help