de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants

Interface MTreeEntry

All Superinterfaces:

Entry, java.io.Externalizable, java.io.Serializable

All Known Subinterfaces:

MkAppEntry, MkCoPEntry, MkMaxEntry, MkTabEntry

All Known Implementing Classes:

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

public interface MTreeEntry
extends Entry

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

Since:

0.1

Author:

Elke Achtert

Method Summary

Modifier and Type	Method and Description
double	getCoveringRadius() Returns the covering radius if this entry is a directory entry, null otherwise.
double	getParentDistance() Returns the distance from the routing object of this entry to the routing object of its parent.
DBID	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.
boolean	setCoveringRadius(double coveringRadius) Sets the covering radius of this entry if this entry is a directory entry, throws an UnsupportedOperationException otherwise.
boolean	setParentDistance(double parentDistance) Sets the distance from the routing object to routing object of its parent.
boolean	setRoutingObjectID(DBID 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 java.io.Externalizable

readExternal, writeExternal

Method Detail

getRoutingObjectID

DBID 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

boolean setRoutingObjectID(DBID 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

Returns:

TODO

getParentDistance

double 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

boolean setParentDistance(double parentDistance)

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

Parameters:

parentDistance - the distance to be set

Returns:

TODO

getCoveringRadius

double getCoveringRadius()

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

Returns:

the covering radius of this entry

setCoveringRadius

boolean setCoveringRadius(double 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

Returns:

TODO