org.geomajas.layer.feature

Interface FeatureModel

@Api(allMethods=true)
@UserImplemented
public interface FeatureModel

A feature model provides sufficient information to generically create/read and update a feature. This level of indirection is necessary in order to allow features to follow the POJO (Plain Old Java Object) model without mandating it. Currently supports flat features. Warning for implementors : clients cannot be prevented from modifying attributes or geometries obtained by the accessor methods. Return cloned or unmodifiable objects if you want to avoid this !

Since:

1.6.0

Author:

Jan De Moerloose

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHandle(Object feature) Can a given 'feature' object be handled by this FeatureModel?
Attribute	getAttribute(Object feature, String name) Return the attribute value with the given name.
Map<String,Attribute>	getAttributes(Object feature) Deprecated. the back-end implements this itself since 1.9.0 to provide lazy attribute loading if needed
com.vividsolutions.jts.geom.Geometry	getGeometry(Object feature) Return the geometry of a feature.
String	getGeometryAttributeName() Return the name which can be used to get the geometric attribute.
String	getId(Object feature) Return the id of a feature.
int	getSrid() Return the spatial reference id of the coordinate reference system.
Object	newInstance() Create a default feature.
Object	newInstance(String id) Create a default feature.
void	setAttributes(Object feature, Map<String,Attribute> attributes) Set the attributes of a feature.
void	setGeometry(Object feature, com.vividsolutions.jts.geom.Geometry geometry) Set the geometry of a feature.
void	setLayerInfo(VectorLayerInfo vectorLayerInfo) Set the layer info for this layer model.

Method Detail

setLayerInfo

void setLayerInfo(VectorLayerInfo vectorLayerInfo)
                  throws LayerException

Set the layer info for this layer model.

Parameters:

vectorLayerInfo - vector layer info

Throws:

LayerException - oops

getAttribute

Attribute getAttribute(Object feature,
                     String name)
                       throws LayerException

Return the attribute value with the given name.

Parameters:

feature - the feature

name - the attribute name

Returns:

attribute value

Throws:

LayerException - oops

getAttributes

@Deprecated
Map<String,Attribute> getAttributes(Object feature)
                                    throws LayerException

Deprecated. the back-end implements this itself since 1.9.0 to provide lazy attribute loading if needed

Return all attributes as a map with the attribute name as the key.

Parameters:

feature - the feature

Returns:

map of attribute values

Throws:

LayerException - oops

getId

String getId(Object feature)
             throws LayerException

Return the id of a feature.

Parameters:

feature - the feature

Returns:

the feature's id

Throws:

LayerException - oops

getGeometry

com.vividsolutions.jts.geom.Geometry getGeometry(Object feature)
                                                 throws LayerException

Return the geometry of a feature.

Parameters:

feature - the feature

Returns:

the feature's geometry

Throws:

LayerException - oops

setAttributes

void setAttributes(Object feature,
                 Map<String,Attribute> attributes)
                   throws LayerException

Set the attributes of a feature.

Parameters:

feature - the feature

attributes - the attributes

Throws:

LayerException - oops

setGeometry

void setGeometry(Object feature,
               com.vividsolutions.jts.geom.Geometry geometry)
                 throws LayerException

Set the geometry of a feature.

Parameters:

feature - the feature

geometry - the geometry

Throws:

LayerException - oops

newInstance

Object newInstance()
                   throws LayerException

Create a default feature.

Returns:

a new feature with default properties only

Throws:

LayerException - oops

newInstance

Object newInstance(String id)
                   throws LayerException

Create a default feature.

Parameters:

id - Optional ID. use null, if you want the id to be generated.

Returns:

a new feature with default properties only

Throws:

LayerException - oops

getSrid

int getSrid()
            throws LayerException

Return the spatial reference id of the coordinate reference system.

Returns:

spatial reference id

Throws:

LayerException - oops

getGeometryAttributeName

String getGeometryAttributeName()
                                throws LayerException

Return the name which can be used to get the geometric attribute. Can for example be be the name of a column in a SQL table, or the name of a method in a java object.

Returns:

attribute name

Throws:

LayerException - oops

canHandle

boolean canHandle(Object feature)

Can a given 'feature' object be handled by this FeatureModel?

Parameters:

feature - A object from a layer.

Returns:

true when feature can be handled by this feature model