org.geomajas.service

Interface ConfigurationService

@Api(allMethods=true)
public interface ConfigurationService

Utility service which is used to get some global data.

Since:

1.6.0

Author:

Joachim Van der Auwera

Method Summary

Methods

Modifier and Type	Method and Description
CoordinateReferenceSystem	getCrs(String crs) Deprecated. Use GeoService.getCrs2(String crs)
Layer<?>	getLayer(String id) Get the vector layer with given id.
<TYPE extends LayerExtraInfo> TYPE	getLayerExtraInfo(LayerInfo layerInfo, Class<TYPE> type) Get a specific entry from the extraInfo for the given type on LayerInfo.
<TYPE extends LayerExtraInfo> TYPE	getLayerExtraInfo(LayerInfo layerInfo, String key, Class<TYPE> type) Get a specific entry from the extraInfo for key and with type checking.
ClientMapInfo	getMap(String mapId, String applicationId) Get information about the map with specified mapId in the application with the specified applicationId.
RasterLayer	getRasterLayer(String id) Get the raster layer with given id.
VectorLayer	getVectorLayer(String id) Get the vector layer with given id.
void	invalidateAllLayers() Invalidate all layers.
void	invalidateLayer(String layerId) Invalidate a layer.

Method Detail

getVectorLayer

VectorLayer getVectorLayer(String id)

Get the vector layer with given id.

Parameters:

id - layer id

Returns:

layer

getRasterLayer

RasterLayer getRasterLayer(String id)

Get the raster layer with given id.

Parameters:

id - layer id

Returns:

layer

getLayer

Layer<?> getLayer(String id)

Get the vector layer with given id.

Parameters:

id - vector layer id

Returns:

vector layer

invalidateLayer

void invalidateLayer(String layerId)
                     throws GeomajasException

Invalidate a layer. This should be called whenever significant changes to the layer have occurred. These include deleting the layer, changes in the style, data structure, security, authorizations,...

Parameters:

layerId - id of layer which needs to be invalidated

Throws:

GeomajasException - oops (should not happen, steps should just log and not (re)throw exceptions)

Since:

1.8.0

invalidateAllLayers

void invalidateAllLayers()
                         throws GeomajasException

Invalidate all layers. This should be called whenever significant changes to the layer have occurred. These include deleting the layer, changes in the style, data structure, security, authorizations,...

Throws:

GeomajasException - oops (should not happen, steps should just log and not (re)throw exceptions)

Since:

1.8.0

getMap

ClientMapInfo getMap(String mapId,
                   String applicationId)

Get information about the map with specified mapId in the application with the specified applicationId.

Parameters:

mapId - map Id

applicationId - application id

Returns:

ClientMapInfo

getCrs

@Deprecated
CoordinateReferenceSystem getCrs(String crs)
                                 throws LayerException

Deprecated. Use GeoService.getCrs2(String crs)

Get the CoordinateReferenceSystem with given code.

Parameters:

crs - Coordinate reference system code. (EPSG:xxxx)

Returns:

CoordinateReferenceSystem

Throws:

LayerException - CRS code not found

getLayerExtraInfo

<TYPE extends LayerExtraInfo> TYPE getLayerExtraInfo(LayerInfo layerInfo,
                                                   Class<TYPE> type)

Get a specific entry from the extraInfo for the given type on LayerInfo. This assumes the fully qualified class name of the object is used as key.

Type Parameters:

TYPE - type to get

Parameters:

layerInfo - layerInfo object to query

type - type to get

Returns:

value for key if exists

Since:

1.9.0

getLayerExtraInfo

<TYPE extends LayerExtraInfo> TYPE getLayerExtraInfo(LayerInfo layerInfo,
                                                   String key,
                                                   Class<TYPE> type)

Get a specific entry from the extraInfo for key and with type checking.

Type Parameters:

TYPE - type to get

Parameters:

layerInfo - layerInfo object to query

key - key from extraInfo

type - type to get

Returns:

value for key if exists

Since:

1.9.0