org.geotools.styling.PointSymbolizer Maven / Gradle / Ivy

Go to download
/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2002-2008, Open Source Geospatial Foundation (OSGeo)
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 */
package org.geotools.styling;

/**
 * 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.
 * 
 *
 * @author James Macgill
 * @version $Id$
 */
public interface PointSymbolizer extends org.opengis.style.PointSymbolizer, Symbolizer {

    /**
     * Boolean vendor option, defaults to true. If true, in case no specified mark or graphics can
     * be used, the default square mark will be used instead. If false, the symbol will not be
     * painted.
     */
    public static String FALLBACK_ON_DEFAULT_MARK = "fallbackOnDefaultMark";

    /**
     * Provides the graphical-symbolization parameter to use for the point geometry.
     *
     * @return The Graphic to be used when drawing a point.
     */
    Graphic getGraphic();

    /** Provides the graphical-symbolization parameter to use for the point geometry. */
    void setGraphic(org.opengis.style.Graphic graphic);
}