com.github.davidmoten.rtree

Class RTree.Builder

java.lang.Object

com.github.davidmoten.rtree.RTree.Builder

Enclosing class:

RTree<T,S extends Geometry>

public static class RTree.Builder
extends Object

RTree Builder.

Method Summary

Modifier and Type	Method and Description
<T,S extends Geometry> RTree<T,S>	create() Builds the RTree.
<T,S extends Geometry> RTree<T,S>	create(List<Entry<T,S>> entries) Create an RTree by bulk loading, using the STR method.
RTree.Builder	factory(Factory<?,? extends Geometry> factory)
RTree.Builder	loadingFactor(double factor) The factor is used as the fill ratio during bulk loading.
RTree.Builder	maxChildren(int maxChildren) Sets the max number of children in an R-tree node.
RTree.Builder	minChildren(int minChildren) When the number of children in an R-tree node drops below this number the node is deleted and the children are added on to the R-tree again.
RTree.Builder	selector(Selector selector) Sets the node Selector which decides which branches to follow when inserting or searching.
RTree.Builder	splitter(Splitter splitter) Sets the Splitter to use when maxChildren is reached.
RTree.Builder	star() Sets the splitter to SplitterRStar and selector to SelectorRStar and defaults to minChildren=10.

Methods inherited from class java.lang.Object

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

Method Detail

loadingFactor

public RTree.Builder loadingFactor(double factor)

The factor is used as the fill ratio during bulk loading.

Parameters:

factor - loading factor

Returns:

this

minChildren

public RTree.Builder minChildren(int minChildren)

When the number of children in an R-tree node drops below this number the node is deleted and the children are added on to the R-tree again.

Parameters:

minChildren - less than this number of children in a node triggers a redistribution of its children.

Returns:

builder

maxChildren

public RTree.Builder maxChildren(int maxChildren)

Sets the max number of children in an R-tree node.

Parameters:

maxChildren - max number of children in R-tree node.

Returns:

builder

splitter

public RTree.Builder splitter(Splitter splitter)

Sets the Splitter to use when maxChildren is reached.

Parameters:

splitter - node splitting method to use

Returns:

builder

selector

public RTree.Builder selector(Selector selector)

Sets the node Selector which decides which branches to follow when inserting or searching.

Parameters:

selector - selects the branch to follow when inserting or searching

Returns:

builder

star

public RTree.Builder star()

Sets the splitter to SplitterRStar and selector to SelectorRStar and defaults to minChildren=10.

Returns:

builder

factory

public RTree.Builder factory(Factory<?,? extends Geometry> factory)

create

public <T,S extends Geometry> RTree<T,S> create()

Builds the RTree.

Type Parameters:

T - value type

S - geometry type

Returns:

RTree

create

public <T,S extends Geometry> RTree<T,S> create(List<Entry<T,S>> entries)

Create an RTree by bulk loading, using the STR method. STR: a simple and efficient algorithm for R-tree packing http://ieeexplore.ieee.org/abstract/document/582015/

Note: this method mutates the input entries, the internal order of the List may be changed.

Parameters:

entries - entries to be added to the r-tree

Returns:

a loaded RTree