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.primitive;
033
034 import org.opengis.geometry.complex.CompositeCurve;
035 import org.opengis.annotation.Association;
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 curve and an orientation inherited from {@link OrientablePrimitive}. If the orientation is
044 * positive, then the {@code OrientableCurve} is a {@linkplain Curve curve}. If the orientation
045 * is negative, then the {@code OrientableCurve} is related to another {@linkplain Curve curve}
046 * with a parameterization that reverses the sense of the curve traversal.
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 @UML(identifier="GM_OrientableCurve", specification=ISO_19107)
053 public interface OrientableCurve extends OrientablePrimitive {
054 /**
055 * Returns an ordered pair of points, which are the start point and end point of the curve.
056 * If the curve is closed, then the boundary shall be empty.
057 *
058 * @return The sets of positions on the boundary.
059 */
060 @UML(identifier="boundary", obligation=MANDATORY, specification=ISO_19107)
061 CurveBoundary getBoundary();
062
063 /**
064 * Returns the primitive associated with this {@code OrientableCurve}.
065 *
066 * @return The primitive, or {@code null} if the association is
067 * not available or not implemented that way.
068 *
069 * @see Curve#getProxy
070 * @issue http://jira.codehaus.org/browse/GEO-63
071 */
072 @Association("Oriented")
073 @UML(identifier="primitive", obligation=OPTIONAL, specification=ISO_19107)
074 Curve getPrimitive();
075
076 /**
077 * Returns the owner of this orientable curve. This method is <em>optional</em> since
078 * the association in ISO 19107 is navigable only from {@code CompositeCurve} to
079 * {@code OrientableCurve}, not the other way.
080 *
081 * @return The owner of this orientable curve, or {@code null} if the association is
082 * not available or not implemented that way.
083 *
084 * @see CompositeCurve#getGenerators
085 * @issue http://jira.codehaus.org/browse/GEO-63
086 */
087 @Association("Composition")
088 @UML(identifier="composite", obligation=OPTIONAL, specification=ISO_19107)
089 CompositeCurve getComposite();
090 }