001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/tags/2.1/src/org/deegree/model/spatialschema/MultiPoint.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 *
049 * The interface defines the access to a aggregations of
050 * <tt>Point</tt> objects.
051 *
052 * <p>-----------------------------------------------------</p>
053 *
054 * @author Andreas Poth
055 * @version $Revision: 6259 $ $Date: 2007-03-20 10:15:15 +0100 (Di, 20 Mär 2007) $
056 * <p>
057 */
058 public interface MultiPoint extends MultiPrimitive {
059 /**
060 * @link aggregation
061 * @clientCardinality 0..*
062 */
063
064 /**
065 * adds a Point to the aggregation
066 */
067 public void addPoint(Point gmp);
068
069 /**
070 * inserts a Point into the aggregation. all elements with an index
071 * equal or larger index will be moved. if index is
072 * larger then getSize() - 1 or smaller then 0 or gmp equals null
073 * an exception will be thrown.
074 *
075 * @param gmp Point to insert.
076 * @param index position where to insert the new Point
077 */
078 public void insertPointAt(Point gmp, int index) throws GeometryException;
079
080 /**
081 * sets the submitted Point at the submitted index. the element
082 * at the position <code>index</code> will be removed. if index is
083 * larger then getSize() - 1 or smaller then 0 or gmp equals null
084 * an exception will be thrown.
085 *
086 * @param gmp Point to set.
087 * @param index position where to set the new Point
088 */
089 public void setPointAt(Point gmp, int index) throws GeometryException;
090
091 /**
092 * removes the submitted Point from the aggregation
093 *
094 * @return the removed Point
095 */
096 public Point removePoint(Point gmp) ;
097
098 /**
099 * removes the Point at the submitted index from the aggregation.
100 * if index is larger then getSize() - 1 or smaller then 0
101 * an exception will be thrown.
102 *
103 * @return the removed Point
104 */
105 public Point removePointAt(int index) throws GeometryException;
106
107 /**
108 * returns the Point at the submitted index.
109 */
110 public Point getPointAt(int index);
111
112 /**
113 * returns all Points as array
114 */
115 public Point[] getAllPoints();
116
117
118 }
119 /* ********************************************************************
120 Changes to this class. What the people have been up to:
121 $Log$
122 Revision 1.5 2006/07/12 14:46:15 poth
123 comment footer added
124
125 ********************************************************************** */