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.complex;
033    
034    import java.util.Set;
035    import org.opengis.geometry.primitive.OrientableSurface;
036    import org.opengis.annotation.Association;
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     * A {@linkplain Complex complex} with all the geometric properties of a surface. Thus, this
045     * composite can be considered as a type of {@linkplain OrientableSurface orientable surface}.
046     * Essentially, a composite surface is a collection of oriented surfaces that join in pairs on
047     * common boundary curves and which, when considered as a whole, form a single surface.
048     *
049     * @version <A HREF="http://www.opengeospatial.org/standards/as">ISO 19107</A>
050     * @author Martin Desruisseaux (IRD)
051     * @since GeoAPI 1.0
052     *
053     * @todo This interface extends (indirectly) both {@link org.opengis.geometry.primitive.Primitive} and
054     *       {@link org.opengis.geometry.complex.Complex}. Concequently, there is a clash in the semantics
055     *       of some set theoretic operation. Specifically, {@code Primitive.contains(...)}
056     *       (returns FALSE for end points) is different from {@code Complex.contains(...)}
057     *       (returns TRUE for end points).
058     */
059    @UML(identifier="GM_CompositeSurface", specification=ISO_19107)
060    public interface CompositeSurface extends Composite, OrientableSurface {
061        /**
062         * Returns the set of orientable surfaces that form the core of this complex.
063         * To get a full representation of the elements in the {@linkplain Complex complex},
064         * the {@linkplain org.opengis.geometry.primitive.Curve curves} and
065         * {@linkplain org.opengis.geometry.primitive.Point points} on the boundary of the generator
066         * set of {@linkplain org.opengis.geometry.primitive.Surface surfaces} would be added to the
067         * curves in the generator list.
068         *
069         * @return The list of orientable surfaces in this composite.
070         *
071         * @see OrientableSurface#getComposite
072         * @issue http://jira.codehaus.org/browse/GEO-63
073         */
074        @Association("Composition")
075        @UML(identifier="generator", obligation=MANDATORY, specification=ISO_19107)
076        Set<OrientableSurface> getGenerators();
077    }