de.lmu.ifi.dbs.elki.datasource.bundle

Interface BundleStreamSource

All Known Subinterfaces:

StreamFilter, StreamingParser

All Known Implementing Classes:

AbstractStreamConversionFilter, AbstractStreamFilter, AbstractStreamingParser, AbstractStreamNormalization, AbstractVectorStreamConversionFilter, BitVectorLabelParser, BundleReader, ByLabelFilter, CategorialDataAsNumberVectorParser, ClassLabelFromPatternFilter, ClusteringVectorParser, DropNaNFilter, HellingerHistogramNormalization, HistogramJitterFilter, InstanceLogRankNormalization, InstanceMeanVarianceNormalization, InstanceMinMaxNormalization, InstanceRankNormalization, LatLngToECEFFilter, LengthNormalization, LibSVMFormatParser, LngLatToECEFFilter, Log1PlusNormalization, MultivariateTimeSeriesFilter, NoMissingValuesFilter, NoOpFilter, NumberVectorFeatureSelectionFilter, NumberVectorLabelParser, NumberVectorRandomFeatureSelectionFilter, ProjectionFilter, RandomSamplingStreamFilter, ReplaceNaNWithRandomFilter, SimplePolygonParser, SimpleTransactionParser, SparseNumberVectorLabelParser, StreamFromBundle, TermFrequencyParser, VectorDimensionalityFilter

public interface BundleStreamSource

Soruce for a bundle stream

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BundleStreamSource.Event Events

Method Summary

Methods

Modifier and Type	Method and Description
MultipleObjectsBundle	asMultipleObjectsBundle() Return (or collect) the stream as bundle.
boolean	assignDBID(DBIDVar var) Assign the current object ID to a DBIDVar.
Object	data(int rnum) Access a particular object and representation.
BundleMeta	getMeta() Get the current meta data.
boolean	hasDBIDs() Indicate whether the stream contains DBIDs.
BundleStreamSource.Event	nextEvent() Get the next event

Method Detail

getMeta

BundleMeta getMeta()

Get the current meta data.

Returns:

Metadata

data

Object data(int rnum)

Access a particular object and representation.

Parameters:

rnum - Representation number

Returns:

Contained data

hasDBIDs

boolean hasDBIDs()

Indicate whether the stream contains DBIDs.

Returns:

true if the stream contains DBIDs.

assignDBID

boolean assignDBID(DBIDVar var)

Assign the current object ID to a DBIDVar.

Parameters:

var - Variable to assign the object id to

Returns:

false when no object id is available

nextEvent

BundleStreamSource.Event nextEvent()

Get the next event

Returns:

Event type

asMultipleObjectsBundle

MultipleObjectsBundle asMultipleObjectsBundle()

Return (or collect) the stream as bundle.

Returns:

Bundle