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