de.cismet.cismap.commons.featureservice

Class DefaultLayerProperties

java.lang.Object

de.cismet.cismap.commons.featureservice.DefaultLayerProperties

All Implemented Interfaces:

ConvertableToXML, LayerProperties, Cloneable

public class DefaultLayerProperties
extends Object
implements LayerProperties

Default implementation of the LayerProperties Interface.

Version:

$Revision$, $Date$

Author:

Pascal Dihé

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	logger

Fields inherited from interface de.cismet.cismap.commons.featureservice.LayerProperties

EXPRESSIONTYPE_BEANSHELL, EXPRESSIONTYPE_GROOVY, EXPRESSIONTYPE_PROPERTYNAME, EXPRESSIONTYPE_STATIC, EXPRESSIONTYPE_UNDEFINED, LAYER_PROPERTIES_ELEMENT, QUERYTYPE_HTTPGET, QUERYTYPE_SQL, QUERYTYPE_UNDEFINED, QUERYTYPE_XML

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

TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
DefaultLayerProperties() Creates a new DefaultLayerProperties instance and initialises the style property with a preconfigured BasicStyle object.
DefaultLayerProperties(org.jdom.Element element) Initialises a new DefaultLayerProperties instance from an xml document.
DefaultLayerProperties(LayerProperties layerProperties) Initialises a new DefaultLayerProperties instance from an existing LayerProperties object.
DefaultLayerProperties(Style style) Creates a new DefaultLayerProperties instance and initialises the style property from the style parameter.

Method Summary

Modifier and Type	Method and Description
void	assign(LayerProperties layerProperties) Assigns all properties of the layerProperties object to the current instance this.
static String	camelize(String toCamelize) camelizes the given string.
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() Get the value of idExpression.
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.
void	initFromElement(org.jdom.Element element) Initialies an object that implements the ConvertableToXML interface from a DOM Element.
boolean	isIdExpressionEnabled() Determines if the id expression for this particular layer should be evaluated.
void	setAttributeTableRuleSet(AttributeTableRuleSet attributeTableRuleSet) DOCUMENT ME!
void	setFeatureService(AbstractFeatureService featureService) DOCUMENT ME!
void	setFeatureSimplifier(FeatureSimplifier featureSimplifier) 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.
org.jdom.Element	toElement() Serializes the object that implements the ConvertableToXML interface to a DOM Element.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static final org.apache.log4j.Logger logger

Constructor Detail

DefaultLayerProperties

public DefaultLayerProperties()

Creates a new DefaultLayerProperties instance and initialises the style property with a preconfigured BasicStyle object. All expression types are set to undefined.

DefaultLayerProperties

public DefaultLayerProperties(Style style)

Creates a new DefaultLayerProperties instance and initialises the style property from the style parameter.

Parameters:

style - Style object to be used

DefaultLayerProperties

public DefaultLayerProperties(org.jdom.Element element)
                       throws Exception

Initialises a new DefaultLayerProperties instance from an xml document.

Parameters:

element - the xml serialized DefaultLayerProperties object

Throws:

Exception - if the initilaisation failed

See Also:

ConvertableToXML.initFromElement(Element)

DefaultLayerProperties

public DefaultLayerProperties(LayerProperties layerProperties)

Initialises a new DefaultLayerProperties instance from an existing LayerProperties object. The properties of the LayerProperties will be cloned.

Parameters:

layerProperties - LayerProperties to be used for initialisation

See Also:

LayerProperties#clone(Object)

Method Detail

clone

public LayerProperties clone()

Description copied from interface: LayerProperties

Creates a 1:1 copy of this object.

Specified by:

clone in interface LayerProperties

Overrides:

clone in class Object

Returns:

Cloned instance of this object

setStyle

public void setStyle(Style featureStyle)

Description copied from interface: LayerProperties

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

Specified by:

setStyle in interface LayerProperties

Parameters:

featureStyle - New style object to be set

getStyle

public Style getStyle()

Description copied from interface: LayerProperties

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.

Specified by:

getStyle in interface LayerProperties

Returns:

the style object of this feature or null.

getIdExpression

public String getIdExpression()

Get the value of idExpression.

Specified by:

getIdExpression in interface LayerProperties

Returns:

the value of idExpression

setIdExpression

public void setIdExpression(String idExpression,
                            int type)

Description copied from interface: LayerProperties

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.

Specified by:

setIdExpression in interface LayerProperties

Parameters:

idExpression - the new expression to be set

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

getIdExpressionType

public int getIdExpressionType()

Description copied from interface: LayerProperties

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.

Specified by:

getIdExpressionType in interface LayerProperties

Returns:

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

getPrimaryAnnotationExpression

public String getPrimaryAnnotationExpression()

Description copied from interface: LayerProperties

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.

