org.geotools.index.rtree
Class RTree

Object
  extended by RTree

public class RTree
extends Object

Relational index.

Author:
Tommaso Nolli
Module:
trunk/gt/modules   (gt-modules.jar) (Maven report) (SVN head)

Constructor Summary
RTree(PageStore store)
           
 
Method Summary
 void close()
          Closes this index and the associated PageStore
 void delete(Envelope env)
          Deletes the entry with the specified Envelope as its bounds.
 Envelope getBounds()
          Gets this index bounding box
 Envelope getBounds(Filter filter)
          Returns the maxiumal boudns for the provided filter.
 DataDefinition getDataDefinition()
           
 void insert(Envelope bounds, Data data)
          DOCUMENT ME!
 List search(Envelope query)
          Performs a search on this RTree
 List search(Filter filter)
          Performs a search on this RTree
 String toString()
           
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RTree

public RTree(PageStore store)
      throws TreeException
Throws:
TreeException
Method Detail

getBounds

public Envelope getBounds()
                   throws TreeException
Gets this index bounding box

Returns:
An Envelope
Throws:
TreeException - DOCUMENT ME!

getBounds

public Envelope getBounds(Filter filter)
                   throws TreeException,
                          UnsupportedFilterException
Returns the maxiumal boudns for the provided filter.

This method will try and produce a filter for the provided bounds, see ExtractBoundsFilterVisitor.BOUNDS_VISITOR for details of generation.

Parameters:
filter -
Throws:
TreeException
UnsupportedFilterException - For Filter.EXCLUDES

getDataDefinition

public DataDefinition getDataDefinition()

search

public List search(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 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(Envelope bounds,
                   Data data)
            throws TreeException,
                   LockTimeoutException
DOCUMENT ME!

Parameters:
bounds -
data -
Throws:
TreeException
LockTimeoutException

delete

public void delete(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 String toString()
Overrides:
toString in class Object
See Also:
Object.toString()


Copyright © 1996-2009 Geotools. All Rights Reserved.