de.lmu.ifi.dbs.elki.database.ids.integer

Class IntegerDBID

java.lang.Object

de.lmu.ifi.dbs.elki.database.ids.integer.IntegerDBID

All Implemented Interfaces:

ArrayDBIDs, DBID, DBIDs, Comparable<DBID>, Iterable<DBID>

 class IntegerDBID
extends Object
implements DBID

Database ID object. While this currently is just an Integer, it should be avoided to store the object IDs in regular integers to reduce problems if this API ever changes (for example if someone needs to support long, it should not require changes in too many places!) In particular, a developer should not make any assumption of these IDs being consistent across multiple results/databases.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	IntegerDBID.DBIDItr Pseudo iterator for DBIDs interface.
static class	IntegerDBID.DynamicSerializer Dynamic sized serializer, using varint.
protected class	IntegerDBID.Itr Pseudo iterator for DBIDs interface.
static class	IntegerDBID.StaticSerializer Static sized serializer, using regular integers.

Field Summary

Fields

Modifier and Type	Field and Description
static IntegerDBID.DynamicSerializer	dynamicSerializer The public instance to use for dynamic serialization.
protected int	id The actual object ID.
static IntegerDBID.StaticSerializer	staticSerializer The public instance to use for static serialization.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IntegerDBID(int id) Constructor from integer id.
protected	IntegerDBID(Integer id) Constructor from integer id.

Method Summary

Methods

Modifier and Type	Method and Description
int	binarySearch(DBID key) Search for the position of the given key, assuming that the data set is sorted.
int	compareTo(DBID o)
boolean	contains(DBID o) Test whether an ID is contained.
boolean	equals(Object obj)
DBID	get(int i) Get the i'th entry (starting at 0)
int	getIntegerID() Return the integer value of the object ID.
int	hashCode()
boolean	isEmpty() Test for an empty DBID collection.
DBIDIter	iter() Iterable
Iterator<DBID>	iterator() Retrieve Iterator access to the IDs.
int	size() Size of the DBID "collection".
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected final int id

The actual object ID.

dynamicSerializer

public static final IntegerDBID.DynamicSerializer dynamicSerializer

The public instance to use for dynamic serialization.

staticSerializer

public static final IntegerDBID.StaticSerializer staticSerializer

The public instance to use for static serialization.

Constructor Detail

IntegerDBID

protected IntegerDBID(int id)

Constructor from integer id.

Parameters:

id - integer id.

IntegerDBID

protected IntegerDBID(Integer id)

Constructor from integer id.

Parameters:

id - integer id.

Method Detail

getIntegerID

public int getIntegerID()

Return the integer value of the object ID.

Specified by:

getIntegerID in interface DBID

Returns:

integer id

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(DBID o)

Specified by:

compareTo in interface Comparable<DBID>

iter

public DBIDIter iter()

Description copied from interface: ArrayDBIDs

Iterable

Specified by:

iter in interface ArrayDBIDs

Specified by:

iter in interface DBIDs

Returns:

Iterator

get

public DBID get(int i)

Description copied from interface: ArrayDBIDs

Get the i'th entry (starting at 0)

Specified by:

get in interface ArrayDBIDs

Parameters:

i - Index

Returns:

DBID of i'th entry.

iterator

public Iterator<DBID> iterator()

Description copied from interface: DBIDs

Retrieve Iterator access to the IDs.

Specified by:

iterator in interface DBIDs

Specified by:

iterator in interface Iterable<DBID>

Returns:

an iterator for the IDs

contains

public boolean contains(DBID o)

Description copied from interface: DBIDs

Test whether an ID is contained.

Specified by:

contains in interface DBIDs

Parameters:

o - object to test

Returns:

true when contained

size

public int size()

Description copied from interface: ArrayDBIDs

Size of the DBID "collection".

Specified by:

size in interface ArrayDBIDs

Specified by:

size in interface DBIDs

Returns:

size

binarySearch

public int binarySearch(DBID key)

Description copied from interface: ArrayDBIDs

Search for the position of the given key, assuming that the data set is sorted. For keys not found, -(1+insertion position) is returned, as for Java Collections.binarySearch(java.util.List<? extends java.lang.Comparable<? super T>>, T)

Specified by:

binarySearch in interface ArrayDBIDs

Parameters:

key - Key to search for

Returns:

Offset of key

isEmpty

public boolean isEmpty()

Description copied from interface: DBIDs

Test for an empty DBID collection.

Specified by:

isEmpty in interface DBIDs

Returns:

true when empty.