11 |
|
|
12 |
/** |
/** |
13 |
* Implementations of this class can can be used to fill/insert/remove a mapContext |
* Implementations of this class can can be used to fill/insert/remove a mapContext |
14 |
* with {@link StyledMapInterface} objects. |
* with {@link StyledLayerInterface} objects. |
15 |
* |
* |
16 |
* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a> |
* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a> |
17 |
* |
* |
19 |
public interface MapContextManagerInterface { |
public interface MapContextManagerInterface { |
20 |
|
|
21 |
/** |
/** |
22 |
* Add a {@link StyledMapInterface} object into the underlying {@link MapContext} |
* Add a {@link StyledLayerInterface} object into the underlying {@link MapContext} |
23 |
* as the topmost layer |
* as the topmost layer |
24 |
* |
* |
25 |
* @param styledMapObject Obejct to add to the layer |
* @param styledLayer Layer to add to the map |
26 |
*/ |
*/ |
27 |
boolean addStyledLayer (StyledMapInterface<?> styledMapObject); |
boolean addStyledLayer (StyledLayerInterface<?> styledLayer); |
28 |
|
|
29 |
/** |
/** |
30 |
* @param mapContextIdx Index in the mapcontext, bottom first |
* @param mapContextIdx Index in the {@link MapContext}, bottom first |
31 |
* @return sucessful? |
* @return successful? |
32 |
*/ |
*/ |
33 |
boolean removeStyledLayer (int mapContextIdx); |
boolean removeStyledLayer (int mapContextIdx); |
34 |
|
|
35 |
/** |
/** |
36 |
* Inserts a {@link StyledMapInterface} object into the underlying {@link MapContext} |
* Inserts a {@link StyledLayerInterface} object into the underlying {@link MapContext} |
37 |
* at the given position |
* at the given position |
38 |
*/ |
*/ |
39 |
boolean insertStyledLayer (StyledMapInterface<?> styledMapObject, int mapContextIdx); |
boolean insertStyledLayer (StyledLayerInterface<?> styledLayer, int mapContextIdx); |
40 |
|
|
41 |
/** Add {@link MapLayerListener} */ |
/** Add {@link MapLayerListener} */ |
42 |
void addMapLayerListListener( MapLayerListListener listener); |
void addMapLayerListListener( MapLayerListListener listener); |
52 |
/** |
/** |
53 |
* Returns a ordered list of the layers that are contained in the underlying {@link MapContext} |
* Returns a ordered list of the layers that are contained in the underlying {@link MapContext} |
54 |
*/ |
*/ |
55 |
List<StyledMapInterface<?>> getStyledObjects(); |
List<StyledLayerInterface<?>> getStyledObjects(); |
56 |
|
|
57 |
/** |
/** |
58 |
* Returns a list of {@link AttributeMetaData} that shall be shown (e.g. when the Mouse clicked into the map) |
* 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} |
* 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); |
List<AttributeMetaData> getVisibleAttribsFor(MapLayer mapLayer); |
62 |
|
|
63 |
/** |
/** |
64 |
* Returns the title of the layer |
* Returns the title of the layer |
65 |
* @param layer {@link MapLayer} |
* @param mapLayer {@link MapLayer} |
66 |
* @return null, if the layer is unknown |
* @return <code>null</code>, if the layer is unknown |
67 |
*/ |
*/ |
68 |
String getTitleFor(MapLayer layer); |
String getTitleFor(MapLayer mapLayer); |
69 |
|
|
70 |
/** |
/** |
71 |
* Returns the description of the layer |
* Returns the description of the layer |
72 |
* @param layer {@link MapLayer} |
* @param mapLayer {@link MapLayer} |
73 |
* @return null, if the layer is unknown. Empty String if the description is empty |
* @return <code>null</code>, if the layer is unknown. Empty String if the description is empty |
74 |
*/ |
*/ |
75 |
String getDescFor(MapLayer layer); |
String getDescFor(MapLayer mapLayer); |
76 |
|
|
77 |
/** |
/** |
78 |
* Returns the {@link RasterLegendData} object for the layer. |
* Returns the {@link RasterLegendData} object for the layer. |
79 |
* @return null, if the layer is not found or of type raster |
* @return null, if the layer is not found or of type raster |
80 |
*/ |
*/ |
81 |
RasterLegendData getLegendMetaData(MapLayer layer); |
RasterLegendData getLegendMetaData(MapLayer mapLayer); |
82 |
|
|
83 |
/** |
/** |
84 |
* Ruturns the {@link StyledMapInterface} object that is associated with the layer or NULL if the layer can't be found. |
* Returns the {@link StyledLayerInterface} object that is associated with the layer or NULL if the layer can't be found. |
85 |
*/ |
*/ |
86 |
StyledMapInterface<?> getStyledObjectFor(MapLayer layer); |
StyledLayerInterface<?> getStyledObjectFor(MapLayer layer); |
87 |
} |
} |