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 java.util.Collection;
021import java.util.Collections;
022import java.time.temporal.Temporal;
023import org.opengis.util.InternationalString;
024import org.opengis.annotation.UML;
025import org.opengis.metadata.citation.Citation;
026
027import static org.opengis.annotation.Obligation.*;
028import static org.opengis.annotation.Specification.*;
029
030
031/**
032 * Description of the evaluation method and procedure applied.
033 * Data quality evaluation method should be included for each applied {@linkplain Element data quality measure}.
034 * It describes, or references documentation describing, the methodology used to apply a data quality measure
035 * to the data specified by a {@linkplain DataQuality#getScope() data quality scope}.
036 * {@code EvaluationMethod} can be specialized with {@link DataEvaluation} or {@link AggregationDerivation} subtypes.
037 *
038 * @author  Alexis Gaillard (Geomatys)
039 * @author  Martin Desruisseaux (Geomatys)
040 * @version 3.1
041 *
042 * @see Element#getEvaluationMethod()
043 *
044 * @since 3.1
045 */
046@UML(identifier="DQ_EvaluationMethod", specification=ISO_19157)
047public interface EvaluationMethod {
048    /**
049     * Type of method used to evaluate quality of the data.
050     *
051     * @return type of method used to evaluate quality, or {@code null} if none.
052     */
053    @UML(identifier="evaluationMethodType", obligation=OPTIONAL, specification=ISO_19157)
054    default EvaluationMethodType getEvaluationMethodType() {
055        return null;
056    }
057
058    /**
059     * Description of the evaluation method.
060     *
061     * @return description of the evaluation method, or {@code null} if none.
062     */
063    @UML(identifier="evaluationMethodDescription", obligation=OPTIONAL, specification=ISO_19157)
064    default InternationalString getEvaluationMethodDescription() {
065        return null;
066    }
067
068    /**
069     * Reference to the procedure information.
070     *
071     * @return reference to the procedure information, or {@code null} if none.
072     */
073    @UML(identifier="evaluationProcedure", obligation=OPTIONAL, specification=ISO_19157)
074    default Citation getEvaluationProcedure() {
075        return null;
076    }
077
078    /**
079     * Information on documents which are referenced in developing and applying a data quality evaluation method.
080     *
081     * @return documents referenced in data quality evaluation method.
082     *
083     * @departure rename
084     *   Renamed from {@code "referenceDoc"} to {@code "referenceDocument"}
085     *   for avoiding abbreviation (a Java usage).
086     */
087    @UML(identifier="referenceDoc", obligation=OPTIONAL, specification=ISO_19157)
088    default Collection<? extends Citation> getReferenceDocuments() {
089        return Collections.emptyList();
090    }
091
092    /**
093     * Date or range of dates on which a data quality measure was applied.
094     * The collection size is 1 for a single date, or 2 for a range.
095     * Returns an empty collection if this information is not available.
096     *
097     * @return date or range of dates on which a data quality measure was applied.
098     */
099    @UML(identifier="dateTime", obligation=OPTIONAL, specification=ISO_19157)
100    default Collection<? extends Temporal> getDates() {
101        return Collections.emptyList();
102    }
103}