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

Interface DBID

All Superinterfaces:

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

All Known Implementing Classes:

IntegerDBID

public interface DBID
extends DBIDRef, Comparable<DBIDRef>, ArrayDBIDs

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 do context tracking for debug purposes!) In particular, a developer should not make any assumption of these IDs being consistent across multiple results/databases.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareDBID(DBIDRef other) Compare two objects by the value of the referenced DBID.
int	compareTo(DBIDRef other) Compare two DBIDs for ordering.
boolean	equals(Object obj) In contrast to DBIDRef, the DBID interface is supposed to have a stable equals for other DBIDs.
DBID	getDBID() Deprecated. When the object is known to be a DBID, the usage of this method is pointless, therefore it is marked as deprecated to cause a warning.
int	hashCode() In contrast to DBIDRef, the DBID interface is supposed to have a stable hash code.
boolean	sameDBID(DBIDRef other) Compare the current value of two referenced DBIDs.

Methods inherited from interface de.lmu.ifi.dbs.elki.database.ids.DBIDRef

getIntegerID

Methods inherited from interface de.lmu.ifi.dbs.elki.database.ids.ArrayDBIDs

binarySearch, get, iter, size

Methods inherited from interface de.lmu.ifi.dbs.elki.database.ids.DBIDs

contains, isEmpty, iterator

Method Detail

sameDBID

boolean sameDBID(DBIDRef other)

Compare the current value of two referenced DBIDs.

Specified by:

sameDBID in interface DBIDRef

Parameters:

other - Other DBID reference (or DBID)

Returns:

true when the references currently refer to the same.

compareDBID

int compareDBID(DBIDRef other)

Compare two objects by the value of the referenced DBID.

Specified by:

compareDBID in interface DBIDRef

Parameters:

other - Other DBID or object

Returns:

-1, 0 or +1

hashCode

int hashCode()

In contrast to DBIDRef, the DBID interface is supposed to have a stable hash code. However, it is generally preferred to use optimized storage classes instead of Java collections!

Specified by:

hashCode in interface DBIDRef

Overrides:

hashCode in class Object

Returns:

hash code

equals

boolean equals(Object obj)

In contrast to DBIDRef, the DBID interface is supposed to have a stable equals for other DBIDs. Yet, sameDBID(de.lmu.ifi.dbs.elki.database.ids.DBIDRef) is more type safe and explicit.

Specified by:

equals in interface DBIDRef

Overrides:

equals in class Object

Parameters:

obj - Object to compare with

Returns:

true when the object is the same DBID.

getDBID

@Deprecated
DBID getDBID()

Deprecated. When the object is known to be a DBID, the usage of this method is pointless, therefore it is marked as deprecated to cause a warning.

Part of the DBIDRef API, this must return this for an actual DBID.

Specified by:

getDBID in interface DBIDRef

Returns:

this

compareTo

int compareTo(DBIDRef other)

Compare two DBIDs for ordering. Consider using compareDBID(de.lmu.ifi.dbs.elki.database.ids.DBIDRef), which is more explicit.

Specified by:

compareTo in interface Comparable<DBIDRef>

Parameters:

other - Other DBID object

Returns:

Comparison result