org.geomajas.configuration

Class FeatureStyleInfo

java.lang.Object

org.geomajas.configuration.FeatureStyleInfo

All Implemented Interfaces:

Serializable, IsInfo, CacheableObject

@Api(allMethods=true)
public class FeatureStyleInfo
extends Object
implements IsInfo, CacheableObject

Style configuration information.

Since:

1.6.0

Author:

Joachim Van der Auwera

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_STYLE_INDEX Default value for style index, should be the last in sort order.

Constructor Summary

Constructors

Constructor and Description
FeatureStyleInfo() No args constructor for configuration and GWT.
FeatureStyleInfo(FeatureStyleInfo other) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyDefaults() Applies default values to all properties that have not been set.
boolean	equals(Object o) Are the two objects equal?
String	getCacheId() String identifier which is guaranteed to include sufficient information to assure to be different for two instances which could produce different result.
String	getDashArray() Get dash array to apply.
String	getFillColor() Get fill colour.
float	getFillOpacity() Get fill opacity.
String	getFormula() Get formula to test whether this style can be applied.
int	getIndex() Gets the ordering index of the style.
LayerType	getLayerType() Returns the geometry type for which this style is applicable.
String	getName() Get feature style name.
String	getStrokeColor() Get stroke colour.
float	getStrokeOpacity() Get stroke opacity.
int	getStrokeWidth() Get stroke width.
String	getStyleId() Return a unique style identifier for this client side style definition.
SymbolInfo	getSymbol() Get symbol to indicate feature.
int	hashCode() Calculate object hash code.
void	setDashArray(String dashArray) Set the dash array to apply.
void	setFillColor(String fillColor) Set fill colour.
void	setFillOpacity(float fillOpacity) Set the fill opacity.
void	setFormula(String formula) Set formula to test whether this style can be applied.
void	setIndex(int index) Sets the ordering index of the style.
void	setLayerType(LayerType layerType) Specifies the geometry type for which this style is applicable.
void	setName(String name) Set feature style name.
void	setStrokeColor(String strokeColor) Set stroke colour.
void	setStrokeOpacity(float strokeOpacity) Set the stroke opacity.
void	setStrokeWidth(int strokeWidth) Set stroke width.
void	setStyleId(String styleId) Set a unique style identifier for this client side style definition.
void	setSymbol(SymbolInfo symbol) Set symbol to indicate feature.
String	toString() String representation of object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_STYLE_INDEX

public static final int DEFAULT_STYLE_INDEX

Default value for style index, should be the last in sort order.

See Also:

Constant Field Values

Constructor Detail

FeatureStyleInfo

public FeatureStyleInfo()

No args constructor for configuration and GWT.

FeatureStyleInfo

public FeatureStyleInfo(FeatureStyleInfo other)

Copy constructor. Creates a deep copy of the specified FeatureStyleInfo object.

Parameters:

other - the feature style to copy

Since:

1.10.0

Method Detail

applyDefaults

public void applyDefaults()

Applies default values to all properties that have not been set.

Since:

1.8.0

getIndex

public int getIndex()

Gets the ordering index of the style. Styles are applied in the incremental order determined by their index values.

Returns:

index the ordering index

setIndex

public void setIndex(int index)

Sets the ordering index of the style. (auto-set by Spring)

Parameters:

index - ordering index

getName

public String getName()

Get feature style name.

Returns:

name

setName

public void setName(String name)

Set feature style name.

Parameters:

name - name

getFormula

public String getFormula()

Get formula to test whether this style can be applied.

Returns:

formula

setFormula

public void setFormula(String formula)

Set formula to test whether this style can be applied.

Parameters:

formula - formula

getFillColor

public String getFillColor()

Get fill colour.

Returns:

fill colour (in "#rrggbb" notation)

setFillColor

public void setFillColor(String fillColor)

Set fill colour.

Parameters:

fillColor - fill colour (in "#rrggbb" notation)

getFillOpacity

public float getFillOpacity()

Get fill opacity. The value should be in the [0,1] range, where 0 is fully transparent, and 1 is opaque.

Returns:

