Import Upstream version 0.7.0

1 files changed, 156 insertions, 0 deletions

diff --git a/elki/src/main/java/de/lmu/ifi/dbs/elki/result/ResultHierarchy.java b/elki/src/main/java/de/lmu/ifi/dbs/elki/result/ResultHierarchy.java
new file mode 100644
index 00000000..5c8b1ab4
--- /dev/null
+++ b/elki/src/main/java/de/lmu/ifi/dbs/elki/result/ResultHierarchy.java
@@ -0,0 +1,156 @@
+package de.lmu.ifi.dbs.elki.result;
+
+/*
+ This file is part of ELKI:
+ Environment for Developing KDD-Applications Supported by Index-Structures
+
+ Copyright (C) 2015
+ 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 java.util.ArrayList;
+
+import de.lmu.ifi.dbs.elki.logging.Logging;
+import de.lmu.ifi.dbs.elki.utilities.datastructures.hierarchy.HashMapHierarchy;
+import de.lmu.ifi.dbs.elki.utilities.datastructures.hierarchy.Hierarchy;
+import de.lmu.ifi.dbs.elki.utilities.datastructures.hierarchy.ModifiableHierarchy;
+
+/**
+ * Class to store a hierarchy of result objects.
+ *
+ * @author Erich Schubert
+ */
+// TODO: add listener merging!
+public class ResultHierarchy extends HashMapHierarchy<Result> {
+  /**
+   * Logger
+   */
+  private static final Logging LOG = Logging.getLogger(ResultHierarchy.class);
+
+  /**
+   * Holds the listener.
+   */
+  private ArrayList<ResultListener> listenerList = new ArrayList<>();
+
+  /**
+   * Constructor.
+   */
+  public ResultHierarchy() {
+    super();
+  }
+
+  @Override
+  public boolean add(Result parent, Result child) {
+    boolean changed = super.add(parent, child);
+    if(changed && child instanceof HierarchicalResult) {
+      HierarchicalResult hr = (HierarchicalResult) child;
+      ModifiableHierarchy<Result> h = hr.getHierarchy();
+      // Merge hierarchy
+      hr.setHierarchy(this);
+      // Add children of child
+      for(Hierarchy.Iter<Result> iter = h.iterChildren(hr); iter.valid(); iter.advance()) {
+        Result desc = iter.get();
+        this.add(hr, desc);
+        if(desc instanceof HierarchicalResult) {
+          ((HierarchicalResult) desc).setHierarchy(this);
+        }
+      }
+    }
+    fireResultAdded(child, parent);
+    return changed;
+  }
+
+  @Override
+  public boolean remove(Result parent, Result child) {
+    boolean changed = super.remove(parent, child);
+    fireResultRemoved(child, parent);
+    return changed;
+  }
+
+  /**
+   * Register a result listener.
+   *
+   * @param listener Result listener.
+   */
+  public void addResultListener(ResultListener listener) {
+    listenerList.add(listener);
+  }
+
+  /**
+   * Remove a result listener.
+   *
+   * @param listener Result listener.
+   */
+  public void removeResultListener(ResultListener listener) {
+    listenerList.remove(listener);
+  }
+
+  /**
+   * Signal that a result has changed (public API)
+   *
+   * @param res Result that has changed.
+   */
+  public void resultChanged(Result res) {
+    fireResultChanged(res);
+  }
+
+  /**
+   * Informs all registered {@link ResultListener} that a new result was added.
+   *
+   * @param child New child result added
+   * @param parent Parent result that was added to
+   */
+  private void fireResultAdded(Result child, Result parent) {
+    if(LOG.isDebugging()) {
+      LOG.debug("Result added: " + child + " <- " + parent);
+    }
+    for(int i = listenerList.size(); --i >= 0;) {
+      listenerList.get(i).resultAdded(child, parent);
+    }
+  }
+
+  /**
+   * Informs all registered {@link ResultListener} that a result has changed.
+   *
+   * @param current Result that has changed
+   */
+  private void fireResultChanged(Result current) {
+    if(LOG.isDebugging()) {
+      LOG.debug("Result changed: " + current);
+    }
+    for(int i = listenerList.size(); --i >= 0;) {
+      listenerList.get(i).resultChanged(current);
+    }
+  }
+
+  /**
+   * Informs all registered {@link ResultListener} that a new result has been
+   * removed.
+   *
+   * @param child result that has been removed
+   * @param parent Parent result that has been removed
+   */
+  private void fireResultRemoved(Result child, Result parent) {
+    if(LOG.isDebugging()) {
+      LOG.debug("Result removed: " + child + " <- " + parent);
+    }
+    for(int i = listenerList.size(); --i >= 0;) {
+      listenerList.get(i).resultRemoved(child, parent);
+    }
+  }
+}