skrueger/geotools/MapContextManagerInterface.java

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 StyledMapInterface} objects.
 *
 * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
 *
 */
public interface MapContextManagerInterface {

        /**
         * Add a {@link StyledMapInterface} object into the underlying {@link MapContext}
         * as the topmost layer
         *
         * @param styledMapObject Obejct to add to the layer
         */
        boolean addStyledLayer (StyledMapInterface<?> styledMapObject);

        /**
         * @param mapContextIdx Index in the mapcontext, bottom first
         * @return sucessful?
         */
        boolean removeStyledLayer (int mapContextIdx);

        /**
         * Inserts a {@link StyledMapInterface} object into the underlying {@link MapContext}
         * at the given position
         */
        boolean insertStyledLayer (StyledMapInterface<?> styledMapObject, 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<StyledMapInterface<?>> 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 layer);

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

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

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

        /**
         * Ruturns the {@link StyledMapInterface} object that is associated with the layer or NULL if the layer can't be found.
         */
        StyledMapInterface<?> getStyledObjectFor(MapLayer layer);
}
1	package skrueger.geotools;
2	import java.util.List;
3	import org.geotools.map.MapContext;
4	import org.geotools.map.MapLayer;
5	import org.geotools.map.event.MapLayerListListener;
6	import org.geotools.map.event.MapLayerListener;
7
8	import skrueger.AttributeMetaData;
9	import skrueger.RasterLegendData;
10
11	/**
12	* Implementations of this class can can be used to fill/insert/remove a mapContext
13	* with {@link StyledMapInterface} objects.
14	*
15	* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a>
16	*
17	*/
18	public interface MapContextManagerInterface {
19
20	/**
21	* Add a {@link StyledMapInterface} object into the underlying {@link MapContext}
22	* as the topmost layer
23	*
24	* @param styledMapObject Obejct to add to the layer
25	*/
26	boolean addStyledLayer (StyledMapInterface<?> styledMapObject);
27
28	/**
29	* @param mapContextIdx Index in the mapcontext, bottom first
30	* @return sucessful?
31	*/
32	boolean removeStyledLayer (int mapContextIdx);
33
34	/**
35	* Inserts a {@link StyledMapInterface} object into the underlying {@link MapContext}
36	* at the given position
37	*/
38	boolean insertStyledLayer (StyledMapInterface<?> styledMapObject, int mapContextIdx);
39
40	/** Add {@link MapLayerListener} */
41	void addMapLayerListListener( MapLayerListListener listener);
42
43	/** Remove {@link MapLayerListener} */
44	void removeMapLayerListListener( MapLayerListListener listener);
45
46	/**
47	* Help the GC by disposing this Component
48	*/
49	void dispose();
50
51	/**
52	* Returns a ordered list of the layers that are contained in the underlying {@link MapContext}
53	*/
54	List<StyledMapInterface<?>> getStyledObjects();
55
56	/**
57	* Returns a list of {@link AttributeMetaData} that shall be shown (e.g. when the Mouse clicked into the map)
58	* Returns an empty list if the layer doesn't exist or is not backed by a {@link StyledFeatureCollectionInterface}
59	*/
60	List<AttributeMetaData> getVisibleAttribsFor(MapLayer layer);
61
62	/**
63	* Returns the title of the layer
64	* @param layer {@link MapLayer}
65	* @return null, if the layer is unknown
66	*/
67	String getTitleFor(MapLayer layer);
68
69	/**
70	* Returns the description of the layer
71	* @param layer {@link MapLayer}
72	* @return null, if the layer is unknown. Empty String if the description is empty
73	*/
74	String getDescFor(MapLayer layer);
75
76	/**
77	* Returns the {@link RasterLegendData} object for the layer.
78	* @return null, if the layer is not found or of type raster
79	*/
80	RasterLegendData getLegendMetaData(MapLayer layer);
81
82	/**
83	* Ruturns the {@link StyledMapInterface} object that is associated with the layer or NULL if the layer can't be found.
84	*/
85	StyledMapInterface<?> getStyledObjectFor(MapLayer layer);
86	}