de.cismet.cismap.commons.featureservice

Interface LayerProperties

All Superinterfaces:

Cloneable, ConvertableToXML

All Known Implementing Classes:

DefaultLayerProperties

public interface LayerProperties
extends ConvertableToXML, Cloneable

Combines a set of commen properties of a group of features which belong to the same layer, for example the styles, id and name attributes. This interface allows the management of such common properties in a central place.

Version:

$Revision$, $Date$

Author:

Pascal Dihé

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXPRESSIONTYPE_BEANSHELL The expression is a beansehell script that must be evaluated by BeanShell.
static int	EXPRESSIONTYPE_GROOVY The expression is a grooy script that must be evaluated by the groovy shell.
static int	EXPRESSIONTYPE_PROPERTYNAME The expression refers to a name of a property of feature.
static int	EXPRESSIONTYPE_STATIC The expression refers to a static string.
static int	EXPRESSIONTYPE_UNDEFINED The expression is undefined or not supported.
static String	LAYER_PROPERTIES_ELEMENT
static int	QUERYTYPE_HTTPGET HTTP_GET style parameters query, e.g.
static int	QUERYTYPE_SQL SQL style query.
static int	QUERYTYPE_UNDEFINED The query type is not defined, the layee dooes not support queries.
static int	QUERYTYPE_XML XML style query, eg.g WFS query.

Fields inherited from interface de.cismet.cismap.commons.ConvertableToXML

TYPE_ATTRIBUTE

Method Summary

Modifier and Type	Method and Description
void	assign(LayerProperties layerProperties) Assigns all properties of the layerProperties object to the current instance this.
LayerProperties	clone() Creates a 1:1 copy of this object.
AttributeTableRuleSet	getAttributeTableRuleSet()
AbstractFeatureService	getFeatureService() DOCUMENT ME!
FeatureSimplifier	getFeatureSimplifier() The FeatureSimplifier is used to simplify geometrie when they were drawing to the map.
String	getIdExpression() Returns the expression able to assign a unique id to each feature associated with this layer.
int	getIdExpressionType() Returns the type of the actual idExpression.
String	getPrimaryAnnotationExpression() Returns the expression able to assign a primary annotation to each feature associated with this layer.
int	getPrimaryAnnotationExpressionType() Returns the type of the actual primaryAnnotationExpressio.
int	getQueryType() Returns the type of the query used to query the layer for new features.
String	getSecondaryAnnotationExpression() Returns the expression able to assign a secondary annotation to each feature associated with this layer.
int	getSecondaryAnnotationExpressionType() Returns the type of the actual secondaryAnnotationExpressio.
Style	getStyle() Returns the style associated to this object.
boolean	isIdExpressionEnabled() Determines if the id expression for this particular layer should be evaluated.
void	setFeatureService(AbstractFeatureService service) DOCUMENT ME!
void	setIdExpression(String idExpression, int type) Sets the expression able to assign a unique id to each feature associated with this layer.
void	setIdExpressionEnabled(boolean idExpressionEnabled) Enables or disables the evaluation of the is expression.
void	setPrimaryAnnotationExpression(String primaryAnnotationExpression, int type) Sets the expression able to assign a primary annotation to each feature associated with this layer.
void	setQueryType(int queryType) Sets the type of the query used to query the layer for new features.
void	setSecondaryAnnotationExpression(String secondaryAnnotationExpression, int type) Sets the expression able to assign a secondary annotation to each feature associated with this layer.
void	setStyle(Style featureStyle) Sets the style of this layer.

Methods inherited from interface de.cismet.cismap.commons.ConvertableToXML

initFromElement, toElement

Field Detail

EXPRESSIONTYPE_UNDEFINED

static final int EXPRESSIONTYPE_UNDEFINED

The expression is undefined or not supported.

See Also:

Constant Field Values

EXPRESSIONTYPE_STATIC

static final int EXPRESSIONTYPE_STATIC

The expression refers to a static string.

See Also:

Constant Field Values

EXPRESSIONTYPE_PROPERTYNAME

static final int EXPRESSIONTYPE_PROPERTYNAME

The expression refers to a name of a property of feature.

See Also:

Constant Field Values

EXPRESSIONTYPE_GROOVY

static final int EXPRESSIONTYPE_GROOVY

The expression is a grooy script that must be evaluated by the groovy shell.

See Also:

Constant Field Values

EXPRESSIONTYPE_BEANSHELL

static final int EXPRESSIONTYPE_BEANSHELL

The expression is a beansehell script that must be evaluated by BeanShell.

See Also:

Constant Field Values

QUERYTYPE_UNDEFINED

static final int QUERYTYPE_UNDEFINED

The query type is not defined, the layee dooes not support queries.

See Also:

Constant Field Values

QUERYTYPE_HTTPGET

static final int QUERYTYPE_HTTPGET

HTTP_GET style parameters query, e.g. WMS query

See Also:

Constant Field Values

QUERYTYPE_XML

static final int QUERYTYPE_XML

XML style query, eg.g WFS query.

See Also:

Constant Field Values

QUERYTYPE_SQL

static final int QUERYTYPE_SQL

SQL style query.

See Also:

Constant Field Values

LAYER_PROPERTIES_ELEMENT

