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.metadata.extent;
033    
034    import org.opengis.annotation.UML;
035    
036    import static org.opengis.annotation.Obligation.*;
037    import static org.opengis.annotation.Specification.*;
038    
039    
040    /**
041     * Base interface for geographic area of the dataset.
042     *
043     * @author  Martin Desruisseaux (IRD)
044     * @author  Cory Horner (Refractions Research)
045     * @version 3.0
046     * @since   1.0
047     */
048    @UML(identifier="EX_GeographicExtent", specification=ISO_19115)
049    public interface GeographicExtent {
050        /**
051         * Indication of whether the bounding polygon encompasses an area covered by the data
052         * (<cite>inclusion</cite>) or an area where data is not present (<cite>exclusion</cite>).
053         *
054         * @return {@code true} for inclusion, {@code false} for exclusion, or {@code null} if unspecified.
055         *
056         * @departure rename
057         *   The ISO identifier is <code>"extentTypeCode"</code> and defines the value 1 for inclusion,
058         *   and 0 for exclusion. GeoAPI uses a name which better expresses the meaning of the return
059         *   value.
060         */
061        @UML(identifier="extentTypeCode", obligation=OPTIONAL, specification=ISO_19115)
062        Boolean getInclusion();
063    }