org.geotools.styling
Interface LineSymbolizer

All Superinterfaces:
LineSymbolizer, Symbolizer

public interface LineSymbolizer
extends LineSymbolizer, 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:

Author:
James Macgill, CCG
Module:
modules/library/api (gt-api.jar)

Method Summary
 Stroke getStroke()
          Provides the graphical-symbolization parameter to use for the linear geometry.
 void setGeometryPropertyName(String geometryPropertyName)
           
 void setPerpendicularOffset(Expression offset)
          Define an offset to draw lines in parallel to the original geometry.
 void setStroke(Stroke stroke)
          Provides the graphical-symbolization parameter to use for the linear geometry.
 
Methods inherited from interface LineSymbolizer
accept, getPerpendicularOffset
 
Methods inherited from interface Symbolizer
getGeometryPropertyName, getName, getUnitOfMeasure
 
Methods inherited from interface Symbolizer
accept, getDescription, setDescription, setName, setUnitOfMeasure
 
Methods inherited from interface Symbolizer
getGeometryPropertyName, getName, getUnitOfMeasure
 

Method Detail

getStroke

Stroke getStroke()
Provides the graphical-symbolization parameter to use for the linear geometry.

Specified by:
getStroke in interface LineSymbolizer
Returns:
The Stroke style to use when rendering lines.

setStroke

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.

setGeometryPropertyName

void setGeometryPropertyName(String geometryPropertyName)
Parameters:
geometry - property name

setPerpendicularOffset

void setPerpendicularOffset(Expression offset)
Define an offset to draw lines in parallel to the original geometry.

Parameters:
offset - Distance in UOMs to offset line; left-hand side is positive; right-hand side is negative; the default value is 0


Copyright © 1996-2009 Geotools. All Rights Reserved.