001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/tags/2.1/src/org/deegree/io/quadtree/Node.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2007 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: 7845 $, $Date: 2007-07-25 09:45:35 +0200 (Mi, 25 Jul 2007) $
056 */
057 interface Node {
058
059 /**
060 * @return
061 */
062 public abstract String getId();
063
064 /**
065 * inserts a new item into the quadtree
066 *
067 * @param item
068 * @param itemEnv
069 * @throws IndexException
070 */
071 public abstract void insert( Object item, Envelope itemEnv )
072 throws IndexException;
073
074 /**
075 * returns a List containing all items whose envelope intersects with the passed one
076 *
077 * @param searchEnv
078 * @param visitor
079 * @param level
080 *
081 * @return a List containing all items whose envelope intersects with the passed one
082 * @throws IndexException
083 */
084 public abstract List<Object> query( Envelope searchEnv, List<Object> visitor, int level )
085 throws IndexException;
086
087 /**
088 * deletes a specific item from the tree (not the item itself will be deleted, just its
089 * reference will be)
090 *
091 * @param item
092 */
093 public abstract void deleteItem( Object item );
094
095 /**
096 * deletes all references of items whose envelope intersects with the passed one (
097 *
098 * @see #deleteItem(Object) )
099 * @param envelope
100 */
101 public abstract void deleteRange( Envelope envelope );
102
103 }