001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/tags/2.1/src/org/deegree/io/quadtree/Quadtree.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2006 by:
006 EXSE, Department of Geography, University of Bonn
007 http://www.giub.uni-bonn.de/deegree/
008 lat/lon GmbH
009 http://www.lat-lon.de
010
011 This library is free software; you can redistribute it and/or
012 modify it under the terms of the GNU Lesser General Public
013 License as published by the Free Software Foundation; either
014 version 2.1 of the License, or (at your option) any later version.
015
016 This library is distributed in the hope that it will be useful,
017 but WITHOUT ANY WARRANTY; without even the implied warranty of
018 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019 Lesser General Public License for more details.
020
021 You should have received a copy of the GNU Lesser General Public
022 License along with this library; if not, write to the Free Software
023 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
024
025 Contact:
026
027 Andreas Poth
028 lat/lon GmbH
029 Aennchenstr. 19
030 53177 Bonn
031 Germany
032 E-Mail: poth@lat-lon.de
033
034 Prof. Dr. Klaus Greve
035 Department of Geography
036 University of Bonn
037 Meckenheimer Allee 166
038 53115 Bonn
039 Germany
040 E-Mail: greve@giub.uni-bonn.de
041
042 ---------------------------------------------------------------------------*/
043 package org.deegree.io.quadtree;
044
045 import java.util.List;
046
047 import org.deegree.model.spatialschema.Envelope;
048 import org.deegree.model.spatialschema.Point;
049
050 /**
051 *
052 *
053 *
054 * @version $Revision: 6259 $
055 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
056 * @author last edited by: $Author: bezema $
057 *
058 * @version 1.0. $Revision: 6259 $, $Date: 2007-03-20 10:15:15 +0100 (Di, 20 Mär 2007) $
059 *
060 * @since 2.0
061 */
062 public interface Quadtree {
063
064 /**
065 * inserts a new item into the quadtree
066 *
067 * @param item
068 * @param envelope
069 */
070 public abstract void insert( Object item, Envelope envelope )
071 throws IndexException;
072
073 /**
074 * inserts a new item into the quadtree
075 *
076 * @param item
077 * @param point
078 */
079 public abstract void insert( Object item, Point point )
080 throws IndexException;
081
082 /**
083 * returns a List containing all items whose envelope intersects with the passed one
084 *
085 * @param envelope
086 * @return a List containing all items whose envelope intersects with the passed one
087 */
088 public abstract List query( Envelope envelope )
089 throws IndexException;
090
091 /**
092 * deletes a specific item from the tree (not the item itself will be deleted, just its
093 * reference will be)
094 *
095 * @param item
096 */
097 public abstract void deleteItem( Object item );
098
099 /**
100 * deletes all references of items whose envelope intersects with the passed one (
101 *
102 * @see #deleteItem(Object) )
103 * @param envelope
104 */
105 public abstract void deleteRange( Envelope envelope );
106
107 /**
108 *
109 * @return
110 */
111 public abstract int getDepth();
112
113 /**
114 * returns the bounding box covered by the quadtrees root node
115 *
116 * @return the bounding box covered by the quadtrees root node
117 * @throws IndexException
118 */
119 public abstract Envelope getRootBoundingBox()
120 throws IndexException;
121
122 }
123 /***************************************************************************************************
124 * <code>
125 Changes to this class. What the people have been up to:
126
127 $Log$
128 Revision 1.10 2007/01/26 14:40:07 wanhoff
129 fixed Javadoc @return tag and footer
130
131 Revision 1.9 2006/10/30 09:02:38 poth
132 implementation changed for optimized memory management for MemPointQuadtree
133
134 Revision 1.8 2006/10/20 07:56:00 poth
135 core methods extracted to interfaces
136
137 </code>
138 **************************************************************************************************/