001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/graphics/Selector.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.graphics;
038    
039    import org.deegree.model.spatialschema.Envelope;
040    import org.deegree.model.spatialschema.Position;
041    
042    /**
043     *
044     * <p>
045     * ------------------------------------------------------------------------
046     * </p>
047     *
048     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
049     * @version $Revision: 18195 $ $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
050     */
051    public interface Selector {
052    
053        /**
054         * adds a Theme to the Selector that shall be notified if something happens.
055         * @param theme to add.
056         */
057        void addTheme( Theme theme );
058    
059        /**
060         * @param theme to be removed
061         * @see Selector#addTheme(Theme)
062         */
063        void removeTheme( Theme theme );
064    
065        /**
066         * selects all features (display elements) that are located within the submitted bounding box.
067         * @param boundingbox to select all features within
068         *
069         * @return id's of the selected features (display elements)
070         */
071        String[] select( Envelope boundingbox );
072    
073        /**
074         * selects all features (display elements) that intersects the submitted point. if a feature is
075         * already selected it remains selected.
076         * @param position to select the features with.
077         *
078         * @return id's of the selected features (display elements)
079         */
080        String[] select( Position position );
081    
082        /**
083         * selects all features (display elements) that are located within the circle described by the
084         * position and the radius. if a feature is already selected it remains selected.
085         * @param position to select al features
086         * @param radius around the given position
087         *
088         * @return id's of the selected features (display elements)
089         */
090        String[] select( Position position, double radius );
091    
092        /**
093         * selects all features (display elements) that are specified by the submitted ids. if a feature
094         * is already selected it remains selected.
095         * @param ids to select
096         *
097         * @return ids of the selected features (display elements)
098         */
099        String[] select( String[] ids );
100    
101        /**
102         * inverts the current selection.
103         * @return the id's of the inverted selection
104         */
105        String[] invertSelection();
106    
107        /**
108         * mark all features as unselected
109         */
110        void reset();
111    
112    }