Package moa.streams
Interface ExampleStream<E extends Example>
-
- All Superinterfaces:
CapabilitiesHandler
,MOAObject
,Serializable
- All Known Subinterfaces:
ConceptDriftGenerator
,InstanceStream
,MultiLabelStreamFilter
,MultiTargetInstanceStream
,StreamFilter
- All Known Implementing Classes:
AbruptChangeGenerator
,AbstractConceptDriftGenerator
,AbstractMultiLabelStreamFilter
,AbstractStreamFilter
,AddNoiseFilter
,AgrawalGenerator
,ArffFileStream
,AssetNegotiationGenerator
,BootstrappedStream
,CachedInstancesStream
,ClusteringStream
,ConceptDriftRealStream
,ConceptDriftStream
,FileStream
,FilteredStream
,GradualChangeGenerator
,HashingTrickFilter
,HyperplaneGenerator
,ImbalancedStream
,IrrelevantFeatureAppenderStream
,LEDGenerator
,LEDGeneratorDrift
,MetaMultilabelGenerator
,MixedGenerator
,MultiFilteredStream
,MultilabelArffFileStream
,MultiLabelFilteredStream
,MultiTargetArffFileStream
,NoChangeGenerator
,NormalisationFilter
,PartitioningStream
,RandomProjectionFilter
,RandomRBFGenerator
,RandomRBFGeneratorDrift
,RandomRBFGeneratorEvents
,RandomTreeGenerator
,RBFFilter
,RecurrentConceptDriftStream
,ReLUFilter
,RemoveDiscreteAttributeFilter
,ReplacingMissingValuesFilter
,SEAGenerator
,SelectAttributesFilter
,SimpleCSVStream
,SineGenerator
,STAGGERGenerator
,StandardisationFilter
,TextGenerator
,WaveformGenerator
,WaveformGeneratorDrift
public interface ExampleStream<E extends Example> extends MOAObject, CapabilitiesHandler
Interface representing a data stream of examples.- Version:
- $Revision: 7 $
- Author:
- Richard Kirkby (rkirkby@cs.waikato.ac.nz)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ImmutableCapabilities
defineImmutableCapabilities()
Defines the set of capabilities the object has.long
estimatedRemainingInstances()
Gets the estimated number of remaining instances in this streamInstancesHeader
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 moa.capabilities.CapabilitiesHandler
getCapabilities
-
Methods inherited from interface 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.
-
defineImmutableCapabilities
default ImmutableCapabilities defineImmutableCapabilities()
Description copied from interface:CapabilitiesHandler
Defines the set of capabilities the object has. Should be overridden if the object's capabilities do not change.- Specified by:
defineImmutableCapabilities
in interfaceCapabilitiesHandler
- Returns:
- The capabilities of the object.
-
-