Specified by:

getPrimaryAnnotationExpression in interface LayerProperties

Returns:

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

getPrimaryAnnotationExpressionType

public int getPrimaryAnnotationExpressionType()

Description copied from interface: LayerProperties

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.

Specified by:

getPrimaryAnnotationExpressionType in interface LayerProperties

Returns:

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

setPrimaryAnnotationExpression

public void setPrimaryAnnotationExpression(String primaryAnnotationExpression,
                                           int type)

Description copied from interface: LayerProperties

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.

Specified by:

setPrimaryAnnotationExpression in interface LayerProperties

Parameters:

primaryAnnotationExpression - the new expression to be set

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

getSecondaryAnnotationExpression

public String getSecondaryAnnotationExpression()

Description copied from interface: LayerProperties

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.

Specified by:

getSecondaryAnnotationExpression in interface LayerProperties

Returns:

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

getSecondaryAnnotationExpressionType

public int getSecondaryAnnotationExpressionType()

Description copied from interface: LayerProperties

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.

Specified by:

getSecondaryAnnotationExpressionType in interface LayerProperties

Returns:

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

setSecondaryAnnotationExpression

public void setSecondaryAnnotationExpression(String secondaryAnnotationExpression,
                                             int type)

Description copied from interface: LayerProperties

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.

Specified by:

setSecondaryAnnotationExpression in interface LayerProperties

Parameters:

secondaryAnnotationExpression - the new expression to be set

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

getQueryType

public int getQueryType()

Description copied from interface: LayerProperties

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.

Specified by:

getQueryType in interface LayerProperties

Returns:

the type of the query, see static QUERYTYPE_ variables

toElement

public org.jdom.Element toElement()

Description copied from interface: ConvertableToXML

Serializes the object that implements the ConvertableToXML interface to a DOM Element. Although no further assumption is made about the XML Structure of the serialized object implementation classes shall at least provide an attribute type must contain the class name ob the object.

Specified by:

toElement in interface ConvertableToXML

Returns:

XML representation of the object

initFromElement

public void initFromElement(org.jdom.Element element)
                     throws Exception

Description copied from interface: ConvertableToXML

Initialies an object that implements the ConvertableToXML interface from a DOM Element.

Specified by:

initFromElement in interface ConvertableToXML

Parameters:

element - the elemen to be reconstructed

Throws:

Exception - if the object could not be initialized

assign

public void assign(LayerProperties layerProperties)

Description copied from interface: 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.

Specified by:

assign in interface LayerProperties

Parameters:

layerProperties - propertiesd to be assigned to this instance

isIdExpressionEnabled

public boolean isIdExpressionEnabled()

Description copied from interface: LayerProperties

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

Specified by:

isIdExpressionEnabled in interface LayerProperties

Returns:

true if id expression is supported, false otherwise

setIdExpressionEnabled

public void setIdExpressionEnabled(boolean idExpressionEnabled)

Description copied from interface: LayerProperties

Enables or disables the evaluation of the is expression.

Specified by:

setIdExpressionEnabled in interface LayerProperties

Parameters:

idExpressionEnabled - set to true if enabled

setQueryType

public void setQueryType(int queryType)

Description copied from interface: LayerProperties

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

Specified by:

setQueryType in interface LayerProperties

Parameters:

queryType - the query type as specified by the QUERYTYPE_ variables

getFeatureService

public AbstractFeatureService getFeatureService()

Description copied from interface: LayerProperties

DOCUMENT ME!

Specified by:

getFeatureService in interface LayerProperties

Returns:

DOCUMENT ME!

setFeatureService

public void setFeatureService(AbstractFeatureService featureService)

DOCUMENT ME!

Specified by:

setFeatureService in interface LayerProperties

Parameters:

featureService - DOCUMENT ME!

getAttributeTableRuleSet

public AttributeTableRuleSet getAttributeTableRuleSet()

Specified by:

getAttributeTableRuleSet in interface LayerProperties

camelize

public static String camelize(String toCamelize)

camelizes the given string.

Parameters:

toCamelize - string to camalize

Returns:

the camalized string

setAttributeTableRuleSet

public void setAttributeTableRuleSet(AttributeTableRuleSet attributeTableRuleSet)

DOCUMENT ME!

Parameters:

attributeTableRuleSet - the defaultAttributeTableRuleSet to set

setFeatureSimplifier

public void setFeatureSimplifier(FeatureSimplifier featureSimplifier)

DOCUMENT ME!

Parameters:

featureSimplifier - DOCUMENT ME!

getFeatureSimplifier

public FeatureSimplifier getFeatureSimplifier()

Description copied from interface: LayerProperties

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

Specified by:

getFeatureSimplifier in interface LayerProperties

Returns:

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