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 to rules of the conceptual schema.
027 *
028 * <div class="note"><b>Example:</b>
029 * Invalid placement of an airport inside a lake.</div>
030 *
031 * <h2>Standardized values</h2>
032 * In order to achieve well defined and comparable quality information, it is recommended to
033 * report data quality using {@linkplain Measure quality measures} listed in ISO 19157 annex.
034 * The following table provides a summary; see ISO 19157 for more complete descriptions and examples.
035 * All identifiers should be in "ISO 19157" namespace.
036 *
037 * <table class="ogc">
038 *   <caption>Standardized values derived from ISO 19157</caption>
039 *   <tr>
040 *     <th>{@linkplain MeasureReference#getMeasureIdentification() Identifier}</th>
041 *     <th>{@linkplain MeasureReference#getNamesOfMeasure() Name of measure}</th>
042 *     <th>{@linkplain Measure#getAliases() Aliases}</th>
043 *     <th>{@linkplain Measure#getBasicMeasure() Basic measure}</th>
044 *     <th>{@linkplain Measure#getValueType() Value type}</th>
045 *     <th>Remarks</th>
046 *   </tr><tr>
047 *     <td>8</td>
048 *     <td>conceptual schema non-compliance</td>
049 *     <td></td>
050 *     <td>error indicator</td>
051 *     <td>Boolean</td>
052 *     <td>{@code true} indicates that an item is not compliant</td>
053 *   </tr><tr>
054 *     <td>9</td>
055 *     <td>conceptual schema non-compliance</td>
056 *     <td></td>
057 *     <td>correctness indicator</td>
058 *     <td>Integer</td>
059 *     <td>{@code true} indicates that an item is in compliance</td>
060 *   </tr><tr>
061 *     <td>10</td>
062 *     <td>number of items not compliant with the rules of the conceptual schema</td>
063 *     <td></td>
064 *     <td>error count</td>
065 *     <td>Integer</td>
066 *     <td></td>
067 *   </tr><tr>
068 *     <td>11</td>
069 *     <td>number of invalid overlaps of surfaces</td>
070 *     <td>overlapping surfaces</td>
071 *     <td>error count</td>
072 *     <td>Integer</td>
073 *     <td></td>
074 *   </tr><tr>
075 *     <td>12</td>
076 *     <td>non-compliance rate with respect to the rules of the conceptual schema</td>
077 *     <td></td>
078 *     <td>error rate</td>
079 *     <td>Real</td>
080 *     <td></td>
081 *   </tr><tr>
082 *     <td>13</td>
083 *     <td>compliance rate with the rules of the conceptual schema</td>
084 *     <td></td>
085 *     <td>correct items rate</td>
086 *     <td>Real</td>
087 *     <td></td>
088 *   </tr>
089 * </table>
090 *
091 * <p>{@linkplain Measure#getDefinition() Definitions}:</p>
092 * <ol start="8">
093 *   <li>Indication that an item is not compliant to the rules of the relevant conceptual schema.</li>
094 *   <li>Indication that an item complies with the rules of the relevant conceptual.</li>
095 *   <li>Count of all items in the data set that are not compliant with the rules of the conceptual schema.</li>
096 *   <li>Total number of erroneous overlaps within the data.</li>
097 *   <li>Number of items in the data set that are not compliant with the rules of the conceptual schema
098 *       in relation to the total number of these items supposed to be in the data set.</li>
099 *   <li>Number of items in the data set in compliance with the rules of the conceptual schema
100 *       in relation to the total number of items.</li>
101 * </ol>
102 *
103 * @author  Martin Desruisseaux (IRD)
104 * @author  Alexis Gaillard (Geomatys)
105 * @version 3.1
106 * @since   2.0
107 */
108@UML(identifier="DQ_ConceptualConsistency", specification=ISO_19157)
109public interface ConceptualConsistency extends LogicalConsistency {
110}