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 * Adherence of values to the value domains.
027 *
028 * <h2>Standardized values</h2>
029 * In order to achieve well defined and comparable quality information, it is recommended to
030 * report data quality using {@linkplain Measure quality measures} listed in ISO 19157 annex.
031 * The following table provides a summary; see ISO 19157 for more complete descriptions and examples.
032 * All identifiers should be in "ISO 19157" namespace.
033 *
034 * <table class="ogc">
035 *   <caption>Standardized values derived from ISO 19157</caption>
036 *   <tr>
037 *     <th>{@linkplain MeasureReference#getMeasureIdentification() Identifier}</th>
038 *     <th>{@linkplain MeasureReference#getNamesOfMeasure() Name of measure}</th>
039 *     <th>{@linkplain Measure#getBasicMeasure() Basic measure}</th>
040 *     <th>{@linkplain Measure#getValueType() Value type}</th>
041 *     <th>Remarks</th>
042 *   </tr><tr>
043 *     <td>14</td>
044 *     <td>value domain non-conformance</td>
045 *     <td>error indicator</td>
046 *     <td>Boolean</td>
047 *     <td>{@code true} indicates that an item is not in conformance with its value domain</td>
048 *   </tr><tr>
049 *     <td>15</td>
050 *     <td>value domain conformance</td>
051 *     <td>correctness indicator</td>
052 *     <td>Boolean</td>
053 *     <td>{@code true} indicates that an item is in compliance with its value domain</td>
054 *   </tr><tr>
055 *     <td>16</td>
056 *     <td>number of items not in conformance with their value domain</td>
057 *     <td>error count</td>
058 *     <td>Integer</td>
059 *     <td></td>
060 *   </tr><tr>
061 *     <td>17</td>
062 *     <td>value domain conformance rate</td>
063 *     <td>correct items rate</td>
064 *     <td>Real</td>
065 *     <td></td>
066 *   </tr><tr>
067 *     <td>18</td>
068 *     <td>value domain non-conformance rate</td>
069 *     <td>error rate</td>
070 *     <td>Real</td>
071 *     <td></td>
072 *   </tr>
073 * </table>
074 *
075 * <p>{@linkplain Measure#getDefinition() Definitions}:</p>
076 * <ol start="14">
077 *   <li>Indication of if an item is not in conformance with its value domain.</li>
078 *   <li>Indication that an item is conforming to its value domain.</li>
079 *   <li>Count of all items in the data set that are not in conformance with their value domain.</li>
080 *   <li>Number of items in the data set that are in conformance with their value domain
081 *       in relation to the total number of items in the data set.</li>
082 *   <li>Number of items in the data set that are not in conformance with their value domain
083 *       in relation to the total number of items in the data set.</li>
084 * </ol>
085 *
086 * @author  Martin Desruisseaux (IRD)
087 * @author  Alexis Gaillard (Geomatys)
088 * @version 3.1
089 * @since   2.0
090 */
091@UML(identifier="DQ_DomainConsistency", specification=ISO_19157)
092public interface DomainConsistency extends LogicalConsistency {
093}