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

Interface ObjectBundle

All Known Implementing Classes:

MultipleObjectsBundle, SingleObjectBundle

public interface ObjectBundle

Abstract interface for object packages. Shared API for both single-object and multi-object packages.

Since:

0.4.0

Author:

Erich Schubert

Method Summary

Modifier and Type	Method and Description
boolean	assignDBID(int onum, DBIDVar var) Assign the object DBID to a variable
java.lang.Object	data(int onum, int rnum) Access a particular object and representation.
int	dataLength() Get the number of objects contained.
BundleMeta	meta() Access the meta data.
SimpleTypeInformation<?>	meta(int i) Access the meta data.
int	metaLength() Get the metadata length.

Method Detail

meta

BundleMeta meta()

Access the meta data.

Returns:

metadata

meta

SimpleTypeInformation<?> meta(int i)

Access the meta data.

Parameters:

i - component

Returns:

metadata of component i

metaLength

int metaLength()

Get the metadata length.

Returns:

length of metadata

dataLength

int dataLength()

Get the number of objects contained.

Returns:

Number of objects

data

java.lang.Object data(int onum,
                      int rnum)

Access a particular object and representation.

Parameters:

onum - Object number

rnum - Representation number

Returns:

Contained data

assignDBID

boolean assignDBID(int onum,
                   DBIDVar var)

Assign the object DBID to a variable

Parameters:

onum - Object number

var - Variable

Returns:

false if there was no predefined DBID.