001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/model/spatialschema/MultiSurface.java $
002    /*----------------------------------------------------------------------------
003     This file is part of deegree, http://deegree.org/
004     Copyright (C) 2001-2009 by:
005       Department of Geography, University of Bonn
006     and
007       lat/lon GmbH
008    
009     This library is free software; you can redistribute it and/or modify it under
010     the terms of the GNU Lesser General Public License as published by the Free
011     Software Foundation; either version 2.1 of the License, or (at your option)
012     any later version.
013     This library is distributed in the hope that it will be useful, but WITHOUT
014     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016     details.
017     You should have received a copy of the GNU Lesser General Public License
018     along with this library; if not, write to the Free Software Foundation, Inc.,
019     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020    
021     Contact information:
022    
023     lat/lon GmbH
024     Aennchenstr. 19, 53177 Bonn
025     Germany
026     http://lat-lon.de/
027    
028     Department of Geography, University of Bonn
029     Prof. Dr. Klaus Greve
030     Postfach 1147, 53001 Bonn
031     Germany
032     http://www.geographie.uni-bonn.de/deegree/
033    
034     e-mail: info@deegree.org
035    ----------------------------------------------------------------------------*/
036    
037    package org.deegree.model.spatialschema;
038    
039    /**
040     *
041     * This Interface defines the Aggregation of Surfaces. The implementing class should encapsulate a java.util.Vector or a
042     * comparative data structure.
043     *
044     * <p>
045     * -----------------------------------------------------
046     * </p>
047     *
048     * @author Andreas Poth
049     * @version $Revision: 18195 $ $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
050     *          <p>
051     */
052    
053    public interface MultiSurface extends MultiPrimitive {
054    
055        /**
056         * adds an Surface to the aggregation
057         *
058         * @param surface
059         */
060        public void addSurface( Surface surface );
061    
062        /**
063         * inserts a Surface in the aggregation. all elements with an index equal or larger index will be moved. if index is
064         * larger then getSize() - 1 or smaller then 0 or surface equals null an exception will be thrown.
065         *
066         * @param surface
067         *            Surface to insert.
068         * @param index
069         *            position where to insert the new Surface
070         * @throws GeometryException
071         */
072        public void insertSurfaceAt( Surface surface, int index )
073                                throws GeometryException;
074    
075        /**
076         * sets the submitted Surface at the submitted index. the element at the position <code>index</code> will be
077         * removed. if index is larger then getSize() - 1 or smaller then 0 or surface equals null an exception will be
078         * thrown.
079         *
080         * @param surface
081         *            Surface to set.
082         * @param index
083         *            position where to set the new Surface
084         * @throws GeometryException
085         */
086        public void setSurfaceAt( Surface surface, int index )
087                                throws GeometryException;
088    
089        /**
090         * removes the submitted Surface from the aggregation
091         *
092         * @param surface
093         *
094         * @return the removed Surface
095         */
096        public Surface removeSurface( Surface surface );
097    
098        /**
099         * removes the Surface at the submitted index from the aggregation. if index is larger then getSize() - 1 or smaller
100         * then 0 an exception will be thrown.
101         *
102         * @param index
103         *
104         * @return the removed Surface
105         * @throws GeometryException
106         */
107        public Surface removeSurfaceAt( int index )
108                                throws GeometryException;
109    
110        /**
111         * returns the Surface at the submitted index.
112         *
113         * @param index
114         * @return the Surface at the submitted index.
115         */
116        public Surface getSurfaceAt( int index );
117    
118        /**
119         * returns all Surfaces as an array
120         *
121         * @return all Surfaces as an array
122         */
123        public Surface[] getAllSurfaces();
124    
125        /**
126         * returns the area of a MultiSurface
127         *
128         * @return the area of a MultiSurface
129         */
130        public double getArea();
131    
132    }