summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexPathComponent.java
blob: a5490faf199e107da7f06903b7e20f2c0cb569c7 (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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
package de.lmu.ifi.dbs.elki.index.tree;
/*
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/>.
*/

/**
 * Represents a component in an IndexPath. A component in an IndexPath consists
 * of the entry of the index (representing a node or a data object) and the
 * index of the component in its parent.
 * 
 * @author Elke Achtert
 * @param <E> the type of Entry used in the index
 */
public class TreeIndexPathComponent<E extends Entry> {
  /**
   * The entry of this component.
   */
  private E entry;

  /**
   * The index of this component in its parent.
   */
  private Integer index;

  /**
   * Creates a new IndexPathComponent.
   * 
   * @param entry the entry of the component
   * @param index index of the component in its parent
   */
  public TreeIndexPathComponent(E entry, Integer index) {
    this.entry = entry;
    this.index = index;
  }

  /**
   * Returns the entry of the component.
   * 
   * @return the entry of the component
   */
  public E getEntry() {
    return entry;
  }

  /**
   * Returns the index of the component in its parent.
   * 
   * @return the index of the component in its parent
   */
  public Integer getIndex() {
    return index;
  }

  /**
   * Returns <code>true</code> if <code>this == o</code> has the value
   * <code>true</code> or o is not null and o is of the same class as this
   * instance and if the entry of this component equals the entry of the o
   * argument, <code>false</code> otherwise.
   */
  @Override
  @SuppressWarnings("unchecked")
  public boolean equals(Object o) {
    if(this == o) {
      return true;
    }
    if(o == null || getClass() != o.getClass()) {
      return false;
    }

    final TreeIndexPathComponent<E> that = (TreeIndexPathComponent<E>) o;
    return (this.entry.equals(that.entry));
  }

  /**
   * Returns a hash code for this component. The hash code of a
   * TreeIndexPathComponent is defined to be the hash code of its entry.
   * 
   * @return the hash code of the entry of this component
   */
  @Override
  public int hashCode() {
    return entry.hashCode();
  }

  /**
   * Returns a string representation of this component.
   * 
   * @return a string representation of the entry of this component followd by
   *         the index of this component in its parent
   */
  @Override
  public String toString() {
    return entry.toString() + " [" + index + "]";
  }
}