org.geotools.styling
Interface PointSymbolizer

All Superinterfaces:

GTComponent, Symbolizer

All Known Implementing Classes:

PointSymbolizerImpl

public interface PointSymbolizer

extends 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:

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

Version:

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

Author:

James Macgill

Method Summary

java.lang.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(java.lang.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 org.geotools.styling.Symbolizer

accept

Methods inherited from interface org.geotools.event.GTComponent

changed, getNote, getParent, removed, setNote

Method Detail

getGraphic

public Graphic getGraphic()

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

Returns:

The Graphic to be used when drawing a point.

setGraphic

public void setGraphic(Graphic graphic)

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

Parameters:

graphic - DOCUMENT ME!

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 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.

Returns:

String 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)

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.

Parameters:

geometryPropertyName - DOCUMENT ME!