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
Module:
modules/library/api (gt-api.jar)

Method Summary
 void accept(StyleVisitor visitor)
           
 Description getDescription()
           
 void setDescription(Description description)
          Tile and Abstract of Symbolzer.
 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, getGeometryPropertyName, 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 :

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

getDescription

Description getDescription()
Specified by:
getDescription in interface Symbolizer

setDescription

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

Parameters:
description -
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.

Parameters:
name -
Since:
SymbologyEncoding 1.1


Copyright © 1996-2009 Geotools. All Rights Reserved.