static final String LAYER_PROPERTIES_ELEMENT

See Also:

Constant Field Values

Method Detail

setStyle

void setStyle(Style featureStyle)

Sets the style of this layer. The Style shall by applied to all Features beloging to this layer.

Parameters:

featureStyle - New style object to be set

getStyle

Style getStyle()

Returns the style associated to this object. If the operation returns null either the feature has not been initilaized yet or the feature does not support style objects.

Returns:

the style object of this feature or null.

getIdExpression

String getIdExpression()

Returns the expression able to assign a unique id to each feature associated with this layer. To determine how this expression should be processed use the getIdExpressionType() operation.

Returns:

the actual id expression, e.g. a groovy script or null

setIdExpression

void setIdExpression(String idExpression,
                     int type)

Sets the expression able to assign a unique id to each feature associated with this layer. The mandatory type parameter indicates how the expression can be procedd, e.g. by a GrovyShell instance.

Parameters:

idExpression - the new expression to be set

type - the type of the expression, see static EXPRESSIONTYPE_ variables

getIdExpressionType

int getIdExpressionType()

Returns the type of the actual idExpression. Please not that the process of assigning an id to a feature can be significantly accelerated by using expressions of type EXPRESSIONTYPE_PROPERTYNAME.

Returns:

Type of the expression or -1, see static EXPRESSIONTYPE_ variables

getPrimaryAnnotationExpression

String getPrimaryAnnotationExpression()

Returns the expression able to assign a primary annotation to each feature associated with this layer. To determine how this expression should be processed use the getIdExpressionType()operation.

Returns:

the expression, e.g. a property name or null

getPrimaryAnnotationExpressionType

int getPrimaryAnnotationExpressionType()

Returns the type of the actual primaryAnnotationExpressio. Please not that the process of assigning an id to a feature can be significantly accelerated by using expressions of type EXPRESSIONTYPE_PROPERTYNAME.

Returns:

Type of the expression or -1, see static EXPRESSIONTYPE_ variables

setPrimaryAnnotationExpression

void setPrimaryAnnotationExpression(String primaryAnnotationExpression,
                                    int type)

Sets the expression able to assign a primary annotation to each feature associated with this layer. The mandatory type parameter indicates how the expression can be procedd, e.g. by a GrovyShell instance.

Parameters:

primaryAnnotationExpression - the new expression to be set

type - the type of the expression, see static EXPRESSIONTYPE_ variables

getSecondaryAnnotationExpression

String getSecondaryAnnotationExpression()

Returns the expression able to assign a secondary annotation to each feature associated with this layer. To determine how this expression should be processed use the getIdExpressionType()operation.

Returns:

the expression, e.g. a property name or null

getSecondaryAnnotationExpressionType

int getSecondaryAnnotationExpressionType()

Returns the type of the actual secondaryAnnotationExpressio. Please not that the process of assigning an id to a feature can be significantly accelerated by using expressions of type EXPRESSIONTYPE_PROPERTYNAME.

Returns:

Type of the expression or -1, see static EXPRESSIONTYPE_ variables

setSecondaryAnnotationExpression

void setSecondaryAnnotationExpression(String secondaryAnnotationExpression,
                                      int type)

Sets the expression able to assign a secondary annotation to each feature associated with this layer. The mandatory type parameter indicates how the expression can be procedd, e.g. by a GrovyShell instance.

Parameters:

secondaryAnnotationExpression - the new expression to be set

type - the type of the expression, see static EXPRESSIONTYPE_ variables

assign

void assign(LayerProperties layerProperties)

Assigns all properties of the layerProperties object to the current instance this. The operation can for example be used to re-assign the modified properties of a cloned instance of this to this. Especially usefull when this is referenced by many InheritsLayerProperties features.

Parameters:

layerProperties - propertiesd to be assigned to this instance

getQueryType

int getQueryType()

Returns the type of the query used to query the layer for new features. If the layer does not support queries, the operation returns -1.

Returns:

the type of the query, see static QUERYTYPE_ variables

setQueryType

void setQueryType(int queryType)

Sets the type of the query used to query the layer for new features.

Parameters:

queryType - the query type as specified by the QUERYTYPE_ variables

isIdExpressionEnabled

boolean isIdExpressionEnabled()

Determines if the id expression for this particular layer should be evaluated. FeatureFactories that support unique id generation will always set this property to false

Returns:

true if id expression is supported, false otherwise

setIdExpressionEnabled

void setIdExpressionEnabled(boolean idExpressionEnabled)

Enables or disables the evaluation of the is expression.

Parameters:

idExpressionEnabled - set to true if enabled

getFeatureService

AbstractFeatureService getFeatureService()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setFeatureService

void setFeatureService(AbstractFeatureService service)

DOCUMENT ME!

Parameters:

service - DOCUMENT ME!

clone

LayerProperties clone()

Creates a 1:1 copy of this object.

Returns:

Cloned instance of this object

getAttributeTableRuleSet

AttributeTableRuleSet getAttributeTableRuleSet()

getFeatureSimplifier

FeatureSimplifier getFeatureSimplifier()

The FeatureSimplifier is used to simplify geometrie when they were drawing to the map.

Returns:

the feature simplifier or null, if no FeatureSimplifier exists for this layer