001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2005-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.Curve;
036 import org.opengis.geometry.primitive.Surface;
037 import org.opengis.geometry.primitive.SurfacePatch;
038 import org.opengis.geometry.primitive.SurfaceBoundary;
039 import org.opengis.geometry.complex.Complex;
040 import org.opengis.annotation.UML;
041
042 import static org.opengis.annotation.Obligation.*;
043 import static org.opengis.annotation.Specification.*;
044
045
046 /**
047 * A surface patch that is defined by a set of boundary curves and an underlying surface to
048 * which these curves adhere. The default is that the curves are coplanar and the polygon
049 * uses planar interpolation in its interior.
050 *
051 * @version <A HREF="http://www.opengeospatial.org/standards/as">ISO 19107</A>
052 * @author Martin Desruisseaux (IRD)
053 * @since GeoAPI 2.0
054 *
055 * @see GeometryFactory#createPolygon(SurfaceBoundary)
056 * @see GeometryFactory#createPolygon(SurfaceBoundary,Surface)
057 */
058 @UML(identifier="GM_Polygon", specification=ISO_19107)
059 public interface Polygon extends SurfacePatch {
060 /**
061 * The surface boundary that is the boundary of this polygon.
062 * The boundary of a surface patch need not be in the same {@linkplain Complex complex}
063 * as the containing {@linkplain Surface surface}. The curves that are contained in the
064 * interior of the {@linkplain Surface surface} (act as common boundary to 2 surface patches)
065 * are not part of any {@linkplain Complex complex} in which the {@linkplain Surface surface}
066 * is contained. They are purely constructive and would not play in any topological relation
067 * between {@linkplain Surface surface} and {@linkplain Curve curve} that defines the connectivity
068 * of the {@linkplain Complex complex}.
069 */
070 @UML(identifier="boundary", obligation=MANDATORY, specification=ISO_19107)
071 SurfaceBoundary getBoundary();
072
073 /**
074 * Provides a mechanism for spanning the interior of the polygon.
075 * The spanning surface should have no boundary components that intersect the boundary of the
076 * polygon, and there should be no ambiguity as to which portion of the surface is described by
077 * the bounding curves for the polygon. The most common spanning surface is an elevation model,
078 * which is not directly described in this standard, although {@linkplain Tin tins} and
079 * {@linkplain GriddedSurface gridded surfaces} are often used in this role.
080 */
081 @UML(identifier="spanningSurface", obligation=OPTIONAL, specification=ISO_19107)
082 List<Surface> getSpanningSurface();
083
084 /**
085 * Returns the patch which own this surface patch.
086 */
087 @UML(identifier="surface", obligation=MANDATORY, specification=ISO_19107)
088 PolyhedralSurface getSurface();
089 }