001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2013 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.CurveInterpolation;
036 import org.opengis.geometry.primitive.CurveSegment;
037 import org.opengis.annotation.UML;
038
039 import static org.opengis.annotation.Obligation.*;
040 import static org.opengis.annotation.Specification.*;
041
042
043 /**
044 * Sequence of geodesic segments. The interface essentially combines a
045 * <code>Sequence<{@link Geodesic}></code> 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#createGeodesicString
053 */
054 @UML(identifier="GM_GeodesicString", specification=ISO_19107)
055 public interface GeodesicString extends CurveSegment {
056 /**
057 * Returns a sequence of positions between which this {@code GeodesicString} is interpolated
058 * using geodesics from the geoid or {@linkplain org.opengis.referencing.datum.Ellipsoid ellipsoid} of the
059 * {@linkplain org.opengis.referencing.crs.CoordinateReferenceSystem coordinate reference system} being used.
060 * The organization of these points is identical to that in {@link LineString}.
061 *
062 * @return The control points.
063 */
064 @UML(identifier="controlPoint", obligation=MANDATORY, specification=ISO_19107)
065 PointArray getControlPoints();
066
067 /**
068 * The interpolation for a {@code GeodesicString} is
069 * "{@linkplain CurveInterpolation#GEODESIC geodesic}".
070 *
071 * @return Always {@link CurveInterpolation#GEODESIC}.
072 */
073 @UML(identifier="interpolation", obligation=MANDATORY, specification=ISO_19107)
074 CurveInterpolation getInterpolation();
075
076 /**
077 * Decomposes a geodesic string into an equivalent sequence of geodesic segments.
078 *
079 * @return The equivalent sequence of geodesic segments.
080 */
081 @UML(identifier="asGM_Geodesic", obligation=MANDATORY, specification=ISO_19107)
082 List<Geodesic> asGeodesics();
083 }