001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.geometry.coordinate;
033    
034    import java.util.List;
035    import org.opengis.geometry.primitive.CurveSegment;
036    import org.opengis.annotation.UML;
037    
038    import static org.opengis.annotation.Obligation.*;
039    import static org.opengis.annotation.Specification.*;
040    
041    
042    /**
043     * A sequence of line segments, each having a parameterization like the one
044     * {@link LineSegment}. The class essentially combines a
045     * {@link List List<LineSegment>} into a single object,
046     * with the obvious savings of storage space.
047     *
048     * @version <A HREF="http://www.opengeospatial.org/standards/as">ISO 19107</A>
049     * @author Martin Desruisseaux (IRD)
050     * @since GeoAPI 1.0
051     *
052     * @see GeometryFactory#createLineString
053     */
054    @UML(identifier="GM_LineString", specification=ISO_19107)
055    public interface LineString extends CurveSegment {
056        /**
057         * Returns a sequence of positions between which the curve is linearly interpolated.
058         * The first position in the sequence is the {@linkplain #getStartPoint start Point}
059         * of this {@code LineString}, and the last point in the sequence is the
060         * {@linkplain #getEndPoint end point} of this {@code LineString}.
061         *
062         * @return The control points between which the curve is linearly interpolated.
063         */
064        @UML(identifier="controlPoint", obligation=MANDATORY, specification=ISO_19107)
065        PointArray getControlPoints();
066    
067        /**
068         * Decomposes a line string into an equivalent sequence of line segments.
069         *
070         * @return The sequence of line segments.
071         */
072        @UML(identifier="asGM_LineSegment", obligation=MANDATORY, specification=ISO_19107)
073        List<LineSegment> asLineSegments();
074    }