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: 10211 $

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

SimpleBatchFilter, SimpleStreamFilter, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleFilter()

Method Summary

Methods

Modifier and Type	Method and Description
String	debugTipText() Returns the tip text for this property
String	doNotCheckCapabilitiesTipText() Returns the tip text for this property
Capabilities	getCapabilities() Returns the Capabilities of this filter.
boolean	getDebug() Get whether debugging is turned on.
boolean	getDoNotCheckCapabilities() Get whether capabilities checking is turned off.
String[]	getOptions() Gets the current settings of the filter.
abstract String	globalInfo() Returns a string describing this filter.
Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
void	setDebug(boolean debug) Set debugging mode.
void	setDoNotCheckCapabilities(boolean doNotCheckCapabilities) Set whether not to check capabilities.
boolean	setInputFormat(Instances instanceInfo) Sets the format of the input instances.
void	setOptions(String[] options) Parses a given list of options.

Methods inherited from class weka.filters.Filter

batchFilterFile, batchFinished, filterFile, getCapabilities, getOutputFormat, getRevision, input, isFirstBatchDone, isNewBatch, isOutputFormatDefined, main, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, runFilter, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleFilter

public SimpleFilter()

Method Detail

globalInfo

public abstract String globalInfo()

Returns a string describing this filter.

Returns:

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

listOptions

public Enumeration<Option> 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 given list of options. Valid options are:

-D
If set, filter is run in debug mode and may output additional info to the console.

-do-not-check-capabilities
If set, filter capabilities are not checked when input format is set (use with caution).

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

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 debug)

Set debugging mode.

Parameters:

debug - true if debug output should be printed

getDebug

public boolean getDebug()

Get whether debugging is turned on.

Returns:

true if debugging output 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

setDoNotCheckCapabilities

public void setDoNotCheckCapabilities(boolean doNotCheckCapabilities)

Set whether not to check capabilities.

Parameters:

doNotCheckCapabilities - true if capabilities are not to be checked.

getDoNotCheckCapabilities

public boolean getDoNotCheckCapabilities()

Get whether capabilities checking is turned off.

Returns:

true if capabilities checking is turned off.

doNotCheckCapabilitiesTipText

public String doNotCheckCapabilitiesTipText()

Returns the tip text for this property

Returns:

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

getCapabilities

public Capabilities getCapabilities()

Returns the Capabilities of this filter. Maximally permissive capabilities are allowed by default. Derived filters should override this method and first disable all capabilities and then enable just those capabilities that make sense for the scheme.

Specified by:

getCapabilities in interface CapabilitiesHandler

Overrides:

getCapabilities in class Filter

Returns:

the capabilities of this object

See Also:

Capabilities

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