001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2022-2023 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 org.opengis.util.InternationalString;
021import org.opengis.annotation.UML;
022
023import static org.opengis.annotation.Obligation.*;
024import static org.opengis.annotation.Specification.*;
025
026
027/**
028 * Test performed on a subset of the geographic data defined by the data quality scope.
029 *
030 * @author  Alexis Gaillard (Geomatys)
031 * @author  Martin Desruisseaux (Geomatys)
032 * @version 3.1
033 *
034 * @see FullInspection
035 * @see IndirectEvaluation
036 *
037 * @since 3.1
038 */
039@UML(identifier="DQ_SampleBasedInspection", specification=ISO_19157)
040public interface SampleBasedInspection extends DataEvaluation {
041    /**
042     * Information of the type of sampling scheme and description of the sampling procedure.
043     *
044     * @return sampling scheme and sampling procedure.
045     */
046    @UML(identifier="samplingScheme", obligation=MANDATORY, specification=ISO_19157)
047    InternationalString getSamplingScheme();
048
049    /**
050     * Information of how lots are defined.
051     *
052     * @return information on lots.
053     */
054    @UML(identifier="lotDescription", obligation=MANDATORY, specification=ISO_19157)
055    InternationalString getLotDescription();
056
057    /**
058     * Information on how many samples on average are extracted for inspection from each lot of population.
059     * A lot is the minimum unit for which quality may be evaluated.
060     *
061     * @return average number of samples extracted for inspection.
062     */
063    @UML(identifier="samplingRatio", obligation=MANDATORY, specification=ISO_19157)
064    InternationalString getSamplingRatio();
065}