Package moa.streams

Class FilteredStream

java.lang.Object

moa.AbstractMOAObject

moa.options.AbstractOptionHandler

moa.streams.FilteredStream

All Implemented Interfaces:

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

public class FilteredStream
extends AbstractOptionHandler
implements ExampleStream

Class for representing a stream that is filtered.

Version:

$Revision: 7 $

Author:

Richard Kirkby ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ExampleStream	filterChain
ClassOption	filtersOption
ClassOption	streamOption

Fields inherited from class moa.options.AbstractOptionHandler

config

Constructor Summary

Constructors

Constructor	Description
FilteredStream()

Method Summary

Modifier and Type	Method	Description
long	estimatedRemainingInstances()	Gets the estimated number of remaining instances in this stream
void	getDescription(java.lang.StringBuilder sb, int indent)	Returns a string representation of this object.
InstancesHeader	getHeader()	Gets the header of this stream.
java.lang.String	getPurposeString()	Dictionary with option texts and objects
boolean	hasMoreInstances()	Gets whether this stream has more instances to output.
boolean	isRestartable()	Gets whether this stream can restart.
Example	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.

Methods inherited from class moa.AbstractMOAObject

copy, measureByteSize, measureByteSize, toString

Methods inherited from class moa.options.AbstractOptionHandler

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

Methods inherited from interface moa.capabilities.CapabilitiesHandler

getCapabilities

Methods inherited from interface moa.streams.ExampleStream

defineImmutableCapabilities

Methods inherited from interface moa.MOAObject

copy, measureByteSize

Methods inherited from class java.lang.Object

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

Field Detail

streamOption

public ClassOption streamOption

filtersOption

public ClassOption filtersOption

filterChain

protected ExampleStream filterChain

Constructor Detail

FilteredStream

public FilteredStream()

Method Detail

getPurposeString

public java.lang.String getPurposeString()

Description copied from class: AbstractOptionHandler

Dictionary with option texts and objects

Specified by:

getPurposeString in interface OptionHandler

Overrides:

getPurposeString in class AbstractOptionHandler

Returns:

the string with the purpose of this object

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

getHeader

public InstancesHeader getHeader()

Description copied from interface: ExampleStream

Gets the header of this stream. This is useful to know attributes and classes. InstancesHeader is an extension of weka.Instances.

Specified by:

getHeader in interface ExampleStream

Returns:

the header of 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

nextInstance

public Example 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

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

getDescription

public void getDescription(java.lang.StringBuilder sb,
                           int indent)

Description copied from interface: MOAObject

Returns a string representation of this object. Used in AbstractMOAObject.toString to give a string representation of the object.

Specified by:

getDescription in interface MOAObject

Parameters:

sb - the stringbuilder to add the description

indent - the number of characters to indent