Package moa.streams.filters

Class AbstractStreamFilter

java.lang.Object

moa.AbstractMOAObject

moa.options.AbstractOptionHandler

moa.streams.filters.AbstractStreamFilter

All Implemented Interfaces:

Configurable, java.io.Serializable, CapabilitiesHandler, MOAObject, OptionHandler, ExampleStream, StreamFilter

Direct Known Subclasses:

AddNoiseFilter, RBFFilter, ReLUFilter, RemoveDiscreteAttributeFilter, ReplacingMissingValuesFilter

public abstract class AbstractStreamFilter
extends AbstractOptionHandler
implements StreamFilter

Abstract Stream Filter.

Version:

$Revision: 7 $

Author:

Richard Kirkby ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ExampleStream	inputStream	The input stream to this filter.

Fields inherited from class moa.options.AbstractOptionHandler

config

Constructor Summary

Constructors

Constructor	Description
AbstractStreamFilter()

Method Summary

Modifier and Type	Method	Description
long	estimatedRemainingInstances()	Gets the estimated number of remaining instances in this stream
Instance	filterInstance(Instance inst)
boolean	hasMoreInstances()	Gets whether this stream has more instances to output.
boolean	isRestartable()	Gets whether this stream can restart.
InstanceExample	nextInstance()	Gets the next example from this stream.
void	prepareForUseImpl(TaskMonitor monitor, ObjectRepository repository)	This method describes the implementation of how to prepare this object for use.
void	restart()	Restarts this stream.
protected abstract void	restartImpl()	Restarts this filter.
void	setInputStream(ExampleStream stream)	Sets the input stream to the filter

Methods inherited from class moa.AbstractMOAObject

copy, measureByteSize, measureByteSize, toString

Methods inherited from class moa.options.AbstractOptionHandler

copy, getCLICreationString, getOptions, getPreparedClassOption, getPurposeString, prepareClassOptions, prepareForUse, prepareForUse

Methods inherited from interface moa.capabilities.CapabilitiesHandler

getCapabilities

Methods inherited from interface moa.streams.ExampleStream

defineImmutableCapabilities, getHeader

Methods inherited from interface moa.MOAObject

copy, getDescription, measureByteSize

Methods inherited from class java.lang.Object

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

Field Detail

inputStream

protected ExampleStream inputStream

The input stream to this filter.

Constructor Detail

AbstractStreamFilter

public AbstractStreamFilter()

Method Detail

setInputStream

public void setInputStream(ExampleStream stream)

Description copied from interface: StreamFilter

Sets the input stream to the filter

Specified by:

setInputStream in interface StreamFilter

Parameters:

stream - the input stream to the filter

prepareForUseImpl

public void prepareForUseImpl(TaskMonitor monitor,
                              ObjectRepository repository)

Description copied from class: AbstractOptionHandler

This method describes the implementation of how to prepare this object for use. All classes that extends this class have to implement prepareForUseImpl and not prepareForUse since prepareForUse calls prepareForUseImpl.

Specified by:

prepareForUseImpl in class AbstractOptionHandler

Parameters:

monitor - the TaskMonitor to use

repository - the ObjectRepository to use

estimatedRemainingInstances

public long estimatedRemainingInstances()

Description copied from interface: ExampleStream

Gets the estimated number of remaining instances in this stream

Specified by:

estimatedRemainingInstances in interface ExampleStream

Returns:

the estimated number of instances to get from this stream

hasMoreInstances

public boolean hasMoreInstances()

Description copied from interface: ExampleStream

Gets whether this stream has more instances to output. This is useful when reading streams from files.

Specified by:

hasMoreInstances in interface ExampleStream

Returns:

true if this stream has more instances to output

isRestartable

public boolean isRestartable()

Description copied from interface: ExampleStream

Gets whether this stream can restart.

Specified by:

isRestartable in interface ExampleStream

Returns:

true if this stream can restart

restart

public void restart()

Description copied from interface: ExampleStream

Restarts this stream. It must be similar to starting a new stream from scratch.

Specified by:

restart in interface ExampleStream

restartImpl

protected abstract void restartImpl()

Restarts this filter. All instances that extends from AbstractStreamFilter must implement restartImpl. restart uses restartImpl in AbstractStreamFilter.

nextInstance

public InstanceExample nextInstance()

Description copied from interface: ExampleStream

Gets the next example from this stream.

Specified by:

nextInstance in interface ExampleStream

Returns:

the next example of this stream

filterInstance

public Instance filterInstance(Instance inst)

Specified by:

filterInstance in interface StreamFilter