Interface Symbolizer

  • All Known Subinterfaces:
    ExtensionSymbolizer, LineSymbolizer, PointSymbolizer, PolygonSymbolizer, RasterSymbolizer, TextSymbolizer

    @UML(identifier="PF_PortrayalSpecification",
         specification=ISO_19117)
    public interface Symbolizer
    Abstract superclass of the symbolizers defined by the Symbology Encoding specification.

    Please note you are not free to create your own subtype o Symbolizer - we are limited to LineSymbolizer, PointSymbolizer, PolygonSymbolizer, RasterSymbolizer and TextSymbolizer.

    Using a static geometry

    One can use static geometry if needed, see getGeometryPropertyName()

    Particular cases if the geometry is not the defined type of the symbolizer

    Geometry types other than inherently linear types can also be used. If a point geometry is used, it should be interpreted as a line of "epsilon" (arbitrarily small) length with a horizontal orientation centered on the point, and should be rendered with two end caps. If a polygon is used (or other "area" type), then its closed outline is used as the line string (with no end caps). If a raster geometry is used, its coverage-area outline is used for the line, rendered with no end caps.
    Since:
    GeoAPI 2.2
    • Method Detail

      • getUnitOfMeasure

        @XmlElement("uom")
        Unit<Length> getUnitOfMeasure()
        Returns a measure unit. This parameter is inherited from GML. Renderers shall use the unit to correctly render symbols. Recommended uom definitions are :
        • metre
        • foot
        • pixel
        Returns:
        can be null. If the unit is null than we shall use a the pixel unit
      • getGeometryPropertyName

        @XmlElement("Geometry")
        @Deprecated
        String getGeometryPropertyName()
        Deprecated.
        use getGeometry() instead.
        Returns the name of the geometry feature attribute to use for drawing. May return null (or Expression.NIL) if this symbol is to use the default geometry attribute, whatever it may be. Using null in this fashion is similar to a PropertyName using the XPath expression ".".

        The content of the element gives the property name in XPath syntax. In principle, a fixed geometry could be defined using GML or operators could be defined for computing the geometry from references or literals. However, using a feature property directly is by far the most commonly useful method.

        Returns:
        Geometry attribute name if geometry expression is a PropertyName, or null if geometry expression is not a PropertyName.
      • getGeometry

        Expression getGeometry()
        Expression used to define a geometry for drawing. May return null if the default geometry attribute should be used. This expression is often a PropertyName.
        Returns:
        Expression used to define a geometry for drawing, or Expression.NIL if the default geometry should be used.
      • getName

        @XmlElement("Name")
        String getName()
        Returns a name for this symbolizer. This can be any string that uniquely identifies this style within a given canvas. It is not meant to be human-friendly. (The "title" property is meant to be human friendly.)
        Returns:
        a name for this style.
      • getDescription

        @XmlElement("Description")
        Description getDescription()
        Returns the description of this symbolizer.
        Returns:
        description with usual informations used for user interfaces.
      • accept

        Object accept​(StyleVisitor visitor,
                      Object extraData)
        Calls the visit method of a StyleVisitor
        Parameters:
        visitor - the style visitor
        Returns:
        value produced