org.geomajas.layer

Interface VectorLayer

All Superinterfaces:

Layer<VectorLayerInfo>

@Api(allMethods=true)
@UserImplemented
public interface VectorLayer
extends Layer<VectorLayerInfo>

A layer which contains vector data.

It hold all the elements that belong to a layer within the bounds determined by the client's view. It is able to manipulate the objects which are represented as features on the map.

Since:

1.6.0

Author:

Pieter De Graef, Jan De Moerloose

Method Summary

Methods

Modifier and Type	Method and Description
Object	create(Object feature) Creates a new feature.
void	delete(String featureId) Deletes a feature of the model.
com.vividsolutions.jts.geom.Envelope	getBounds() Return the bounds of this model.
com.vividsolutions.jts.geom.Envelope	getBounds(Filter filter) Retrieve the bounds of the specified features.
Iterator<?>	getElements(Filter filter, int offset, int maxResultSize) Retrieve all the features from the model that this filter accepts.
FeatureModel	getFeatureModel() Return the feature model of this layer model.
boolean	isCreateCapable() Indicate whether the layer is capable of creating new features.
boolean	isDeleteCapable() Indicate whether the layer is capable of creating new features.
boolean	isUpdateCapable() Indicate whether the layer is capable of updating features.
Object	read(String featureId) Reads an existing feature of the model.
Object	saveOrUpdate(Object feature) Update an existing feature of the model or creates a new feature.

Methods inherited from interface org.geomajas.layer.Layer

getCrs, getId, getLayerInfo

Method Detail

isCreateCapable

boolean isCreateCapable()

Indicate whether the layer is capable of creating new features.

Returns:

true when creating new features is possible for this layer

isUpdateCapable

boolean isUpdateCapable()

Indicate whether the layer is capable of updating features.

Returns:

true when updating features is possible for this layer

isDeleteCapable

boolean isDeleteCapable()

Indicate whether the layer is capable of creating new features.

Returns:

true when deleting features is possible for this layer

getFeatureModel

FeatureModel getFeatureModel()

Return the feature model of this layer model.

Returns:

feature model for this layer

create

Object create(Object feature)
              throws LayerException

Creates a new feature.

Parameters:

feature - feature value object

Returns:

the new feature (with assigned or generated ID)

Throws:

LayerException - oops

saveOrUpdate

Object saveOrUpdate(Object feature)
                    throws LayerException

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

Parameters:

feature - feature value object

Returns:

the feature itself

Throws:

LayerException - oops

read

Object read(String featureId)
            throws LayerException

Reads an existing feature of the model.

When no feature with the requested id is found, ExceptionCode.LAYER_MODEL_FEATURE_NOT_FOUND is thrown.

Parameters:

featureId - unique id of the feature

Returns:

feature value object

Throws:

LayerException - when reading failed, for example ExceptionCode.LAYER_MODEL_FEATURE_NOT_FOUND

delete

void delete(String featureId)
            throws LayerException

Deletes a feature of the model.

Parameters:

featureId - unique id of the feature

Throws:

LayerException - oops

getElements

Iterator<?> getElements(Filter filter,
                      int offset,
                      int maxResultSize)
                        throws LayerException

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

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

Parameters:

filter - filter to be applied

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

maxResultSize - Limit the result to a maximum number of features. Used for paging. Zero for unlimited.

Returns:

reader of feature value objects

Throws:

LayerException - oops

getBounds

com.vividsolutions.jts.geom.Envelope getBounds(Filter filter)
                                               throws LayerException

Retrieve the bounds of the specified features.

Parameters:

filter - filter to be applied

Returns:

the bounds of the specified features

Throws:

LayerException - oops

getBounds

com.vividsolutions.jts.geom.Envelope getBounds()
                                               throws LayerException

Return the bounds of this model.

Returns:

bounds of this model

Throws:

LayerException - oops