skrueger/geotools/MapContextManagerInterface.java

/*******************************************************************************
 * Copyright (c) 2009 Martin O. J. Schmitz.
 * 
 * This file is part of the SCHMITZM library - a collection of utility 
 * classes based on Java 1.6, focusing (not only) on Java Swing 
 * and the Geotools library.
 * 
 * The SCHMITZM project is hosted at:
 * http://wald.intevation.org/projects/schmitzm/
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License (license.txt)
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * or try this link: http://www.gnu.org/licenses/lgpl.html
 * 
 * Contributors:
 *     Martin O. J. Schmitz - initial API and implementation
 *     Stefan A. Krüger - additional utility classes
 ******************************************************************************/
package skrueger.geotools;
import java.util.List;

import org.geotools.map.MapContext;
import org.geotools.map.MapLayer;
import org.geotools.map.event.MapLayerListListener;
import org.geotools.map.event.MapLayerListener;

import skrueger.AttributeMetaData;
import skrueger.RasterLegendData;

/**
 * Implementations of this class can can be used to fill/insert/remove a mapContext
 * with {@link StyledLayerInterface} objects.
 *
 * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
 *
 */
public interface MapContextManagerInterface {

        /**
         * Add a {@link StyledLayerInterface} object into the underlying {@link MapContext}
         * as the topmost layer
         *
         * @param styledLayer Layer to add to the map
         */
        boolean addStyledLayer (StyledLayerInterface<?> styledLayer);

        /**
         * @param mapContextIdx Index in the {@link MapContext}, bottom first
         * @return successful?
         */
        boolean removeStyledLayer (int mapContextIdx);

        /**
         * Inserts a {@link StyledLayerInterface} object into the underlying {@link MapContext}
         * at the given position
         */
        boolean insertStyledLayer (StyledLayerInterface<?> styledLayer, int mapContextIdx);

        /** Add {@link MapLayerListener} */
        void addMapLayerListListener( MapLayerListListener listener);

        /** Remove {@link MapLayerListener} */
        void removeMapLayerListListener( MapLayerListListener listener);

        /**
         * Help the GC by disposing this Component
         */
        void dispose();

        /**
         * Returns a ordered list of the layers that are contained in the underlying {@link MapContext}
         */
        List<StyledLayerInterface<?>> getStyledObjects();

        /**
         * Returns a list of {@link AttributeMetaData} that shall be shown (e.g. when the Mouse clicked into the map)
         * Returns an empty list if the layer doesn't exist or is not backed by a {@link StyledFeatureCollectionInterface}
         */
        List<AttributeMetaData> getVisibleAttribsFor(MapLayer mapLayer);

        /**
         * Returns the title of the layer
         * @param mapLayer {@link MapLayer}
         * @return <code>null</code>, if the layer is unknown
         */
        String getTitleFor(MapLayer mapLayer);

        /**
         * Returns the description of the layer
         * @param mapLayer {@link MapLayer}
         * @return <code>null</code>, if the layer is unknown. Empty String if the description is empty
         */
        String getDescFor(MapLayer mapLayer);

        /**
         * Returns the {@link RasterLegendData} object for the layer.
         * @return null, if the layer is not found or of type raster
         */
        RasterLegendData getLegendMetaData(MapLayer mapLayer);

        /**
         * Returns the {@link StyledLayerInterface} object that is associated with the layer or NULL if the layer can't be found.
         */
        StyledLayerInterface<?> getStyledObjectFor(MapLayer layer);
        
        /**
         * @return The {@link MapContext} managed by this {@link MapContextManagerInterface} 
         */
        MapContext getMapContext();

}
1	alfonx	244	/*******************************************************************************
2			* Copyright (c) 2009 Martin O. J. Schmitz.
3			*
4			* This file is part of the SCHMITZM library - a collection of utility
5	alfonx	256	* classes based on Java 1.6, focusing (not only) on Java Swing
6	alfonx	244	* and the Geotools library.
7			*
8			* The SCHMITZM project is hosted at:
9			* http://wald.intevation.org/projects/schmitzm/
10			*
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			* as published by the Free Software Foundation; either version 3
14			* of the License, or (at your option) any later version.
15			*
16			* 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			* 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			* along with this program; if not, write to the Free Software
23			* 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			*
26			* Contributors:
27			* Martin O. J. Schmitz - initial API and implementation
28			* Stefan A. Krüger - additional utility classes
29			******************************************************************************/
30			package skrueger.geotools;
31			import java.util.List;
32
33			import org.geotools.map.MapContext;
34			import org.geotools.map.MapLayer;
35			import org.geotools.map.event.MapLayerListListener;
36			import org.geotools.map.event.MapLayerListener;
37
38			import skrueger.AttributeMetaData;
39			import skrueger.RasterLegendData;
40
41			/**
42			* Implementations of this class can can be used to fill/insert/remove a mapContext
43			* with {@link StyledLayerInterface} objects.
44			*
45			* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a>
46			*
47			*/
48			public interface MapContextManagerInterface {
49
50			/**
51			* Add a {@link StyledLayerInterface} object into the underlying {@link MapContext}
52			* as the topmost layer
53			*
54			* @param styledLayer Layer to add to the map
55			*/
56			boolean addStyledLayer (StyledLayerInterface<?> styledLayer);
57
58			/**
59			* @param mapContextIdx Index in the {@link MapContext}, bottom first
60			* @return successful?
61			*/
62			boolean removeStyledLayer (int mapContextIdx);
63
64			/**
65			* Inserts a {@link StyledLayerInterface} object into the underlying {@link MapContext}
66			* at the given position
67			*/
68			boolean insertStyledLayer (StyledLayerInterface<?> styledLayer, int mapContextIdx);
69
70			/** Add {@link MapLayerListener} */
71			void addMapLayerListListener( MapLayerListListener listener);
72
73			/** Remove {@link MapLayerListener} */
74			void removeMapLayerListListener( MapLayerListListener listener);
75
76			/**
77			* Help the GC by disposing this Component
78			*/
79			void dispose();
80
81			/**
82			* Returns a ordered list of the layers that are contained in the underlying {@link MapContext}
83			*/
84			List<StyledLayerInterface<?>> getStyledObjects();
85
86			/**
87			* Returns a list of {@link AttributeMetaData} that shall be shown (e.g. when the Mouse clicked into the map)
88			* Returns an empty list if the layer doesn't exist or is not backed by a {@link StyledFeatureCollectionInterface}
89			*/
90			List<AttributeMetaData> getVisibleAttribsFor(MapLayer mapLayer);
91
92			/**
93			* Returns the title of the layer
94			* @param mapLayer {@link MapLayer}
95			* @return <code>null</code>, if the layer is unknown
96			*/
97			String getTitleFor(MapLayer mapLayer);
98
99			/**
100			* Returns the description of the layer
101			* @param mapLayer {@link MapLayer}
102			* @return <code>null</code>, if the layer is unknown. Empty String if the description is empty
103			*/
104			String getDescFor(MapLayer mapLayer);
105
106			/**
107			* Returns the {@link RasterLegendData} object for the layer.
108			* @return null, if the layer is not found or of type raster
109			*/
110			RasterLegendData getLegendMetaData(MapLayer mapLayer);
111
112			/**
113			* Returns the {@link StyledLayerInterface} object that is associated with the layer or NULL if the layer can't be found.
114			*/
115			StyledLayerInterface<?> getStyledObjectFor(MapLayer layer);
116	alfonx	294
117			/**
118			* @return The {@link MapContext} managed by this {@link MapContextManagerInterface}
119			*/
120			MapContext getMapContext();
121
122	alfonx	244	}