org.geotools.styling

Interface Symbolizer

All Superinterfaces:

Symbolizer

All Known Subinterfaces:

ExtensionSymbolizer, LineSymbolizer, PointSymbolizer, PolygonSymbolizer, RasterSymbolizer, TextSymbolizer, TextSymbolizer2

All Known Implementing Classes:

TextSymbolizerImpl

public interface Symbolizer
extends Symbolizer

This is the parent interface of all Symbolizers.

A symbolizer describes how a feature should appear on a map. The symbolizer describes not just the shape that should appear but also such graphical properties as color and opacity.

A symbolizer is obtained by specifying one of a small number of different types of symbolizer and then supplying parameters to overide its default behaviour.

The details of this object are taken from the OGC Styled-Layer Descriptor Report (OGC 02-070) version 1.0.0.

Renderers can use this information when displaying styled features, though it must be remembered that not all renderers will be able to fully represent strokes as set out by this interface. For example, opacity may not be supported.

The graphical parameters and their values are derived from SVG/CSS2 standards with names and semantics which are as close as possible.

Author:

James Macgill, CCG

Method Summary

Modifier and Type	Method and Description
void	accept(StyleVisitor visitor)
Description	getDescription() Returns the description of this symbolizer.
Expression	getGeometry() This defines the geometry to be used for styling.
String	getGeometryPropertyName() A shortcut to get the geometry property name in the case the geometry expression is a PropertyName.
Map<String,String>	getOptions() Map of vendor options for the symbolizer.
boolean	hasOption(String key) Determines if a vendor option with the specific key has been set on this symbolizer.
void	setDescription(Description description) Tile and Abstract of Symbolzer.
void	setGeometry(Expression geometry) Sets the expression used for styling.
void	setGeometryPropertyName(String geometryPropertyName) A shortcut to define the geometry expression as a PropertyName Typically, features only have one geometry so, in general, the need to select one is not required.
void	setName(String name) Name of symbolizer; not always human readable.
void	setUnitOfMeasure(Unit<Length> uom) Defines a measure unit for the symbolizer.

Methods inherited from interface Symbolizer

accept, getName, getUnitOfMeasure

Method Detail

accept

void accept(StyleVisitor visitor)

setUnitOfMeasure

void setUnitOfMeasure(Unit<Length> uom)

Defines a measure unit for the symbolizer. This parameter is inherited from GML. Renderers shall use the unit to correctly render symbols.

Recommended uom definitions are :

• metre
• foot
• pixel

Parameters:

uom - can be null, which indicates usage of the pixel unit.

Since:

SymbologyEncoding 1.1

getDescription

Description getDescription()

Description copied from interface: Symbolizer

Returns the description of this symbolizer.

Specified by:

getDescription in interface Symbolizer

Returns:

Description with usual informations used for user interfaces.

setDescription

void setDescription(Description description)

Tile and Abstract of Symbolzer.

Since:

SymbologyEncoding 1.1

setName

void setName(String name)

Name of symbolizer; not always human readable.

Please consider getDescription().getTitle() as an alternative if presenting this symbolizer in a user interface.

Since:

SymbologyEncoding 1.1

getGeometryPropertyName

String getGeometryPropertyName()

A shortcut to get the geometry property name in the case the geometry expression is a PropertyName. In case the geometry expression is null, and in the case the geometry expression is not a PropertyName, this method will return null.

Specified by:

getGeometryPropertyName in interface Symbolizer

Returns:

Geometry attribute name, or null to indicate default geometry

setGeometryPropertyName

void setGeometryPropertyName(String geometryPropertyName)

A shortcut to define the geometry expression as a PropertyName Typically, features only have one geometry so, in general, the need to select one is not required. Note: this moves a little away from the SLD spec which provides an XPath reference to a Geometry object, but does follow it in spirit.

getGeometry

Expression getGeometry()

This defines the geometry to be used for styling.
The property is optional and if it is absent (null) then the "default" geometry property of the feature should be used.
Typically, features only have one geometry so, in general, the need to select one is not required.
The expression can also build a new geometry out of existing attributes or transform an existing geometry. For geometry transformations that do change the geometry locations or that make up geometries out of non geometric attributes it is advised that the Expression implements the SpatialTransformationFunction interface

setGeometry

void setGeometry(Expression geometry)

Sets the expression used for styling. See getGeometry() for further details.

hasOption

boolean hasOption(String key)

Determines if a vendor option with the specific key has been set on this symbolizer.

getOptions

Map<String,String> getOptions()

Map of vendor options for the symbolizer.

Client code looking for the existence of a single option should use hasOption(String)