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.coverage;
033    
034    import java.util.Set;
035    import org.opengis.geometry.Geometry;
036    import org.opengis.temporal.TemporalGeometricPrimitive;
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     * Represents an element of the domain of the {@linkplain Coverage coverage}. It is an aggregation
045     * of objects that may include any combination of {@linkplain Geometry geometry}, or spatial or
046     * temporal objects such as {@linkplain org.opengis.coverage.grid.GridPoint grid point}.
047     *
048     * @param <G> The type of the geometry member.
049     *
050     * @version ISO 19123:2004
051     * @author  Stephane Fellah
052     * @author  Martin Desruisseaux (IRD)
053     * @since   GeoAPI 2.1
054     *
055     * @see Coverage#getDomainElements
056     */
057    @UML(identifier="CV_DomainObject", specification=ISO_19123)
058    public interface DomainObject<G extends Geometry> {
059        /**
060         * Returns the set of geometries of which this domain is composed.
061         * The set may be empty.
062         *
063         * @return The spatial component of the domain.
064         */
065        @UML(identifier="spatialElement", obligation=OPTIONAL, specification=ISO_19123)
066        Set<G> getSpatialElements();
067    
068        /**
069         * Returns the set of geometric primitives of which this domain is composed.
070         * The set may be empty.
071         *
072         * @return The temporal component of the domain.
073         */
074        @UML(identifier="temporalElement", obligation=OPTIONAL, specification=ISO_19123)
075        Set<TemporalGeometricPrimitive> getTemporalElements();
076    }