001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/tags/2.1/src/org/deegree/model/spatialschema/Aggregate.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 53115 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 ---------------------------------------------------------------------------*/
044
045 package org.deegree.model.spatialschema;
046
047
048 import java.util.Iterator;
049
050 /**
051 *
052 * This interface defines the basis functionallity of all geometry
053 * aggregations. it will be specialized for the use of primitive,
054 * and solid geometries.
055 *
056 * <p>-----------------------------------------------------</p>
057 *
058 * @author Andreas Poth
059 * @version $Revision: 6259 $ $Date: 2007-03-20 10:15:15 +0100 (Di, 20 Mär 2007) $
060 * <p>
061 */
062
063 public interface Aggregate extends Geometry {
064
065 /**
066 * returns the number of Geometry within the aggregation
067 */
068 int getSize();
069
070 /**
071 * merges two aggregation.
072 *
073 * @exception GeometryException a GeometryException will be thrown if the submitted
074 * isn't the same type as the recieving one.
075 */
076 void merge(Aggregate aggregate) throws GeometryException;
077
078 /**
079 * adds an Geometry to the aggregation
080 */
081 void add(Geometry gmo);
082
083 /**
084 * inserts a Geometry in the aggregation. all elements with an index
085 * equal or larger index will be moved. if index is
086 * larger then getSize() - 1 an exception will be thrown.
087 *
088 * @param gmo Geometry to insert.
089 * @param index position where to insert the new Geometry
090 */
091 void insertObjectAt(Geometry gmo, int index) throws GeometryException;
092
093 /**
094 * sets the submitted Geometry at the submitted index. the element
095 * at the position <code>index</code> will be removed. if index is
096 * larger then getSize() - 1 an exception will be thrown.
097 *
098 * @param gmo Geometry to set.
099 * @param index position where to set the new Geometry
100 */
101 void setObjectAt(Geometry gmo, int index) throws GeometryException;
102
103 /**
104 * removes the submitted Geometry from the aggregation
105 *
106 * @return the removed Geometry
107 */
108 Geometry removeObject(Geometry gmo);
109
110 /**
111 * removes the Geometry at the submitted index from the aggregation.
112 * if index is larger then getSize() - 1 an exception will be thrown.
113 *
114 * @return the removed Geometry
115 */
116 Geometry removeObjectAt(int index) throws GeometryException;
117
118 /**
119 * removes all Geometry from the aggregation.
120 */
121 void removeAll();
122
123 /**
124 * returns the Geometry at the submitted index.
125 */
126 Geometry getObjectAt(int index);
127
128 /**
129 * returns all Geometries as array
130 */
131 Geometry[] getAll();
132
133 /**
134 * returns true if the submitted Geometry is within the aggregation
135 */
136 boolean isMember(Geometry gmo);
137
138 /**
139 * returns the aggregation as an iterator
140 */
141 Iterator getIterator();
142
143
144 }
145 /* ********************************************************************
146 Changes to this class. What the people have been up to:
147 $Log$
148 Revision 1.5 2006/07/12 14:46:15 poth
149 comment footer added
150
151 ********************************************************************** */