com.yahoo.labs.samoa.moa.streams

Interface ExampleStream<E extends Example>

All Superinterfaces:

MOAObject, Serializable

All Known Subinterfaces:

InstanceStream

All Known Implementing Classes:

ArffFileStream, ArffFileStream, ClusteringStream, FileStream, HyperplaneGenerator, RandomRBFGeneratorEvents, RandomTreeGenerator

public interface ExampleStream<E extends Example>
extends MOAObject

Interface representing a data stream of examples.

Version:

$Revision: 7 $

Author:

Richard Kirkby (rkirkby@cs.waikato.ac.nz)

Method Summary

Methods

Modifier and Type	Method and Description
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.
E	nextInstance() Gets the next example from this stream.
void	restart() Restarts this stream.

Methods inherited from interface com.yahoo.labs.samoa.moa.MOAObject

copy, getDescription, measureByteSize

Method Detail

getHeader

InstancesHeader 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

estimatedRemainingInstances

long estimatedRemainingInstances()

Gets the estimated number of remaining instances in this stream

Returns:

the estimated number of instances to get from this stream

hasMoreInstances

boolean 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

nextInstance

E nextInstance()

Gets the next example from this stream.

Returns:

the next example of this stream

isRestartable

boolean isRestartable()

Gets whether this stream can restart.

Returns:

true if this stream can restart

restart

void restart()

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