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.Collection;
035 import org.opengis.geometry.primitive.Primitive;
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 geometric complex with an underlying core geometry that is isomorphic to a primitive. Thus,
045 * a composite curve is a collection of curves whose geometry interface could be satisfied by a
046 * single curve (albeit a much more complex one). Composites are intended for use as attribute
047 * values in datasets in which the underlying geometry has been decomposed, usually to expose its
048 * topological nature.
049 *
050 * @version <A HREF="http://www.opengeospatial.org/standards/as">ISO 19107</A>
051 * @author Martin Desruisseaux (IRD)
052 * @since GeoAPI 1.0
053 */
054 @UML(identifier="GM_Composite", specification=ISO_19107)
055 public interface Composite extends Complex {
056 /**
057 * Returns a homogeneous collection of {@linkplain Primitive primitives} whose union would be
058 * the core geometry of the composite. The complex would include all primitives in the generator
059 * and all primitives on the boundary of these primitives, and so forth until
060 * {@linkplain org.opengis.geometry.primitive.Point points} are included. Thus the
061 * {@code generators} on {@code Composite} is a subset of the
062 * {@linkplain Complex#getElements elements} on {@linkplain Complex complex}.
063 *
064 * @return The list of primitives in this composite.
065 *
066 * @see CompositePoint#getGenerators
067 * @see CompositeCurve#getGenerators
068 * @see CompositeSurface#getGenerators
069 * @see CompositeSolid#getGenerators
070 */
071 @Association("Composition")
072 @UML(identifier="generator", obligation=MANDATORY, specification=ISO_19107)
073 Collection<? extends Primitive> getGenerators();
074 }