org.geotools.styling
Interface LineSymbolizer

All Superinterfaces:

GTComponent, Symbolizer

All Known Implementing Classes:

LineSymbolizerImpl

public interface LineSymbolizer

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 override its default behaviour.

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

 <xsd:element name="LineSymbolizer" substitutionGroup="sld:Symbolizer">
   <xsd:annotation>
     <xsd:documentation>
       A LineSymbolizer is used to render a "stroke" along a linear geometry.
     </xsd:documentation>
   </xsd:annotation>
   <xsd:complexType>
     <xsd:complexContent>
       <xsd:extension base="sld:SymbolizerType">
         <xsd:sequence>
           <xsd:element ref="sld:Geometry" minOccurs="0"/>
           <xsd:element ref="sld:Stroke" minOccurs="0"/>
         </xsd:sequence>
       </xsd:extension>
     </xsd:complexContent>
   </xsd:complexType>
 </xsd:element>
 

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.

Notes:

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

Version:

$Id: LineSymbolizer.java 17702 2006-01-23 00:08:55Z desruisseaux $

Author:

James Macgill, CCG

Method Summary

java.lang.String	getGeometryPropertyName() This property defines the geometry to be used for styling.
Stroke	getStroke() Provides the graphical-symbolization parameter to use for the linear geometry.
void	setGeometryPropertyName(java.lang.String geometryPropertyName)
void	setStroke(Stroke stroke) Provides the graphical-symbolization parameter to use for the linear geometry.

Methods inherited from interface org.geotools.styling.Symbolizer

accept

Methods inherited from interface org.geotools.event.GTComponent

changed, getNote, getParent, removed, setNote

Method Detail

getStroke

public Stroke getStroke()

Provides the graphical-symbolization parameter to use for the linear geometry.

Returns:

The Stroke style to use when rendering lines.

setStroke

public void setStroke(Stroke stroke)

Provides the graphical-symbolization parameter to use for the linear geometry.

Parameters:

stroke - The Stroke style to use when rendering lines.

getGeometryPropertyName

public java.lang.String getGeometryPropertyName()

This property 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. Geometry types other than inherently linear types can be used. If a point geometry is used, it should be interpreted as a line of zero length and two end caps. If a polygon is used (or other "area" type) then its closed outline should be used as the line string (with no end caps). The geometryPropertyName is the name of a geometry property in the Feature being styled. 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.

Returns:

The name of the attribute in the feature being styled that should be used. If null then the default geometry should be used.

setGeometryPropertyName

public void setGeometryPropertyName(java.lang.String geometryPropertyName)