001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/io/quadtree/Node.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2008 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
049 /**
050 * TODO add documentation here
051 *
052 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth </a>
053 * @author last edited by: $Author: apoth $
054 *
055 * @version $Revision: 9342 $, $Date: 2007-12-27 13:32:57 +0100 (Do, 27 Dez 2007) $
056 */
057 interface Node<T> {
058
059 /**
060 * @return the id of the Node
061 */
062 public String getId();
063
064 /**
065 * inserts a new item into the quadtree
066 *
067 * @param item (or it's id) which shall be inserted into the quadtree.
068 * @param itemEnv the bbox of the item
069 * @return true if the insertion occurred false otherwise.
070 * @throws Exception if an error occurred while inserting the specified node.
071 */
072 public boolean insert( T item, Envelope itemEnv )
073 throws Exception;
074
075 /**
076 * returns a List containing all items whose envelope intersects with the passed one
077 *
078 * @param searchEnv
079 * @param visitor
080 * @param level
081 *
082 * @return a List containing all items whose envelope intersects with the passed one
083 * @throws Exception if an error occurred while acquiring all nodes.
084 */
085 public List<T> query( Envelope searchEnv, List<T> visitor, int level )
086 throws Exception;
087
088 /**
089 * deletes a specific item from the tree (not the item itself will be deleted, just its
090 * reference will be.
091 *
092 * @param item (or it's ide) to be deleted
093 * @param itemsEnvelope bbox of the item
094 * @return true if the deletion occurred false otherwise.
095 * @throws Exception if an error occurred while deleting the specified node.
096 */
097 public boolean delete( T item, Envelope itemsEnvelope ) throws Exception;
098
099 /**
100 * Updates the spatial reference of the given item.
101 * @param item which spatial reference in the quadtree should be updated.
102 * @param newBBox newBBox the new BBoundingbox of the item.
103 * @return true if the update occurred, false otherwise
104 */
105 public boolean update( T item, Envelope newBBox );
106
107 /**
108 * deletes all references of items whose envelope intersects with the passed one (
109 *
110 * @see #delete(Object) )
111 * @param envelope
112 */
113 public void deleteRange( Envelope envelope );
114
115 }