001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/model/feature/FeatureCollection.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 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 package org.deegree.model.feature;
044
045 import java.util.Iterator;
046
047 /**
048 *
049 *
050 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
051 * @author last edited by: $Author: apoth $
052 *
053 * @version $Revision: 9343 $, $Date: 2007-12-27 14:30:32 +0100 (Do, 27 Dez 2007) $
054 */
055 public interface FeatureCollection extends Feature {
056
057 /**
058 * removes all features from a collection
059 *
060 */
061 public void clear();
062
063 /**
064 * returns the feature at the submitted index
065 */
066 public Feature getFeature( int index );
067
068 /**
069 * returns the feature identified by it's id
070 */
071 public Feature getFeature( String id );
072
073 /**
074 * returns an array of all features
075 */
076 public Feature[] toArray();
077
078 /**
079 * returns an <tt>Iterator</tt> on the feature contained in a collection
080 *
081 * @return an <tt>Iterator</tt> on the feature contained in a collection
082 */
083 public Iterator<Feature> iterator();
084
085 /**
086 * adds a feature to the collection
087 */
088 public void add( Feature feature );
089
090 /**
091 * adds a list of features to the collection
092 */
093 public void addAll( Feature[] feature );
094
095 /**
096 * adds a list of features to the collection
097 */
098 public void addAll( FeatureCollection feature );
099
100 /**
101 * removes the submitted feature from the collection
102 */
103 public Feature remove( Feature feature );
104
105 /**
106 * removes the feature at the submitted index from the collection
107 */
108 public Feature remove( int index );
109
110 /**
111 * removes the feature that is assigned to the submitted id. The removed feature will be
112 * returned. If no valid feature could be found null will be returned
113 */
114 public Feature remove( String id );
115
116 /**
117 * returns the number of features within the collection
118 */
119 public int size();
120 }