opacity for background fill

setFillOpacity

public void setFillOpacity(float fillOpacity)

Set the fill opacity. The value should be in the [0,1] range, where 0 is fully transparent, and 1 is opaque.

Parameters:

fillOpacity - opacity for background fill

getStrokeColor

public String getStrokeColor()

Get stroke colour.

Returns:

stroke colour (in "#rrggbb" notation)

setStrokeColor

public void setStrokeColor(String strokeColor)

Set stroke colour.

Parameters:

strokeColor - stroke colour (in "#rrggbb" notation)

getStrokeOpacity

public float getStrokeOpacity()

Get stroke opacity. The value should be in the [0,1] range, where 0 is fully transparent, and 1 is opaque.

Returns:

opacity for stroke colour

setStrokeOpacity

public void setStrokeOpacity(float strokeOpacity)

Set the stroke opacity. The value should be in the [0,1] range, where 0 is fully transparent, and 1 is opaque.

Parameters:

strokeOpacity - opacity for the stroke

getStrokeWidth

public int getStrokeWidth()

Get stroke width.

Returns:

stroke width

setStrokeWidth

public void setStrokeWidth(int strokeWidth)

Set stroke width.

Parameters:

strokeWidth - stroke width

getDashArray

public String getDashArray()

Get dash array to apply. When null, the line is solid.

Returns:

dash array, comma separated list of dash and gap lengths

setDashArray

public void setDashArray(String dashArray)

Set the dash array to apply. When null, the line is solid.

Parameters:

dashArray - dash array, comma separated list of dash and gap lengths

getSymbol

public SymbolInfo getSymbol()

Get symbol to indicate feature.

Returns:

symbol

setSymbol

public void setSymbol(SymbolInfo symbol)

Set symbol to indicate feature.

Parameters:

symbol - symbol

getStyleId

public String getStyleId()

Return a unique style identifier for this client side style definition. This value is set automatically on the server during initialization so don't set it in the configuration.

Returns:

style id

setStyleId

public void setStyleId(String styleId)

Set a unique style identifier for this client side style definition. This value is set automatically on the server during initialization so don't set it in the configuration.

Parameters:

styleId - style id

getLayerType

public LayerType getLayerType()

Returns the geometry type for which this style is applicable. Used to distinguish between geometry types for a mixed geometry layer when establishing a one-to-one relationship with SLD rules. Defaults to the layer type of the layer or LayerType.POLYGON for mixed geometry layers.

Returns:

the geometry type for this style (should be one of LayerType.POINT, LayerType.MULTIPOINT, LayerType.LINESTRING, LayerType.MULTILINESTRING, LayerType.POLYGON, or LayerType.MULTIPOLYGON

Since:

1.10.0

setLayerType

public void setLayerType(LayerType layerType)

Specifies the geometry type for which this style is applicable. Used to distinguish between geometry types for a mixed geometry layer when establishing a one-to-one relationship with SLD rules. Defaults to the layer type of the layer or LayerType.POLYGON for mixed geometry layers.

Parameters:

layerType - the geometry type for this style (should be one of LayerType.POINT, LayerType.MULTIPOINT, LayerType.LINESTRING, LayerType.MULTILINESTRING, LayerType.POLYGON, or LayerType.MULTIPOLYGON

Since:

1.10.0

getCacheId

public String getCacheId()

String identifier which is guaranteed to include sufficient information to assure to be different for two instances which could produce different result. It is typically used as basis for calculation of hash codes (like MD5, SHA1, SHA2 etc) of (collections of) objects.

Specified by:

getCacheId in interface CacheableObject

Returns:

cacheId

Since:

1.8.0

toString

public String toString()

String representation of object.

Overrides:

toString in class Object

Returns:

string representation of object

Since:

1.8.0

equals

public boolean equals(Object o)

Are the two objects equal?

Overrides:

equals in class Object

Parameters:

o - object to compare

Returns:

true when objects are equal

Since:

1.8.0

hashCode

public int hashCode()

Calculate object hash code.

Overrides:

hashCode in class Object

Returns:

hash code

Since:

1.8.0