weka.filters

Class MakePreconstructedFilter

java.lang.Object

weka.filters.Filter

weka.filters.MakePreconstructedFilter

All Implemented Interfaces:

java.io.Serializable, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.CommandlineRunnable, weka.core.OptionHandler, Preconstructed, weka.core.RevisionHandler, PreconstructedFilter, weka.filters.StreamableFilter

@KFIgnore
public class MakePreconstructedFilter
extends weka.filters.Filter
implements PreconstructedFilter, weka.filters.StreamableFilter, java.io.Serializable

Class for wrapping a standard filter and making it a PreconstructedFilter.

Version:

$Revision: 13450 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MakePreconstructedFilter()
MakePreconstructedFilter(weka.filters.Filter base)

Method Summary

Modifier and Type	Method and Description
boolean	batchFinished()
weka.filters.Filter	getBaseFilter() Get the base filter being wrapped
weka.core.Capabilities	getCapabilities()
weka.core.Capabilities	getCapabilities(weka.core.Instances data)
weka.core.Instances	getInputFormat()
weka.core.Instances	getOutputFormat()
boolean	input(weka.core.Instance inst)
boolean	isConstructed() Returns true if this Preconstructed instance is initialized and ready to be used
boolean	isFirstBatchDone()
boolean	isNewBatch()
boolean	isOutputFormatDefined()
java.util.Enumeration	listOptions() List the options for this filter
boolean	mayRemoveInstanceAfterFirstBatchDone()
int	numPendingOutput()
weka.core.Instance	output()
weka.core.Instance	outputPeek()
void	resetPreconstructed() Reset.
void	setBaseFilter(weka.filters.Filter f) Set the base filter to wrap
void	setConstructed() Mark this pre-constructed filter as "constructed" - i.e.
boolean	setInputFormat(weka.core.Instances insts)
void	setOptions(java.lang.String[] options) Set the options for this filter

Methods inherited from class weka.filters.Filter

batchFilterFile, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOptions, getRevision, main, makeCopies, makeCopy, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

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

Methods inherited from interface weka.core.OptionHandler

makeCopy

Constructor Detail

MakePreconstructedFilter

public MakePreconstructedFilter()

MakePreconstructedFilter

public MakePreconstructedFilter(weka.filters.Filter base)

Method Detail

listOptions

public java.util.Enumeration listOptions()

List the options for this filter

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class weka.filters.Filter

Returns:

an enumeration of options

setOptions

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

Set the options for this filter

Specified by:

setOptions in interface weka.core.OptionHandler

Overrides:

setOptions in class weka.filters.Filter

Parameters:

options - the options

Throws:

java.lang.Exception - if a problem occurs

setBaseFilter

public void setBaseFilter(weka.filters.Filter f)

Set the base filter to wrap

Parameters:

f - the base filter to wrap

getBaseFilter

public weka.filters.Filter getBaseFilter()

Get the base filter being wrapped

Returns:

the base filter being wrapped

getCapabilities

public weka.core.Capabilities getCapabilities()

Specified by:

getCapabilities in interface weka.core.CapabilitiesHandler

Overrides:

getCapabilities in class weka.filters.Filter

getCapabilities

public weka.core.Capabilities getCapabilities(weka.core.Instances data)

Overrides:

getCapabilities in class weka.filters.Filter

mayRemoveInstanceAfterFirstBatchDone

public boolean mayRemoveInstanceAfterFirstBatchDone()

Overrides:

mayRemoveInstanceAfterFirstBatchDone in class weka.filters.Filter

isNewBatch

public boolean isNewBatch()

Overrides:

isNewBatch in class weka.filters.Filter

isFirstBatchDone

public boolean isFirstBatchDone()

Overrides:

isFirstBatchDone in class weka.filters.Filter

setInputFormat

public boolean setInputFormat(weka.core.Instances insts)
                       throws java.lang.Exception

Overrides:

setInputFormat in class weka.filters.Filter

Throws:

java.lang.Exception

getInputFormat

public weka.core.Instances getInputFormat()

Overrides:

getInputFormat in class weka.filters.Filter

getOutputFormat

public weka.core.Instances getOutputFormat()

Overrides:

getOutputFormat in class weka.filters.Filter

batchFinished

public boolean batchFinished()
                      throws java.lang.Exception

Overrides:

batchFinished in class weka.filters.Filter

Throws:

java.lang.Exception

output

public weka.core.Instance output()

Overrides:

output in class weka.filters.Filter

input

public boolean input(weka.core.Instance inst)
              throws java.lang.Exception

Overrides:

input in class weka.filters.Filter

Throws:

java.lang.Exception

isOutputFormatDefined

public boolean isOutputFormatDefined()

Overrides:

isOutputFormatDefined in class weka.filters.Filter

numPendingOutput

public int numPendingOutput()

Overrides:

numPendingOutput in class weka.filters.Filter

outputPeek

public weka.core.Instance outputPeek()

Overrides:

outputPeek in class weka.filters.Filter

isConstructed

public boolean isConstructed()

Description copied from interface: Preconstructed

Returns true if this Preconstructed instance is initialized and ready to be used

Specified by:

isConstructed in interface Preconstructed

Returns:

true if this instance is initialized and ready to be used

setConstructed

public void setConstructed()

Mark this pre-constructed filter as "constructed" - i.e. it is already ready to use and has an input format set on the underlying filter.

resetPreconstructed

public void resetPreconstructed()

Description copied from interface: Preconstructed

Reset. After calling reset() a call to isConstructed() should return false.

Specified by:

resetPreconstructed in interface Preconstructed