001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-2024 Open Geospatial Consortium, Inc.
004 *    http://www.geoapi.org
005 *
006 *    Licensed under the Apache License, Version 2.0 (the "License");
007 *    you may not use this file except in compliance with the License.
008 *    You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *    Unless required by applicable law or agreed to in writing, software
013 *    distributed under the License is distributed on an "AS IS" BASIS,
014 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 *    See the License for the specific language governing permissions and
016 *    limitations under the License.
017 */
018package org.opengis.metadata.extent;
019
020import org.opengis.annotation.UML;
021import org.opengis.annotation.Classifier;
022import org.opengis.annotation.Stereotype;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.*;
026
027
028/**
029 * Base interface for geographic area of the resource.
030 *
031 * @author  Martin Desruisseaux (IRD)
032 * @author  Cory Horner (Refractions Research)
033 * @version 3.1
034 * @since   1.0
035 */
036@Classifier(Stereotype.ABSTRACT)
037@UML(identifier="EX_GeographicExtent", specification=ISO_19115)
038public interface GeographicExtent {
039    /**
040     * Indication of whether the bounding polygon encompasses an area covered by the data
041     * (<dfn>inclusion</dfn>) or an area where data is not present (<dfn>exclusion</dfn>).
042     * The default value is {@code true}.
043     *
044     * @return {@code true} for inclusion, {@code false} for exclusion, or {@code null} if unspecified.
045     *
046     * @departure rename
047     *   The ISO identifier is {@code "extentTypeCode"} and defines the value 1 for inclusion,
048     *   and 0 for exclusion. GeoAPI uses a name which better expresses the meaning of the return value.
049     */
050    @UML(identifier="extentTypeCode", obligation=OPTIONAL, specification=ISO_19115)
051    default Boolean getInclusion() {
052        return null;
053    }
054}