summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/MTreeEntry.java
blob: 0683a0614ce6cad4795960ddd7cbe6416e40f6aa (plain)
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
75
76
77
78
79
80
81
82
83
84
package de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants;

/*
 This file is part of ELKI:
 Environment for Developing KDD-Applications Supported by Index-Structures

 Copyright (C) 2011
 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/>.
 */

import de.lmu.ifi.dbs.elki.database.ids.DBID;
import de.lmu.ifi.dbs.elki.distance.distancevalue.Distance;
import de.lmu.ifi.dbs.elki.index.tree.Entry;

/**
 * Defines the requirements for an entry in an M-Tree node.
 * 
 * @author Elke Achtert
 * @param <D> the type of Distance used in the M-Tree
 */
public interface MTreeEntry<D extends Distance<D>> extends Entry {
  /**
   * 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.
   * 
   * @return the id of the underlying database object of this entry, if this
   *         entry is a leaf entry, the id of the routing object, otherwise
   */
  DBID getRoutingObjectID();

  /**
   * 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.
   * 
   * @param objectID the id to be set
   */
  void setRoutingObjectID(DBID objectID);

  /**
   * Returns the distance from the routing object of this entry to the routing
   * object of its parent.
   * 
   * @return the distance from the object to its parent object
   */
  D getParentDistance();

  /**
   * Sets the distance from the routing object to routing object of its parent.
   * 
   * @param parentDistance the distance to be set
   */
  void setParentDistance(D parentDistance);

  /**
   * Returns the covering radius if this entry is a directory entry, null
   * otherwise.
   * 
   * @return the covering radius of this entry
   */
  D getCoveringRadius();

  /**
   * Sets the covering radius of this entry if this entry is a directory entry,
   * throws an UnsupportedOperationException otherwise.
   * 
   * @param coveringRadius the covering radius to be set
   */
  void setCoveringRadius(D coveringRadius);
}