Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

de.lmu.ifi.dbs.elki.algorithm.clustering
Class OPTICS.COEntry

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.algorithm.clustering.OPTICS.COEntry
All Implemented Interfaces:
Identifiable
Enclosing class:
OPTICS<O extends DatabaseObject,D extends Distance<D>>

public class OPTICS.COEntry
extends Object
implements Identifiable

Encapsulates an entry in the cluster order.


Field Summary
 Integer objectID
          The id of the entry.
(package private)  Integer predecessorID
          The id of the entry's predecessor.
 
Constructor Summary
OPTICS.COEntry(Integer objectID, Integer predecessorID)
          Creates a new entry with the specified parameters.
 
Method Summary
 int compareTo(Identifiable o)
          Compares this object with the specified object for order.
 boolean equals(Object o)
          Indicates whether some other object is "equal to" this one.
 Integer getID()
          Returns the unique id of this object.
 int hashCode()
          Returns a hash code value for the object which is the hash code of the objectID of this object.
 String toString()
          Returns a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

objectID

public Integer objectID
The id of the entry.


predecessorID

Integer predecessorID
The id of the entry's predecessor.

Constructor Detail

OPTICS.COEntry

public OPTICS.COEntry(Integer objectID,
                      Integer predecessorID)
Creates a new entry with the specified parameters.

Parameters:
objectID - the id of the entry
predecessorID - the id of the entry's predecessor
Method Detail

compareTo

public int compareTo(Identifiable o)
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Parameters:
o - the Object to be compared.
Returns:
a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

toString

public String toString()
Returns a string representation of the object.

Overrides:
toString in class Object
Returns:
a string representation of the object.

equals

public boolean equals(Object o)
Indicates whether some other object is "equal to" this one. The result is true if and only if the argument is not null and is an COEntry object and objectID.equals(((COEntry) o).objectID) returns true.

Overrides:
equals in class Object
Parameters:
o - the object to compare with
Returns:
true if the specified object is equal to this one, false otherwise.

hashCode

public int hashCode()
Returns a hash code value for the object which is the hash code of the objectID of this object.

Overrides:
hashCode in class Object
Returns:
the hash code of the objectID of this object

getID

public Integer getID()
Returns the unique id of this object.

Specified by:
getID in interface Identifiable
Returns:
the unique id of this object

Release 0.2 (2009-07-06_1820)