/[schmitzm]/trunk/src/skrueger/geotools/MapContextManagerInterface.java
ViewVC logotype

Diff of /trunk/src/skrueger/geotools/MapContextManagerInterface.java

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 127 by mojays, Sat May 30 14:29:58 2009 UTC revision 685 by alfonx, Wed Feb 10 15:04:02 2010 UTC
# Line 1  Line 1 
1  package skrueger.geotools;  /*******************************************************************************
2  import java.util.List;   * Copyright (c) 2009 Martin O. J. Schmitz.
3     *
4  import org.geotools.map.MapContext;   * This file is part of the SCHMITZM library - a collection of utility
5  import org.geotools.map.MapLayer;   * classes based on Java 1.6, focusing (not only) on Java Swing
6  import org.geotools.map.event.MapLayerListListener;   * and the Geotools library.
7  import org.geotools.map.event.MapLayerListener;   *
8     * The SCHMITZM project is hosted at:
9  import skrueger.AttributeMetaData;   * http://wald.intevation.org/projects/schmitzm/
10  import skrueger.RasterLegendData;   *
11     * This program is free software; you can redistribute it and/or
12  /**   * modify it under the terms of the GNU Lesser General Public License
13   * Implementations of this class can can be used to fill/insert/remove a mapContext   * as published by the Free Software Foundation; either version 3
14   * with {@link StyledMapInterface} objects.   * of the License, or (at your option) any later version.
15   *   *
16   * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>   * This program is distributed in the hope that it will be useful,
17   *   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   */   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  public interface MapContextManagerInterface {   * GNU General Public License for more details.
20     *
21          /**   * You should have received a copy of the GNU Lesser General Public License (license.txt)
22           * Add a {@link StyledMapInterface} object into the underlying {@link MapContext}   * along with this program; if not, write to the Free Software
23           * as the topmost layer   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
24           *   * or try this link: http://www.gnu.org/licenses/lgpl.html
25           * @param styledMapObject Obejct to add to the layer   *
26           */   * Contributors:
27          boolean addStyledLayer (StyledMapInterface<?> styledMapObject);   *     Martin O. J. Schmitz - initial API and implementation
28     *     Stefan A. Krüger - additional utility classes
29          /**   ******************************************************************************/
30           * @param mapContextIdx Index in the mapcontext, bottom first  package skrueger.geotools;
31           * @return sucessful?  import java.util.List;
32           */  
33          boolean removeStyledLayer (int mapContextIdx);  import org.geotools.map.MapContext;
34    import org.geotools.map.MapLayer;
35          /**  import org.geotools.map.event.MapLayerListListener;
36           * Inserts a {@link StyledMapInterface} object into the underlying {@link MapContext}  
37           * at the given position  import skrueger.AttributeMetadata;
38           */  import skrueger.RasterLegendData;
39          boolean insertStyledLayer (StyledMapInterface<?> styledMapObject, int mapContextIdx);  
40    /**
41          /** Add {@link MapLayerListener} */   * Implementations of this class can can be used to fill/insert/remove a mapContext
42          void addMapLayerListListener( MapLayerListListener listener);   * with {@link StyledLayerInterface} objects.
43     *
44          /** Remove {@link MapLayerListener} */   * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
45          void removeMapLayerListListener( MapLayerListListener listener);   *
46     */
47          /**  public interface MapContextManagerInterface {
48           * Help the GC by disposing this Component  
49           */          /**
50          void dispose();           * Add a {@link StyledLayerInterface} object into the underlying {@link MapContext}
51             * as the topmost layer
52          /**           *
53           * Returns a ordered list of the layers that are contained in the underlying {@link MapContext}           * @param styledLayer Layer to add to the map
54           */           */
55          List<StyledMapInterface<?>> getStyledObjects();          boolean addStyledLayer (StyledLayerInterface<?> styledLayer);
56    
57          /**          /**
58           * Returns a list of {@link AttributeMetaData} that shall be shown (e.g. when the Mouse clicked into the map)           * @param mapContextIdx Index in the {@link MapContext}, bottom first
59           * Returns an empty list if the layer doesn't exist or is not backed by a {@link StyledFeatureCollectionInterface}           * @return successful?
60           */           */
61          List<AttributeMetaData> getVisibleAttribsFor(MapLayer layer);          boolean removeStyledLayer (int mapContextIdx);
62    
63          /**          /**
64           * Returns the title of the layer           * Inserts a {@link StyledLayerInterface} object into the underlying {@link MapContext}
65           * @param layer {@link MapLayer}           * at the given position
66           * @return null, if the layer is unknown           */
67           */          boolean insertStyledLayer (StyledLayerInterface<?> styledLayer, int mapContextIdx);
68          String getTitleFor(MapLayer layer);  
69            /** Add {@link MapLayerListListener} */
70          /**          void addMapLayerListListener( MapLayerListListener listener);
71           * Returns the description of the layer  
72           * @param layer {@link MapLayer}          /** Remove {@link MapLayerListListener} */
73           * @return null, if the layer is unknown. Empty String if the description is empty          void removeMapLayerListListener( MapLayerListListener listener);
74           */  
75          String getDescFor(MapLayer layer);          /**
76             * Help the GC by disposing this Component
77          /**           */
78           * Returns the {@link RasterLegendData} object for the layer.          void dispose();
79           * @return null, if the layer is not found or of type raster  
80           */          /**
81          RasterLegendData getLegendMetaData(MapLayer layer);           * Returns a ordered list of the layers that are contained in the underlying {@link MapContext}
82             */
83          /**          List<StyledLayerInterface<?>> getStyledObjects();
84           * Ruturns the {@link StyledMapInterface} object that is associated with the layer or NULL if the layer can't be found.  
85           */          /**
86          StyledMapInterface<?> getStyledObjectFor(MapLayer layer);           * Returns a list of {@link AttributeMetadata} that shall be shown (e.g. when the Mouse clicked into the map)
87  }           * Returns an empty list if the layer doesn't exist or is not backed by a {@link StyledFeatureCollectionInterface}
88             */
89            List<AttributeMetadata> getVisibleAttribsFor(MapLayer mapLayer);
90    
91            /**
92             * Returns the title of the layer
93             * @param mapLayer {@link MapLayer}
94             * @return <code>null</code>, if the layer is unknown
95             */
96            String getTitleFor(MapLayer mapLayer);
97    
98            /**
99             * Returns the description of the layer
100             * @param mapLayer {@link MapLayer}
101             * @return <code>null</code>, if the layer is unknown. Empty String if the description is empty
102             */
103            String getDescFor(MapLayer mapLayer);
104    
105            /**
106             * Returns the {@link RasterLegendData} object for the layer.
107             * @return null, if the layer is not found or of type raster
108             */
109            RasterLegendData getLegendMetaData(MapLayer mapLayer);
110    
111            /**
112             * Returns the {@link StyledLayerInterface} object that is associated with the layer or NULL if the layer can't be found.
113             */
114            StyledLayerInterface<?> getStyledObjectFor(MapLayer layer);
115            
116            /**
117             * @return The {@link MapContext} managed by this {@link MapContextManagerInterface}
118             */
119            MapContext getMapContext();
120    
121    }
Legend:
Removed from v.127  
changed lines
  Added in v.685
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26