/*
* OSGeom -- Geometry Collab
*
* (C) 2009, Open Source Geospatial Foundation (OSGeo)
* (C) 2001-2009 Department of Geography, University of Bonn
* (C) 2001-2009 lat/lon GmbH
*
* 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.osgeo.geometry.primitive;
import java.util.List;
import org.osgeo.geometry.primitive.patches.PolygonPatch;
/**
* A {@link Surface} that consists of one single planar patch (a {@link PolygonPatch}).
* <p>
* Please note that a {@link Polygon} is not restricted to use linear interpolation for its exterior and interior rings
* (just as a {@link PolygonPatch}).
* </p>
*
* @author <a href="mailto:schneider@lat-lon.de">Markus Schneider </a>
* @author last edited by: $Author$
*
* @version $Revision$, $Date$
*/
public interface Polygon extends Surface {
/**
* Must always return {@link Surface.SurfaceType#Polygon}.
*
* @return {@link Surface.SurfaceType#Polygon}
*/
public SurfaceType getSurfaceType();
/**
* Returns the exterior ring of the polygon.
* <p>
* Please note that this method may return null. The following explanation is from the GML 3.1.1 spec (section
* 9.2.2.5): In the normal 2D case, one of these rings is distinguished as being the exterior boundary. In a general
* manifold this is not always possible, in which case all boundaries shall be listed as interior boundaries, and
* the exterior will be empty.
*
* @return the exterior ring, or null if no ring is distinguished as being the exterior boundary
*/
public Ring getExteriorRing();
/**
* Returns the interior rings (holes) of the polygon.
*
* @return the interior rings (holes) of the polygon, list may be empty (but not null)
*/
public List<Ring> getInteriorRings();
/**
* Returns a list that contains the one {@link PolygonPatch} that constitutes this polygon.
*
* @return a list that contains the single planar patch that constitutes this surface
*/
public List<PolygonPatch> getPatches();
}