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.annotation.UML;
021
022import static org.opengis.annotation.Specification.*;
023
024
025/**
026 * Data absent from the data set.
027 * The data set is described by the {@linkplain DataQuality#getScope() scope}.
028 *
029 * <h2>Standardized values</h2>
030 * In order to achieve well defined and comparable quality information, it is recommended to
031 * report data quality using {@linkplain Measure quality measures} listed in ISO 19157 annex.
032 * The following table provides a summary; see ISO 19157 for more complete descriptions and examples.
033 * All identifiers should be in "ISO 19157" namespace.
034 *
035 * <table class="ogc">
036 *   <caption>Standardized values derived from ISO 19157</caption>
037 *   <tr>
038 *     <th>{@linkplain MeasureReference#getMeasureIdentification() Identifier}</th>
039 *     <th>{@linkplain MeasureReference#getNamesOfMeasure() Name of measure}</th>
040 *     <th>{@linkplain Measure#getBasicMeasure() Basic measure}</th>
041 *     <th>{@linkplain Measure#getValueType() Value type}</th>
042 *     <th>Remarks</th>
043 *   </tr><tr>
044 *     <td>5</td>
045 *     <td>missing item</td>
046 *     <td>error indicator</td>
047 *     <td>Boolean</td>
048 *     <td>{@code true} indicates that an item is missing</td>
049 *   </tr><tr>
050 *     <td>6</td>
051 *     <td>number of missing items</td>
052 *     <td>error count</td>
053 *     <td>Integer</td>
054 *     <td></td>
055 *   </tr><tr>
056 *     <td>7</td>
057 *     <td>rate of missing items</td>
058 *     <td>error rate</td>
059 *     <td>Real</td>
060 *     <td></td>
061 *   </tr>
062 * </table>
063 *
064 * <p>{@linkplain Measure#getDefinition() Definitions}:</p>
065 * <ol start="5">
066 *   <li>Indicator that shows a specific item is missing in the data.</li>
067 *   <li>Count of all items that should have been in the data set or sample and are missing.</li>
068 *   <li>Number of missing items in the data set or sample in relation to the number of items that should have been present.</li>
069 * </ol>
070 *
071 * @author  Martin Desruisseaux (IRD)
072 * @author  Alexis Gaillard (Geomatys)
073 * @version 3.1
074 *
075 * @see CompletenessCommission
076 *
077 * @since 2.0
078 *
079 * @todo Renamed in 19157:2022: {@code Omission}.
080 */
081@UML(identifier="DQ_CompletenessOmission", specification=ISO_19157)
082public interface CompletenessOmission extends Completeness {
083}