/*
 * The JTS Topology Suite is a collection of Java classes that
 * implement the fundamental operations required to validate a given
 * geo-spatial data set to a known topological specification.
 *
 * Copyright (C) 2001 Vivid Solutions
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * For more information, contact:
 *
 *     Vivid Solutions
 *     Suite #1A
 *     2328 Government Street
 *     Victoria BC  V8T 5G5
 *     Canada
 *
 *     (250)385-6040
 *     www.vividsolutions.com
 */
package com.revolsys.geometry.index.bintree;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

/**
 * The base class for nodes in a {@link Bintree}.
 *
 * @version 1.7
 */
public abstract class NodeBase {

  /**
   * Returns the index of the subnode that wholely contains the given interval.
   * If none does, returns -1.
   */
  public static int getSubnodeIndex(final Interval interval, final double centre) {
    int subnodeIndex = -1;
    if (interval.min >= centre) {
      subnodeIndex = 1;
    }
    if (interval.max <= centre) {
      subnodeIndex = 0;
    }
    return subnodeIndex;
  }

  protected List items = new ArrayList();

  /**
   * subnodes are numbered as follows:
   *
   *  0 | 1
   */
  protected Node[] subnode = new Node[2];

  public NodeBase() {
  }

  public void add(final Object item) {
    this.items.add(item);
  }

  public List addAllItems(final List items) {
    items.addAll(this.items);
    for (int i = 0; i < 2; i++) {
      if (this.subnode[i] != null) {
        this.subnode[i].addAllItems(items);
      }
    }
    return items;
  }

  /**
   * Adds items in the tree which potentially overlap the query interval
   * to the given collection.
   * If the query interval is <tt>null</tt>, add all items in the tree.
   *
   * @param interval a query nterval, or null
   * @param resultItems the candidate items found
   */
  public void addAllItemsFromOverlapping(final Interval interval, final Collection resultItems) {
    if (interval != null && !isSearchMatch(interval)) {
      return;
    }

    // some of these may not actually overlap - this is allowed by the bintree
    // contract
    resultItems.addAll(this.items);

    if (this.subnode[0] != null) {
      this.subnode[0].addAllItemsFromOverlapping(interval, resultItems);
    }
    if (this.subnode[1] != null) {
      this.subnode[1].addAllItemsFromOverlapping(interval, resultItems);
    }
  }

  int depth() {
    int maxSubDepth = 0;
    for (int i = 0; i < 2; i++) {
      if (this.subnode[i] != null) {
        final int sqd = this.subnode[i].depth();
        if (sqd > maxSubDepth) {
          maxSubDepth = sqd;
        }
      }
    }
    return maxSubDepth + 1;
  }

  public List getItems() {
    return this.items;
  }

  public boolean hasChildren() {
    for (int i = 0; i < 2; i++) {
      if (this.subnode[i] != null) {
        return true;
      }
    }
    return false;
  }

  public boolean hasItems() {
    return !this.items.isEmpty();
  }

  public boolean isPrunable() {
    return !(hasChildren() || hasItems());
  }

  protected abstract boolean isSearchMatch(Interval interval);

  int nodeSize() {
    int subSize = 0;
    for (int i = 0; i < 2; i++) {
      if (this.subnode[i] != null) {
        subSize += this.subnode[i].nodeSize();
      }
    }
    return subSize + 1;
  }

  /**
   * Removes a single item from this subtree.
   *
   * @param itemInterval the envelope containing the item
   * @param item the item to remove
   * @return <code>true</code> if the item was found and removed
   */
  public boolean remove(final Interval itemInterval, final Object item) {
    // use interval to restrict nodes scanned
    if (!isSearchMatch(itemInterval)) {
      return false;
    }

    boolean found = false;
    for (int i = 0; i < 2; i++) {
      if (this.subnode[i] != null) {
        found = this.subnode[i].remove(itemInterval, item);
        if (found) {
          // trim subtree if empty
          if (this.subnode[i].isPrunable()) {
            this.subnode[i] = null;
          }
          break;
        }
      }
    }
    // if item was found lower down, don't need to search for it here
    if (found) {
      return found;
    }
    // otherwise, try and remove the item from the list of items in this node
    found = this.items.remove(item);
    return found;
  }

  int size() {
    int subSize = 0;
    for (int i = 0; i < 2; i++) {
      if (this.subnode[i] != null) {
        subSize += this.subnode[i].size();
      }
    }
    return subSize + this.items.size();
  }

}