org.geotools.styling
Interface Symbolizer

All Superinterfaces:
org.opengis.style.Symbolizer
All Known Subinterfaces:
ExtensionSymbolizer, LineSymbolizer, PointSymbolizer, PolygonSymbolizer, RasterSymbolizer, TextSymbolizer, TextSymbolizer2
All Known Implementing Classes:
TextSymbolizerImpl

public interface Symbolizer
extends org.opengis.style.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.

Version:
$Id: Symbolizer.java 34564 2009-11-30 16:08:45Z aaime $
Author:
James Macgill, CCG

Method Summary
 void accept(StyleVisitor visitor)
           
 Description getDescription()
           
 org.opengis.filter.expression.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.
 java.lang.String getGeometryPropertyName()
          A shortcut to get the geometry property name in the case the geometry expression is a PropertyName.
 void setDescription(org.opengis.style.Description description)
          Tile and Abstract of Symbolzer.
 void setGeometry(org.opengis.filter.expression.Expression geometry)
          Sets the expression used for styling.
 void setGeometryPropertyName(java.lang.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(java.lang.String name)
          Name of symbolizer; not always human readable.
 void setUnitOfMeasure(javax.measure.unit.Unit<javax.measure.quantity.Length> uom)
          Defines a measure unit for the symbolizer.
 
Methods inherited from interface org.opengis.style.Symbolizer
accept, getName, getUnitOfMeasure
 

Method Detail

accept

void accept(StyleVisitor visitor)

setUnitOfMeasure

void setUnitOfMeasure(javax.measure.unit.Unit<javax.measure.quantity.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 :

Parameters:
uom - can be null, which indicates usage of the pixel unit.
Since:
SymbologyEncoding 1.1

getDescription

Description getDescription()
Specified by:
getDescription in interface org.opengis.style.Symbolizer

setDescription

void setDescription(org.opengis.style.Description description)
Tile and Abstract of Symbolzer.

Parameters:
description -
Since:
SymbologyEncoding 1.1

setName

void setName(java.lang.String name)
Name of symbolizer; not always human readable.

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

Parameters:
name -
Since:
SymbologyEncoding 1.1

getGeometryPropertyName

java.lang.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 org.opengis.style.Symbolizer

setGeometryPropertyName

void setGeometryPropertyName(java.lang.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

org.opengis.filter.expression.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(org.opengis.filter.expression.Expression geometry)
Sets the expression used for styling. See getGeometry() for further details.

Parameters:
geometry -


Copyright © 1996-2010 Geotools. All Rights Reserved.