001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2005-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;
022import org.opengis.metadata.identification.BrowseGraphic;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.*;
026
027
028/**
029 * Data quality measure description.
030 * A description contains a mandatory text and an optional illustration.
031 *
032 * @author  Alexis Gaillard (Geomatys)
033 * @author  Martin Desruisseaux (Geomatys)
034 * @version 3.1
035 * @since   3.1
036 *
037 * @todo Renamed in 19157:2022: {@code MeasureDescription}.
038 */
039@UML(identifier="DQM_Description", specification=ISO_19157)
040public interface Description {
041    /**
042     * Text description.
043     *
044     * @return text description.
045     */
046    @UML(identifier="textDescription", obligation=MANDATORY, specification=ISO_19157)
047    InternationalString getTextDescription();
048
049    /**
050     * Illustration.
051     *
052     * @return description illustration, or {@code null} if none.
053     */
054    @UML(identifier="extendedDescription", obligation=OPTIONAL, specification=ISO_19157)
055    default BrowseGraphic getExtendedDescription() {
056        return null;
057    }
058}