org.geotools.index.rtree
Class RTree

java.lang.Object
  org.geotools.index.rtree.RTree

public class RTree

extends java.lang.Object

DOCUMENT ME!

Author:

Tommaso Nolli

Constructor Summary

RTree(PageStore store)

Method Summary

void	close() Closes this index and the associated PageStore
void	delete(com.vividsolutions.jts.geom.Envelope env) Deletes the entry with the specified Envelope as its bounds.
com.vividsolutions.jts.geom.Envelope	getBounds() Gets this index bounding box
com.vividsolutions.jts.geom.Envelope	getBounds(Filter filter) DOCUMENT ME!
DataDefinition	getDataDefinition()
void	insert(com.vividsolutions.jts.geom.Envelope bounds, Data data) DOCUMENT ME!
java.util.List	search(com.vividsolutions.jts.geom.Envelope query) Performs a search on this RTree
java.util.List	search(Filter filter) Performs a search on this RTree
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RTree

public RTree(PageStore store)
      throws TreeException

Method Detail

getBounds

public com.vividsolutions.jts.geom.Envelope getBounds()
                                               throws TreeException

Gets this index bounding box

Returns:

An Envelope

Throws:

TreeException - DOCUMENT ME!

getBounds

public com.vividsolutions.jts.geom.Envelope getBounds(Filter filter)
                                               throws TreeException,
                                                      UnsupportedFilterException

DOCUMENT ME!

Parameters:

filter -

Returns:

Throws:

TreeException

UnsupportedFilterException

getDataDefinition

public DataDefinition getDataDefinition()

search

public java.util.List search(com.vividsolutions.jts.geom.Envelope query)
                      throws TreeException,
                             LockTimeoutException

Performs a search on this RTree

Parameters:

query - the query Envelope

Returns:

a Collection of Data

Throws:

TreeException - DOCUMENT ME!

LockTimeoutException - DOCUMENT ME!

search

public java.util.List search(Filter filter)
                      throws TreeException,
                             UnsupportedFilterException,
                             LockTimeoutException

Performs a search on this RTree

Parameters:

filter - a Filter

Returns:

a Collection of Data

Throws:

TreeException

UnsupportedFilterException - DOCUMENT ME!

LockTimeoutException - DOCUMENT ME!

insert

public void insert(com.vividsolutions.jts.geom.Envelope bounds,
                   Data data)
            throws TreeException,
                   LockTimeoutException

DOCUMENT ME!

Parameters:

bounds -

data -

Throws:

TreeException

LockTimeoutException

delete

public void delete(com.vividsolutions.jts.geom.Envelope env)
            throws TreeException,
                   LockTimeoutException

Deletes the entry with the specified Envelope as its bounds.
If more than one entry exists with the same bounds, then subsequent calls to delete are needed to remove all this elements.

Parameters:

env - The Envelope

Throws:

TreeException

LockTimeoutException - DOCUMENT ME!

close

public void close()
           throws TreeException

Closes this index and the associated PageStore

Throws:

TreeException

toString

public java.lang.String toString()

See Also:

Object.toString()