1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
package de.lmu.ifi.dbs.elki.database.ids;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2012
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* 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.
*
* @author Erich Schubert
*
* @apiviz.landmark
*/
public interface DBID extends DBIDRef, Comparable<DBIDRef>, ArrayDBIDs, SetDBIDs {
/**
* In contrast to {@link 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!
*
* @return hash code
*/
@Override
int hashCode();
/**
* In contrast to {@link DBIDRef}, the DBID interface is supposed to have a
* stable equals for other DBIDs.
*
* Yet, {@link DBIDUtil#equal} is more type safe and explicit.
*
* @param obj Other object
* @return true when the object is the same DBID.
*/
@Override
@Deprecated
boolean equals(Object obj);
/**
* Compare two DBIDs for ordering.
*
* Consider using {@link DBIDUtil#compare}, which is more explicit.
*
* @param other Other DBID object
* @return Comparison result
*/
@Override
int compareTo(DBIDRef other);
}
|
