Package org.jungrapht.visualization.spatial.rtree

Class RTree<T>

java.lang.Object

org.jungrapht.visualization.spatial.rtree.RTree<T>

public class RTree<T>
extends Object

R-Tree or R*-Tree implementation, depending on the type of Splitters passed in the SplitterContext

Based on The R*-tree: An Efficient and Robust Access Method for Points and Rectangles+ Norbert Beckmann, Hans-Peter begel, Ralf Schneider, Bernhard Seeger Praktuche Informatlk, Umversltaet Bremen, D-2800 Bremen 33, West Germany

Author:

Tom Nelson

Method Summary

Modifier and Type	Method	Description
static <T> RTree<T>	add(RTree<T> rtree, SplitterContext<T> splitterContext, Map.Entry<T,Rectangle2D> entry)
static <T> RTree<T>	add(RTree<T> rtree, SplitterContext<T> splitterContext, T element, Rectangle2D bounds)	add one element to the RTree.
static <T> RTree<T>	addAll(RTree<T> rtree, SplitterContext<T> splitterContext, Collection<Map.Entry<T,Rectangle2D>> entries)
static <T> RTree<T>	bulkAdd(RTree<T> rtree, SplitterContext<T> splitterContext, Collection<Map.Entry<T,Rectangle2D>> items)
int	count()	count all the elements in the R-Tree
static <T> RTree<T>	create()	create and return an empty R-Tree
Collection<TreeNode>	getContainingLeafs(Point2D p)	get the R-Tree leaf nodes that would contain the passed point
Set<Shape>	getGrid()
T	getPickedObject(Point2D p)	return an object at point p
Optional<Node<T>>	getRoot()
static <T> RTree	reinsert(RTree<T> rtree, SplitterContext<T> splitterContext)
static <T> RTree<T>	remove(RTree<T> rtree, T element)	remove an element from the tree
static <T> RTree	removeForReinsert(RTree<T> rtree, Collection<Map.Entry<T,Rectangle2D>> removed)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getRoot

public Optional<Node<T>> getRoot()

Returns:

the root of the R-Tree

create

public static <T> RTree<T> create()

create and return an empty R-Tree

Type Parameters:

T -

Returns:

an empty R-Tree

addAll

public static <T> RTree<T> addAll(RTree<T> rtree,
                                  SplitterContext<T> splitterContext,
                                  Collection<Map.Entry<T,Rectangle2D>> entries)

add

public static <T> RTree<T> add(RTree<T> rtree,
                               SplitterContext<T> splitterContext,
                               Map.Entry<T,Rectangle2D> entry)

add

public static <T> RTree<T> add(RTree<T> rtree,
                               SplitterContext<T> splitterContext,
                               T element,
                               Rectangle2D bounds)

add one element to the RTree. Adding to the tree can result in a new

Parameters:

splitterContext - the R*Tree or R-Tree rules

element - to add to the tree

bounds - for the element to add

Returns:

a new RTree containing the added element

bulkAdd

public static <T> RTree<T> bulkAdd(RTree<T> rtree,
                                   SplitterContext<T> splitterContext,
                                   Collection<Map.Entry<T,Rectangle2D>> items)

removeForReinsert

public static <T> RTree removeForReinsert(RTree<T> rtree,
                                          Collection<Map.Entry<T,Rectangle2D>> removed)

reinsert

public static <T> RTree reinsert(RTree<T> rtree,
                                 SplitterContext<T> splitterContext)

remove

public static <T> RTree<T> remove(RTree<T> rtree,
                                  T element)

remove an element from the tree

Parameters:

element -

Returns:

getPickedObject

public T getPickedObject(Point2D p)

return an object at point p

Parameters:

p - point to search

Returns:

an element that contains p or null

getGrid

public Set<Shape> getGrid()

Returns:

a collection of rectangular bounds of the R-Tree nodes

getContainingLeafs

public Collection<TreeNode> getContainingLeafs(Point2D p)

get the R-Tree leaf nodes that would contain the passed point

Parameters:

p - the point to search

Returns:

a Collection of R-Tree nodes that would contain p

count

public int count()

count all the elements in the R-Tree

Returns:

the count

toString

public String toString()

Overrides:

toString in class Object