blob: 60e616ff018235bd91be8cff5caac160e977eac0 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Information about data quality, accuracy and consistency of a dataset.
* An explanation for this package is provided in the {@linkplain org.opengis.metadata.quality OpenGIS® javadoc}.
* The remaining discussion on this page is specific to the SIS implementation.
*
* <h2>Overview</h2>
* For a global overview of metadata in SIS, see the {@link org.apache.sis.metadata} package javadoc.
*
* <table class="sis">
* <caption>Package overview</caption>
* <tr>
* <th>Class hierarchy</th>
* <th class="sep">Aggregation hierarchy</th>
* </tr><tr><td style="width: 50%; white-space: nowrap">
* {@linkplain org.apache.sis.metadata.iso.ISOMetadata ISO 19115 metadata}<br>
* {@code  ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultDataQuality Data quality}<br>
* {@code  ├─} {@linkplain org.apache.sis.metadata.iso.quality.AbstractElement Element} «abstract»<br>
* {@code  │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.AbstractCompleteness Completeness} «abstract»<br>
* {@code  │   │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultCompletenessCommission Completeness commission}<br>
* {@code  │   │   └─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultCompletenessOmission Completeness omission}<br>
* {@code  │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.AbstractLogicalConsistency Logical consistency} «abstract»<br>
* {@code  │   │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultConceptualConsistency Conceptual consistency}<br>
* {@code  │   │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultDomainConsistency Domain consistency}<br>
* {@code  │   │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultFormatConsistency Format consistency}<br>
* {@code  │   │   └─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultTopologicalConsistency Topological consistency}<br>
* {@code  │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.AbstractPositionalAccuracy Positional accuracy} «abstract»<br>
* {@code  │   │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultAbsoluteExternalPositionalAccuracy Absolute external positional accuracy}<br>
* {@code  │   │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultRelativeInternalPositionalAccuracy Relative internal positional accuracy}<br>
* {@code  │   │   └─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultGriddedDataPositionalAccuracy Gridded data positional accuracy}<br>
* {@code  │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.AbstractTemporalAccuracy Temporal accuracy} «abstract»<br>
* {@code  │   │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultAccuracyOfATimeMeasurement Accuracy of a time measurement}<br>
* {@code  │   │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultTemporalConsistency Temporal consistency}<br>
* {@code  │   │   └─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultTemporalValidity Temporal validity}<br>
* {@code  │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.AbstractThematicAccuracy Thematic accuracy} «abstract»<br>
* {@code  │   │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultQuantitativeAttributeAccuracy Quantitative attribute accuracy}<br>
* {@code  │   │   ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultNonQuantitativeAttributeAccuracy Non quantitative attribute accuracy}<br>
* {@code  │   │   └─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultThematicClassificationCorrectness Thematic classification correctness}<br>
* {@code  │   └─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultUsability Usability}<br>
* {@code  └─} {@linkplain org.apache.sis.metadata.iso.quality.AbstractResult Result} «abstract»<br>
* {@code      ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultConformanceResult Conformance result}<br>
* {@code      ├─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultQuantitativeResult Quantitative result}<br>
* {@code      └─} {@linkplain org.apache.sis.metadata.iso.quality.DefaultCoverageResult Coverage result}<br>
* {@linkplain org.opengis.util.CodeList Code list}<br>
* {@code  └─} {@linkplain org.opengis.metadata.quality.EvaluationMethodType Evaluation method type}<br>
* </td><td class="sep" style="width: 50%; white-space: nowrap">
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultDataQuality Data quality}<br>
* {@code  ├─} {@linkplain org.apache.sis.metadata.iso.maintenance.DefaultScope Scope}<br>
* {@code  └─} {@linkplain org.apache.sis.metadata.iso.quality.AbstractElement Element} «abstract»<br>
* {@code      ├─} {@linkplain org.opengis.metadata.quality.EvaluationMethodType Evaluation method type} «code list»<br>
* {@code      └─} {@linkplain org.apache.sis.metadata.iso.quality.AbstractResult Result} «abstract»<br>
* {@linkplain org.apache.sis.metadata.iso.quality.AbstractCompleteness Completeness} «abstract»<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultCompletenessCommission Completeness commission}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultCompletenessOmission Completeness omission}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.AbstractLogicalConsistency Logical consistency} «abstract»<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultConceptualConsistency Conceptual consistency}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultDomainConsistency Domain consistency}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultFormatConsistency Format consistency}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultTopologicalConsistency Topological consistency}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.AbstractPositionalAccuracy Positional accuracy} «abstract»<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultAbsoluteExternalPositionalAccuracy Absolute external positional accuracy}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultRelativeInternalPositionalAccuracy Relative internal positional accuracy}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultGriddedDataPositionalAccuracy Gridded data positional accuracy}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.AbstractTemporalAccuracy Temporal accuracy} «abstract»<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultAccuracyOfATimeMeasurement Accuracy of a time measurement}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultTemporalConsistency Temporal consistency}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultTemporalValidity Temporal validity}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.AbstractThematicAccuracy Thematic accuracy} «abstract»<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultQuantitativeAttributeAccuracy Quantitative attribute accuracy}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultNonQuantitativeAttributeAccuracy Non quantitative attribute accuracy}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultThematicClassificationCorrectness Thematic classification correctness}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultUsability Usability}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultConformanceResult Conformance result}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultQuantitativeResult Quantitative result}<br>
* {@linkplain org.apache.sis.metadata.iso.quality.DefaultCoverageResult Coverage result}<br>
* </td></tr></table>
*
* <h2>Null values, nil objects and collections</h2>
* All constructors and setter methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided, and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an empty collection,
* an empty array or {@code null} if the type is neither a collection or an array.
* Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
* <p>Unless the metadata object has been marked as unmodifiable and unless otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding new elements in the collection
* modify directly the underlying metadata object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
* @author Cédric Briançon (Geomatys)
* @author Guilhem Legal (Geomatys)
* @author Cullen Rombach (Image Matters)
* @version 1.0
*
* @see <a href="https://issues.apache.org/jira/browse/SIS-394">SIS-394</a>
*
* @since 0.3
* @module
*/
@XmlSchema(location="http://standards.iso.org/iso/19157/-2/mdq/1.0/mdq.xsd",
elementFormDefault=XmlNsForm.QUALIFIED, namespace=Namespaces.MDQ,
xmlns = {
@XmlNs(prefix = "mdq", namespaceURI = Namespaces.MDQ), // Metadata for Data Quality
@XmlNs(prefix = "mrd", namespaceURI = Namespaces.MRD), // Metadata for Resource Distribution
// @XmlNs(prefix = "dqc", namespaceURI = Namespaces.DQC), // Data Quality Common Classes
@XmlNs(prefix = "mcc", namespaceURI = Namespaces.MCC), // Metadata Common Classes
@XmlNs(prefix = "gmd", namespaceURI = LegacyNamespaces.GMD),
@XmlNs(prefix = "gmi", namespaceURI = LegacyNamespaces.GMI)
})
@XmlAccessorType(XmlAccessType.NONE)
@XmlJavaTypeAdapters({
@XmlJavaTypeAdapter(CI_Citation.class),
@XmlJavaTypeAdapter(DQ_Element.class),
@XmlJavaTypeAdapter(DQ_EvaluationMethodTypeCode.class),
@XmlJavaTypeAdapter(DQ_Result.class),
@XmlJavaTypeAdapter(GO_Boolean.class),
@XmlJavaTypeAdapter(GO_DateTime.class),
@XmlJavaTypeAdapter(GO_Record.class),
@XmlJavaTypeAdapter(GO_RecordType.class),
@XmlJavaTypeAdapter(LI_Lineage.class),
@XmlJavaTypeAdapter(MD_ContentInformation.class),
@XmlJavaTypeAdapter(MD_Format.class),
@XmlJavaTypeAdapter(MD_Identifier.class),
@XmlJavaTypeAdapter(MD_Scope.class),
@XmlJavaTypeAdapter(MD_SpatialRepresentation.class),
@XmlJavaTypeAdapter(MD_SpatialRepresentationTypeCode.class),
@XmlJavaTypeAdapter(MX_DataFile.class),
// Java types, primitive types and basic OGC types handling
@XmlJavaTypeAdapter(UnitAdapter.class),
@XmlJavaTypeAdapter(InternationalStringAdapter.class)
})
package org.apache.sis.metadata.iso.quality;
import javax.xml.bind.annotation.XmlNs;
import javax.xml.bind.annotation.XmlNsForm;
import javax.xml.bind.annotation.XmlSchema;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapters;
import org.apache.sis.xml.Namespaces;
import org.apache.sis.internal.xml.LegacyNamespaces;
import org.apache.sis.internal.jaxb.gco.*;
import org.apache.sis.internal.jaxb.code.*;
import org.apache.sis.internal.jaxb.metadata.*;