org.opengis.geometry.complex.CompositeSolid Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation

Standard interfaces implemented throughout the library.

There is a newer version: 24.2-oss84-1

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2003-2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.geometry.complex;

import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;

import java.util.Set;
import org.opengis.annotation.Association;
import org.opengis.annotation.UML;
import org.opengis.geometry.primitive.Solid;

/**
 * A {@linkplain Complex complex} with all the geometric properties of a solid. Essentially, a
 * composite solid is a set of solids that join in pairs on common boundary surfaces to form a
 * single solid.
 *
 * @version ISO 19107
 * @author Martin Desruisseaux (Geomatys)
 * @since GeoAPI 2.1
 * @todo This interface extends (indirectly) both {@link org.opengis.geometry.primitive.Primitive}
 *     and {@link org.opengis.geometry.complex.Complex}. Concequently, there is a clash in the
 *     semantics of some set theoretic operation. Specifically, {@code Primitive.contains(...)}
 *     (returns FALSE for end points) is different from {@code Complex.contains(...)} (returns TRUE
 *     for end points).
 */
@UML(identifier = "GM_CompositeSurface", specification = ISO_19107)
public interface CompositeSolid extends Composite, Solid {
    /**
     * Returns the set of solids that form the core of this complex. To get a full representation of
     * the elements in the {@linkplain Complex complex}, the {@linkplain
     * org.opengis.geometry.primitive.Surface surfaces}, {@linkplain
     * org.opengis.geometry.primitive.Curve curves} and {@linkplain
     * org.opengis.geometry.primitive.Point points} on the boundary of the generator set if
     * {@linkplain Solid solids} would have to be added to the generator list.
     *
     * @return The set of solids in this composite.
     * @see Solid#getComposite
     * @issue http://jira.codehaus.org/browse/GEO-63
     */
    @Association("Composition")
    @UML(identifier = "generator", obligation = MANDATORY, specification = ISO_19107)
    Set getGenerators();
}