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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-main Show documentation

The main module contains the GeoTools public interfaces that are used by other GeoTools modules (and GeoTools applications). Where possible we make use industry standard terms as provided by OGC and ISO standards. The formal GeoTools public api consists of gt-metadata, jts and the gt-main module. The main module contains the default implementations that are available provided to other GeoTools modules using our factory system. Factories are obtained from an appropriate FactoryFinder, giving applications a chance configure the factory used using the Factory Hints facilities. FilterFactory ff = CommonFactoryFinder.getFilterFactory(); Expression expr = ff.add( expression1, expression2 ); If you find yourself using implementation specific classes chances are you doing it wrong: Expression expr = new AddImpl( expression1, expressiom2 );

There is a newer version: 24.2-oss84-1

Show newest version

/*
 *    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;

import java.util.List;

/**
 * Indicates how geographical content should be displayed (we call this a style for simplicity; in
 * the spec it is called a UserStyle (user-defined style)).
 *
 * The details of this object are taken from the OGC Styled-Layer Descriptor
 * Report (OGC 02-070) version 1.0.0.:
 *
 * 

 * <xsd:element name="UserStyle">
 *   <xsd:annotation>
 *     <xsd:documentation>
 *       A UserStyle allows user-defined styling and is semantically
 *       equivalent to a WMS named style.
 *     </xsd:documentation>
 *   </xsd:annotation>
 *   <xsd:complexType>
 *     <xsd:sequence>
 *       <xsd:element ref="sld:Name" minOccurs="0"/>
 *       <xsd:element ref="sld:Title" minOccurs="0"/>
 *       <xsd:element ref="sld:Abstract" minOccurs="0"/>
 *       <xsd:element ref="sld:IsDefault" minOccurs="0"/>
 *       <xsd:element ref="sld:FeatureTypeStyle" maxOccurs="unbounded"/>
 *     </xsd:sequence>
 *   </xsd:complexType>
 * </xsd:element>
 * 
 *
 * @version $Id$
 * @author James Macgill
 */
public interface Style extends org.opengis.style.Style {

    void setName(String name);

    /**
     * Description for this style.
     *
     * @return Human readable description for use in user interfaces
     * @since 2.5.x
     */
    Description getDescription();

    /**
     * Indicates that this is the default style.
     *
     * Assume this is kept for GeoServer enabling a WMS to track which style is considered the
     * default. May consider providing a clientProperties mechanism similar to Swing JComponent
     * allowing applications to mark up the Style content for custom uses.
     */
    void setDefault(boolean isDefault);

    /** FeatureTypeStyles rendered in order of appearance in this list. */
    public List featureTypeStyles();

    /**
     * This functionality is from an ISO specificaiton; and conflicts with the idea of an else rule
     * presented by SLD.
     *
     * Implementations may choose to look up the first symbolizer of an elseFilter or allow this
     * to be provided?
     *
     * @return Symbolizer to use if no rules work out.
     */
    public Symbolizer getDefaultSpecification();

    /** @param defaultSymbolizer To be used if a feature is not rendered by any of the rules */
    public void setDefaultSpecification(Symbolizer defaultSymbolizer);

    /** Used to navigate Style information during portrayal. */
    void accept(org.geotools.styling.StyleVisitor visitor);

    /** The background Fill , if any, null otherwise */
    public default Fill getBackground() {
        return null;
    }

    /** Sets the background color. Might throw an {@link UnsupportedOperationException}. */
    public default void setBackground(Fill background) {
        throw new UnsupportedOperationException();
    }
}