001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-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.metadata.citation.Citation;
022import org.opengis.annotation.UML;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.*;
026
027
028/**
029 * Information about the outcome of evaluating the obtained value (or set of values) against
030 * a specified acceptable conformance quality level.
031 * Conformance result is often derived from a {@linkplain QuantitativeResult quantitative result}.
032 *
033 * @author  Martin Desruisseaux (IRD)
034 * @author  Cory Horner (Refractions Research)
035 * @author  Alexis Gaillard (Geomatys)
036 * @version 3.1
037 * @since   2.0
038 */
039@UML(identifier="DQ_ConformanceResult", specification=ISO_19157)
040public interface ConformanceResult extends Result {
041    /**
042     * Citation of data product specification or user requirement against which data are being evaluated.
043     *
044     * @return citation of product specification or user requirement.
045     */
046    @UML(identifier="specification", obligation=MANDATORY, specification=ISO_19157)
047    Citation getSpecification();
048
049    /**
050     * Explanation of the meaning of conformance for this result.
051     *
052     * @return explanation of the meaning of conformance, or {@code null} if none.
053     *
054     * @condition Optional if the {@linkplain #getResultScope() result scope} is not provided.
055     */
056    @UML(identifier="explanation", obligation=OPTIONAL, specification=ISO_19157)
057    default InternationalString getExplanation() {
058        return null;
059    }
060
061    /**
062     * Indication of the conformance result.
063     *
064     * @return {@code true} = pass, {@code false} = fail.
065     */
066    @UML(identifier="pass", obligation=MANDATORY, specification=ISO_19157)
067    Boolean pass();
068}