org.geotools.styling.LinePlacement 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 org.opengis.filter.expression.Expression;

/**
 * The "LinePlacement" specifies where and how a text label should be rendered relative to a line.
 *
 * The details of this object are taken from the OGC Styled-Layer Descriptor
 * Report (OGC 02-070) version 1.0.0.:
 *
 * 

 * <xsd:element name="LinePlacement">
 *   <xsd:annotation>
 *     <xsd:documentation>
 *       A "LinePlacement" specifies how a text label should be rendered
 *       relative to a linear geometry.
 *     </xsd:documentation>
 *   </xsd:annotation>
 *   <xsd:complexType>
 *     <xsd:sequence>
 *       <xsd:element ref="sld:PerpendicularOffset" minOccurs="0"/>
 *     </xsd:sequence>
 *   </xsd:complexType>
 * </xsd:element>
 * 
 *
 * $Id$
 *
 * @author Ian Turton, CCG
 */
public interface LinePlacement extends org.opengis.style.LinePlacement, LabelPlacement {

    /** Correct method name violation from GeoAPI. */
    boolean isAligned();

    /**
     * Returns the expression that is used to compute how far from the lines the text will be drawn.
     * The distance must evaluate to a non-negative number.
     *
     * @return compute how far from the line the text will be drawn
     */
    Expression getPerpendicularOffset();

    /**
     * Sets the expression that is used to compute how far from the lines the text will be drawn.
     * See {@link #getPerpendicularOffset} for details.
     */
    void setPerpendicularOffset(Expression offset);

    public void setRepeated(boolean repeated);

    public void setGeneralized(boolean generalized);

    public void setAligned(boolean aligned);

    public void setGap(Expression gap);

    public void setInitialGap(Expression initialGap);
}