org.opengis.metadata.quality.Scope Maven / Gradle / Ivy

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

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

import java.util.Collection;
import org.opengis.annotation.UML;
import org.opengis.metadata.extent.Extent;
import org.opengis.metadata.maintenance.ScopeCode;
import org.opengis.metadata.maintenance.ScopeDescription;

/**
 * Description of the data specified by the scope.
 *
 * @version ISO 19115
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 2.0
 */
@UML(identifier = "DQ_Scope", specification = ISO_19115)
public interface Scope {
    /**
     * Hierarchical level of the data specified by the scope.
     *
     * @return Hierarchical level of the data.
     */
    @UML(identifier = "level", obligation = MANDATORY, specification = ISO_19115)
    ScopeCode getLevel();

    /**
     * Detailed description about the level of the data specified by the scope. Should be defined
     * only if the {@linkplain #getLevel level} is not equal to {@link ScopeCode#DATASET DATASET} or
     * {@link ScopeCode#SERIES SERIES}.
     *
     * @return Detailed description about the level of the data.
     * @since GeoAPI 2.1
     */
    @UML(identifier = "levelDescription", obligation = CONDITIONAL, specification = ISO_19115)
    Collection getLevelDescription();

    /**
     * Information about the spatial, vertical and temporal extent of the data specified by the
     * scope.
     *
     * @return Information about the extent of the data, or {@code null}.
     */
    @UML(identifier = "extent", obligation = OPTIONAL, specification = ISO_19115)
    Extent getExtent();
}