org.geomajas.layer

Interface VectorLayerService

All Superinterfaces:

GeomajasConstant, LayerService

@Api(allMethods=true)
public interface VectorLayerService
extends LayerService, GeomajasConstant

Service which allows accessing data from a vector layer.

All access to vector layers should be done through this service, not by accessing the layer directly as this adds possible caching, security etc. These services are implemented using pipelines (see PipelineService) to make them configurable.

Since:

1.6.0

Author:

Joachim Van der Auwera

Nested Class Summary

Nested classes/interfaces inherited from interface org.geomajas.global.GeomajasConstant

GeomajasConstant.GeomajasConstantImpl

Field Summary

Fields inherited from interface org.geomajas.global.GeomajasConstant

CLASSPATH_URL_PREFIX, FEATURE_INCLUDE_ALL, FEATURE_INCLUDE_ATTRIBUTES, FEATURE_INCLUDE_GEOMETRY, FEATURE_INCLUDE_LABEL, FEATURE_INCLUDE_NONE, FEATURE_INCLUDE_STYLE

Method Summary

Methods

Modifier and Type	Method and Description
List<Attribute<?>>	getAttributes(String layerId, String attributePath, Filter filter) Return the list of possible attribute values.
com.vividsolutions.jts.geom.Envelope	getBounds(String layerId, CoordinateReferenceSystem crs, Filter filter) Retrieve the bounds of the specified features.
List<InternalFeature>	getFeatures(String layerId, CoordinateReferenceSystem crs, Filter filter, NamedStyleInfo style, int featureIncludes) Retrieve all the features from the model that this filter accepts.
List<InternalFeature>	getFeatures(String layerId, CoordinateReferenceSystem crs, Filter filter, NamedStyleInfo style, int featureIncludes, int offset, int maxResultSize) Note that not all vector layers may support the offset or maxResultSize parameters! Check the individual layer documentation to be certain.
List<InternalFeature>	getFeatures(String layerId, CoordinateReferenceSystem crs, Filter filter, NamedStyleInfo style, int featureIncludes, int offset, int maxResultSize, boolean forcePaging) Note that not all vector layers may support the offset or maxResultSize parameters! Check the individual layer documentation to be certain.
InternalTile	getTile(TileMetadata tileMetadata) Get a vector tile for the request tile.
void	saveOrUpdate(String layerId, CoordinateReferenceSystem crs, List<InternalFeature> oldFeatures, List<InternalFeature> newFeatures) Update an existing feature of the model or creates a new feature.

Methods inherited from interface org.geomajas.layer.LayerService

getCrs

Method Detail

saveOrUpdate

void saveOrUpdate(String layerId,
                CoordinateReferenceSystem crs,
                List<InternalFeature> oldFeatures,
                List<InternalFeature> newFeatures)
                  throws GeomajasException

Update an existing feature of the model or creates a new feature.

Parameters:

layerId - id of layer which contains feature to update

crs - crs which should be used for the geometry in the feature

oldFeatures - old features to update or delete, in the same order as in newFeatures (delete when null in newFeatures). The list may have some null elements added when it is shorter than newFeatures.

newFeatures - new version of features, indicating a need to create or update (create when entry is null in oldFeatures). The items in the list are updated with the updated InternalFeature. The list may have some null elements added when it is shorter than oldFeatures.

Throws:

GeomajasException - oops

getFeatures

List<InternalFeature> getFeatures(String layerId,
                                CoordinateReferenceSystem crs,
                                Filter filter,
                                NamedStyleInfo style,
                                int featureIncludes)
                                  throws GeomajasException

Retrieve all the features from the model that this filter accepts.

Parameters:

layerId - id of layer to get features from

crs - which should be used for the geometries in the features

filter - filter to be applied

style - style to apply

featureIncludes - indicate which data to include in the features

Returns:

reader of feature value objects

Throws:

GeomajasException - oops

getFeatures

List<InternalFeature> getFeatures(String layerId,
                                CoordinateReferenceSystem crs,
                                Filter filter,
                                NamedStyleInfo style,
                                int featureIncludes,
                                int offset,
                                int maxResultSize)
                                  throws GeomajasException

Note that not all vector layers may support the offset or maxResultSize parameters! Check the individual layer documentation to be certain.

Retrieve all the features from the model that this filter accepts.

Parameters:

layerId - id of layer to get features from

crs - which should be used for the geometries in the features

filter - filter to be applied

style - style to apply

featureIncludes - indicate which data to include in the features

offset - Skip the first 'offset' features in the result. This is meant for paging.

maxResultSize - Limit the result to a maximum number of features. Can be used for paging.

Returns:

reader of feature value objects

Throws:

GeomajasException - oops

getFeatures

List<InternalFeature> getFeatures(String layerId,
                                CoordinateReferenceSystem crs,
                                Filter filter,
                                NamedStyleInfo style,
                                int featureIncludes,
                                int offset,
                                int maxResultSize,
                                boolean forcePaging)
                                  throws GeomajasException

Note that not all vector layers may support the offset or maxResultSize parameters! Check the individual layer documentation to be certain.

SECURITY WARNING: if paging is forced at the layer level (forcePaging=true), callers are able to count the number of invisible features, creating a possible security hazard !

Retrieve all the features from the model that this filter accepts.

Parameters:

layerId - id of layer to get features from

crs - which should be used for the geometries in the features

filter - filter to be applied

style - style to apply

featureIncludes - indicate which data to include in the features

offset - Skip the first 'offset' features in the result. This is meant for paging.

maxResultSize - Limit the result to a maximum number of features. Can be used for paging.

forcePaging - Forces paging at layer level. This optimizes performance at the expense of (possibly) fewer results being returned than asked for because of subsequent security filtering.

Returns:

reader of feature value objects

Throws:

GeomajasException - oops

Since:

1.10.0

getBounds

com.vividsolutions.jts.geom.Envelope getBounds(String layerId,
                                             CoordinateReferenceSystem crs,
                                             Filter filter)
                                               throws GeomajasException

Retrieve the bounds of the specified features.

Parameters:

layerId - id of layer to get bounds for

crs - crs which should be used for the bounding box

filter - filter to be applied

Returns:

the bounds of the specified features

Throws:

GeomajasException - oops

getAttributes

List<Attribute<?>> getAttributes(String layerId,
                               String attributePath,
                               Filter filter)
                                 throws GeomajasException

Return the list of possible attribute values.

Parameters:

layerId - id of layer to get objects from

attributePath - attribute path to get objects for

filter - filter to be applied

Returns:

possible object values

Throws:

GeomajasException - oops

getTile

InternalTile getTile(TileMetadata tileMetadata)
                     throws GeomajasException

Get a vector tile for the request tile.

Parameters:

tileMetadata - description of the tile

Returns:

internal vector tile

Throws:

GeomajasException - oops