public interface Symbolizer extends Symbolizer
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.
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.
|
accept, getName, getUnitOfMeasure
void accept(StyleVisitor visitor)
void setUnitOfMeasure(Unit<Length> uom)
Recommended uom definitions are :
metre
foot
pixel
uom
- can be null, which indicates usage of the pixel unit.Description getDescription()
Symbolizer
getDescription
in interface Symbolizer
void setDescription(Description description)
void setName(String name)
Please consider getDescription().getTitle() as an alternative if presenting this symbolizer in a user interface.
String getGeometryPropertyName()
getGeometryPropertyName
in interface Symbolizer
null
to indicate default geometryvoid setGeometryPropertyName(String geometryPropertyName)
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.Expression getGeometry()
void setGeometry(Expression geometry)
getGeometry()
for further details.boolean hasOption(String key)
Map<String,String> getOptions()
Client code looking for the existence of a single option should use hasOption(String)
Copyright © 1996–2023 Geotools. All rights reserved.