de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants
Interface MTreeEntry<D extends Distance<D>>

Type Parameters:

D - the type of Distance used in the M-Tree

All Superinterfaces:

Entry, Externalizable, MetricalEntry, Serializable

All Known Subinterfaces:

MkAppEntry<D,N>, MkCoPEntry<D,N>, MkMaxEntry<D>, MkTabEntry<D>

All Known Implementing Classes:

MkAppDirectoryEntry, MkAppLeafEntry, MkCoPDirectoryEntry, MkCoPLeafEntry, MkMaxDirectoryEntry, MkMaxLeafEntry, MkTabDirectoryEntry, MkTabLeafEntry, MTreeDirectoryEntry, MTreeLeafEntry

public interface MTreeEntry<D extends Distance<D>>
extends MetricalEntry

Defines the requirements for an entry in an M-Tree node.

Author:

Elke Achtert

Method Summary

D	getCoveringRadius() Returns the covering radius if this entry is a directory entry, null otherwise.
D	getParentDistance() Returns the distance from the routing object of this entry to the routing object of its parent.
Integer	getRoutingObjectID() Returns the id of the underlying database object of this entry, if this entry is a leaf entry, the id of the routing object, otherwise.
void	setCoveringRadius(D coveringRadius) Sets the covering radius of this entry if this entry is a directory entry, throws an UnsupportedOperationException otherwise.
void	setParentDistance(D parentDistance) Sets the distance from the routing object to routing object of its parent.
void	setRoutingObjectID(Integer objectID) Sets the id of the underlying database object of this entry, if this entry is a leaf entry, the id of the routing object, otherwise.

Methods inherited from interface de.lmu.ifi.dbs.elki.index.tree.Entry

getID, isLeafEntry, setID

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Method Detail

getRoutingObjectID

Integer getRoutingObjectID()

Returns the id of the underlying database object of this entry, if this entry is a leaf entry, the id of the routing object, otherwise.

Returns:

the id of the underlying database object of this entry, if this entry is a leaf entry, the id of the routing object, otherwise

setRoutingObjectID

void setRoutingObjectID(Integer objectID)

Sets the id of the underlying database object of this entry, if this entry is a leaf entry, the id of the routing object, otherwise.

Parameters:

objectID - the id to be set

getParentDistance

D getParentDistance()

Returns the distance from the routing object of this entry to the routing object of its parent.

Returns:

the distance from the object to its parent object

setParentDistance

void setParentDistance(D parentDistance)

Sets the distance from the routing object to routing object of its parent.

Parameters:

parentDistance - the distance to be set

getCoveringRadius

D getCoveringRadius()

Returns the covering radius if this entry is a directory entry, null otherwise.

Returns:

the covering radius of this entry

setCoveringRadius

void setCoveringRadius(D coveringRadius)

Sets the covering radius of this entry if this entry is a directory entry, throws an UnsupportedOperationException otherwise.

Parameters:

coveringRadius - the covering radius to be set