MOA 12.03
Real Time Analytics for Data Streams
moa.streams.FilteredStream Class Reference

Class for representing a stream that is filtered. More...

Inheritance diagram for moa.streams.FilteredStream:
Collaboration diagram for moa.streams.FilteredStream:

List of all members.

Public Member Functions

String getPurposeString ()
 Gets the purpose of this object.
void prepareForUseImpl (TaskMonitor monitor, ObjectRepository repository)
 This method describes the implementation of how to prepare this object for use.
long estimatedRemainingInstances ()
 Gets the estimated number of remaining instances in this stream.
InstancesHeader getHeader ()
 Gets the header of this stream.
boolean hasMoreInstances ()
 Gets whether this stream has more instances to output.
boolean isRestartable ()
 Gets whether this stream can restart.
Instance nextInstance ()
 Gets the next instance from this stream.
void restart ()
 Restarts this stream.
void getDescription (StringBuilder sb, int indent)
 Returns a string representation of this object.

Public Attributes

ClassOption streamOption
ListOption filtersOption

Protected Attributes

InstanceStream filterChain

Detailed Description

Class for representing a stream that is filtered.

Author:
Richard Kirkby (rkirkby@cs.waikato.ac.nz)
Version:
Revision:
7

Definition at line 39 of file FilteredStream.java.


Member Function Documentation

long moa.streams.FilteredStream.estimatedRemainingInstances ( )

Gets the estimated number of remaining instances in this stream.

Returns:
the estimated number of instances to get from this stream

Implements moa.streams.InstanceStream.

Definition at line 90 of file FilteredStream.java.

Here is the call graph for this function:

void moa.streams.FilteredStream.getDescription ( StringBuilder  sb,
int  indent 
)

Returns a string representation of this object.

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

Parameters:
sbthe stringbuilder to add the description
indentthe number of characters to indent

Implements moa.MOAObject.

Definition at line 120 of file FilteredStream.java.

InstancesHeader moa.streams.FilteredStream.getHeader ( )

Gets the header of this stream.

This is useful to know attributes and classes. InstancesHeader is an extension of weka.Instances.

Returns:
the header of this stream

Implements moa.streams.InstanceStream.

Definition at line 95 of file FilteredStream.java.

Here is the call graph for this function:

String moa.streams.FilteredStream.getPurposeString ( )

Gets the purpose of this object.

Returns:
the string with the purpose of this object

Reimplemented from moa.options.AbstractOptionHandler.

Definition at line 43 of file FilteredStream.java.

boolean moa.streams.FilteredStream.hasMoreInstances ( )

Gets whether this stream has more instances to output.

This is useful when reading streams from files.

Returns:
true if this stream has more instances to output

Implements moa.streams.InstanceStream.

Definition at line 100 of file FilteredStream.java.

Here is the call graph for this function:

boolean moa.streams.FilteredStream.isRestartable ( )

Gets whether this stream can restart.

Returns:
true if this stream can restart

Implements moa.streams.InstanceStream.

Definition at line 105 of file FilteredStream.java.

Here is the call graph for this function:

Instance moa.streams.FilteredStream.nextInstance ( )

Gets the next instance from this stream.

Returns:
the next instance of this stream

Implements moa.streams.InstanceStream.

Definition at line 110 of file FilteredStream.java.

Here is the call graph for this function:

void moa.streams.FilteredStream.prepareForUseImpl ( TaskMonitor  monitor,
ObjectRepository  repository 
) [virtual]

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.

Parameters:
monitorthe TaskMonitor to use
repositorythe ObjectRepository to use

Implements moa.options.AbstractOptionHandler.

Definition at line 61 of file FilteredStream.java.

Here is the call graph for this function:

void moa.streams.FilteredStream.restart ( )

Restarts this stream.

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

Implements moa.streams.InstanceStream.

Definition at line 115 of file FilteredStream.java.

Here is the call graph for this function:


Member Data Documentation

Initial value:
 new ListOption("filters", 'f',
            "Filters to apply.", new ClassOption("filter", ' ',
            "Stream filter.", StreamFilter.class, "AddNoiseFilter"),
            new Option[0], ',')

Definition at line 53 of file FilteredStream.java.

Referenced by moa.streams.FilteredStream.prepareForUseImpl().

Initial value:
 new ClassOption("stream", 's',
            "Stream to filter.", InstanceStream.class,
            "generators.RandomTreeGenerator")

Definition at line 49 of file FilteredStream.java.

Referenced by moa.streams.FilteredStream.prepareForUseImpl().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations