Import Upstream version 0.4.0~beta1

1 files changed, 114 insertions, 0 deletions

diff --git a/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexPathComponent.java b/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexPathComponent.java
new file mode 100644
index 00000000..a5490faf
--- /dev/null
+++ b/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexPathComponent.java
@@ -0,0 +1,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 + "]";
+  }
+}