com.conversantmedia.util.collection.spatial.Node Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rtree Show documentation
Conversant RTree - N dimensional spatial index
There is a newer version: 1.0.5
package com.conversantmedia.util.collection.spatial;

/*
 * #%L
 * Conversant RTree
 * ~~
 * Conversantmedia.com © 2016, Conversant, Inc. Conversant® is a trademark of Conversant, Inc.
 * ~~
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import java.util.function.Consumer;

/**
 * Created by jcairns on 4/30/15.
 */
interface Node {

    /**
     * @return boolean - true if this node is a leaf
     */
    boolean isLeaf();

    /**
     * @return Rect - the bounding rectangle for this node
     */
    HyperRect getBound();

    /**
     * Add t to the index
     *
     * @param t - value to add to index
     */
    Node add(T t);

    /**
     * Remove t from the index
     *
     * @param t - value to remove from index
     */
    Node remove(T t);

    /**
     * update an existing t in the index
     *
     * @param told - old index to be updated
     * @param tnew - value to update old index to
     */
    Node update(T told, T tnew);

    /**
     * Search for rect within this node
     *
     * @param rect - HyperRect to search for
     * @param t - array of found results
     * @param n - total result count so far (from recursive call)
     * @return result count from search of this node
     */
    int search(HyperRect rect, T[] t, int n);

    /**
     * Visitor pattern:
     *
     * Consumer "accepts" every node contained by the given rect
     *
     * @param rect - limiting rect
     * @param consumer
     */
    void search(HyperRect rect, Consumer consumer);

    /**
     * intersect rect with this node
     *
     * @param rect - HyperRect to search for
     * @param t - array of found results
     * @param n - total result count so far (from recursive call)
     * @return result count from search of this node
     */
    int intersects(HyperRect rect, T[] t, int n);

    /**
     * Visitor pattern:
     *
     * Consumer "accepts" every node intersecting the given rect
     *
     * @param rect - limiting rect
     * @param consumer
     */
    void intersects(HyperRect rect, Consumer consumer);


    /**
     *
     * @param rect
     * @param t
     * @return boolean true if subtree contains t
     */
    boolean contains(HyperRect rect, T t);

    /**
     * The number of entries in the node
     *
     * @return int - entry count
     */
    int size();

    /**
     * The number of entries in the subtree
     *
     * @return int - entry count
     */
    int totalSize();

    /**
     * Consumer "accepts" every node in the entire index
     *
     * @param consumer
     */
    void forEach(Consumer consumer);

    /**
     * Recurses over index collecting stats
     *
     * @param stats - Stats object being populated
     * @param depth - current depth in tree
     */
    void collectStats(Stats stats, int depth);

    /**
     * Visits node, wraps it in an instrumented node, (see CounterNode)
     *
     * @return instrumented node wrapper
     */
    Node instrument();

}