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.quality;
019
020import java.util.Collection;
021import java.util.Iterator;
022
023import org.opengis.metadata.extent.Extent;
024import org.opengis.metadata.maintenance.ScopeCode;
025import org.opengis.metadata.maintenance.ScopeDescription;
026import org.opengis.annotation.UML;
027import org.opengis.annotation.Classifier;
028import org.opengis.annotation.Stereotype;
029
030import static org.opengis.annotation.Obligation.*;
031import static org.opengis.annotation.Specification.ISO_19115;
032
033
034/**
035 * Description of the data specified by the scope.
036 *
037 * <div class="warning"><b>Upcoming API change — renaming</b><br>
038 * As of ISO 19115:2014,
039 * {@code DQ_Scope} (from {@link org.opengis.metadata.quality}) is replaced by
040 * {@code MD_Scope} (from {@link org.opengis.metadata.maintenance}).
041 * This interface will be deprecated in GeoAPI 4.0.
042 * </div>
043 *
044 * @author  Martin Desruisseaux (IRD)
045 * @version 3.1
046 * @since   2.0
047 */
048@Classifier(Stereotype.DATATYPE)
049@UML(identifier="DQ_Scope", specification=ISO_19115, version=2003)
050public interface Scope extends org.opengis.metadata.maintenance.Scope {
051    /**
052     * Hierarchical level of the data specified by the scope.
053     *
054     * @return hierarchical level of the data.
055     */
056    @Override
057    @UML(identifier="level", obligation=MANDATORY, specification=ISO_19115)
058    ScopeCode getLevel();
059
060    /**
061     * Information about the spatial, vertical and temporal extent of the data specified by the scope.
062     *
063     * @return information about the extent of the data, or {@code null}.
064     *
065     * @deprecated As of ISO 19115:2014, replaced by {@link #getExtents()}.
066     */
067    @Deprecated(since="3.1")
068    @UML(identifier="extent", obligation=OPTIONAL, specification=ISO_19115, version=2003)
069    default Extent getExtent() {
070        Iterator<? extends Extent> it = getExtents().iterator();
071        return it.hasNext() ? it.next() : null;
072    }
073
074    /**
075     * Detailed description about the level of the data specified by the scope.
076     * Shall be defined only if the {@linkplain #getLevel() level} is not equal
077     * to {@link ScopeCode#DATASET} or {@link ScopeCode#SERIES}.
078     *
079     * @return detailed description about the level of the data.
080     */
081    @Override
082    @UML(identifier="levelDescription", obligation=CONDITIONAL, specification=ISO_19115)
083    Collection<? extends ScopeDescription> getLevelDescription();
084}