org.geotools.styling
Interface PointSymbolizer

All Superinterfaces:
PointSymbolizer, Symbolizer

public interface PointSymbolizer
extends PointSymbolizer, Symbolizer

A symbolizer describes how a feature should appear on a map.

The symbolizer defines 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.:


 <xsd:element name="PointSymbolizer" substitutionGroup="sld:Symbolizer">
   <xsd:annotation>
     <xsd:documentation>
       A "PointSymbolizer" specifies the rendering of a "graphic symbol"
       at a point.
     </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:Graphic" 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
Module:
modules/library/api (gt-api.jar)

Method Summary
 String getGeometryPropertyName()
          This property defines the geometry to be used for styling.
 Graphic getGraphic()
          Provides the graphical-symbolization parameter to use for the point geometry.
 void setGeometryPropertyName(String geometryPropertyName)
          This property defines the geometry to be used for styling.
 void setGraphic(Graphic graphic)
          Provides the graphical-symbolization parameter to use for the point geometry.
 
Methods inherited from interface PointSymbolizer
accept
 
Methods inherited from interface Symbolizer
getName, getUnitOfMeasure
 
Methods inherited from interface Symbolizer
accept, getDescription, setDescription, setName, setUnitOfMeasure
 
Methods inherited from interface Symbolizer
getName, getUnitOfMeasure
 

Method Detail

getGraphic

Graphic getGraphic()
Provides the graphical-symbolization parameter to use for the point geometry.

Specified by:
getGraphic in interface PointSymbolizer
Returns:
The Graphic to be used when drawing a point.

setGraphic

void setGraphic(Graphic graphic)
Provides the graphical-symbolization parameter to use for the point geometry.


getGeometryPropertyName

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 point types can be used. 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.

Specified by:
getGeometryPropertyName in interface Symbolizer

setGeometryPropertyName

void setGeometryPropertyName(String geometryPropertyName)
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 point types can be used. 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.



Copyright © 1996-2009 Geotools. All Rights Reserved.