Module org.opengis.geoapi

Package org.opengis.metadata.quality

Interface Element

All Known Subinterfaces:

AbsoluteExternalPositionalAccuracy, AccuracyOfATimeMeasurement, Completeness, CompletenessCommission, CompletenessOmission, ConceptualConsistency, Confidence, DomainConsistency, FormatConsistency, GriddedDataPositionalAccuracy, Homogeneity, LogicalConsistency, Metaquality, NonQuantitativeAttributeAccuracy, NonQuantitativeAttributeCorrectness, PositionalAccuracy, QuantitativeAttributeAccuracy, RelativeInternalPositionalAccuracy, Representativity, TemporalAccuracy, TemporalConsistency, TemporalQuality, TemporalValidity, ThematicAccuracy, ThematicClassificationCorrectness, TopologicalConsistency, Usability

@Classifier(ABSTRACT)
@UML(identifier="DQ_Element",
     specification=ISO_19157)
public interface Element

Aspect of quantitative quality information. A data quality element is a component describing a certain aspect of the quality of geographic data. An evaluation of a data quality element is described by the following:

• Measure: the type of evaluation;
• Evaluation method: the procedure used to evaluate the measure;
• Result: the output of the evaluation.

Elements are organized into different categories, which are identified by the following subtypes: Completeness, LogicalConsistency, PositionalAccuracy, TemporalQuality, ThematicAccuracy, or Metaquality.

Since:

2.0

TODO:

Renamed in 19157:2022: QualityElement.

Method Summary

Modifier and Type	Method	Description
default Collection<? extends Date>	getDates()	Deprecated. Replaced by EvaluationMethod.getDates().
default Collection<? extends Element>	getDerivedElements()	In case of aggregation or derivation, indicates the original elements.
default EvaluationMethod	getEvaluationMethod()	Evaluation information.
default InternationalString	getEvaluationMethodDescription()	Deprecated. Replaced by EvaluationMethod.getEvaluationMethodDescription().
default EvaluationMethodType	getEvaluationMethodType()	Deprecated. Replaced by EvaluationMethod.getEvaluationMethodType().
default Citation	getEvaluationProcedure()	Deprecated. Replaced by EvaluationMethod.getEvaluationProcedure().
default Measure	getMeasure()	Full description of a data quality measure.
default InternationalString	getMeasureDescription()	Deprecated. Replaced by MeasureReference.getMeasureDescription().
default Identifier	getMeasureIdentification()	Deprecated. Replaced by MeasureReference.getMeasureIdentification().
default MeasureReference	getMeasureReference()	Identifier of a measure fully described elsewhere.
default Collection<? extends InternationalString>	getNamesOfMeasure()	Deprecated. Replaced by MeasureReference.getNamesOfMeasure().
Collection<? extends Result>	getResults()	Value (or set of values) obtained from applying a data quality measure.
default InternationalString	getStandaloneQualityReportDetails()	Clause in the standalone quality report where this data quality element is described.

Method Details

getStandaloneQualityReportDetails

@UML(identifier="standaloneQualityReportDetails",
     obligation=OPTIONAL,
     specification=ISO_19157)
default InternationalString getStandaloneQualityReportDetails()

Clause in the standalone quality report where this data quality element is described. May apply to any related data quality element (original results in case of derivation or aggregation).

Returns:

clause where this data quality element is described, or null if none.

Since:

3.1

TODO:

Renamed in 19157:2022: QualityEvaluationReportDetails.

getMeasure

default Measure getMeasure()

Full description of a data quality measure.

Returns:

a measure of data quality, or null if none.

Since:

3.1

Convenience extension to OGC/ISO standard

This method is not part of ISO 19157 specification. Instead, the standard provides only a MeasureReference that clients can use for finding the full measure description in a measure register or catalogue. Because Java interfaces can execute code (as opposed to static data encoded in XML or JSON documents), implementers are free to do themselves the work of fetching this information from an external source when getMeasure() is invoked. This method is added in the Element interface for making that feature possible. This is an optional feature; implementers can ignore this method and implement only the #getMeasureReference() method.

getMeasureReference

@UML(identifier="measure",
     obligation=OPTIONAL,
     specification=ISO_19157)
default MeasureReference getMeasureReference()

Identifier of a measure fully described elsewhere. The full description is given by getMeasure(), but that description may not be available to this Element. Instead, the whole description may be found within a measure register or catalogue, in which case this reference can be used for finding the whole description.

If a full measure is contained in this element, then by default this method returns the name, identifier and definition of that measure.

Returns:

reference to the measure used, or null if none.

Since:

3.1

Departure from OGC/ISO standard in the name

The ISO 19157 property name is measure. This is renamed measureReference in GeoAPI for reflecting the return type and for making room for a measure property for the full Measure description.

getNamesOfMeasure

@Deprecated(since="3.1")
@UML(identifier="nameOfMeasure",
     obligation=OPTIONAL,
     specification=ISO_19115,
     version=2003)
default Collection<? extends InternationalString> getNamesOfMeasure()

Deprecated.

Replaced by MeasureReference.getNamesOfMeasure().

Name of the test applied to the data.

Returns:

name of the test applied to the data.

getMeasureIdentification

@Deprecated(since="3.1")
@UML(identifier="measureIdentification",
     obligation=OPTIONAL,
     specification=ISO_19115,
     version=2003)
default Identifier getMeasureIdentification()

Deprecated.

Replaced by MeasureReference.getMeasureIdentification().

Code identifying a registered standard procedure, or null if none.

Returns:

code identifying a registered standard procedure, or null.

getMeasureDescription

@Deprecated(since="3.1")
@UML(identifier="measureDescription",
     obligation=OPTIONAL,
     specification=ISO_19115,
     version=2003)
default InternationalString getMeasureDescription()

Deprecated.

Replaced by MeasureReference.getMeasureDescription().

Description of the measure being determined.

Returns:

description of the measure being determined, or null.

getEvaluationMethod

@UML(identifier="evaluationMethod",
     obligation=OPTIONAL,
     specification=ISO_19157)
default EvaluationMethod getEvaluationMethod()

Evaluation information.

Returns:

information about the evaluation method, or null if none.

Since:

3.1

getEvaluationMethodType

@Deprecated(since="3.1")
@UML(identifier="evaluationMethodType",
     obligation=OPTIONAL,
     specification=ISO_19115,
     version=2003)
default EvaluationMethodType getEvaluationMethodType()

Deprecated.

Replaced by EvaluationMethod.getEvaluationMethodType().

Type of method used to evaluate quality of the dataset.

Returns:

type of method used to evaluate quality, or null.

getEvaluationMethodDescription

@Deprecated(since="3.1")
@UML(identifier="evaluationMethodDescription",
     obligation=OPTIONAL,
     specification=ISO_19115,
     version=2003)
default InternationalString getEvaluationMethodDescription()

Deprecated.

Replaced by EvaluationMethod.getEvaluationMethodDescription().

Description of the evaluation method.

Returns:

description of the evaluation method, or null.

getEvaluationProcedure

@Deprecated(since="3.1")
@UML(identifier="evaluationProcedure",
     obligation=OPTIONAL,
     specification=ISO_19115,
     version=2003)
default Citation getEvaluationProcedure()

Deprecated.

Replaced by EvaluationMethod.getEvaluationProcedure().

Reference to the procedure information, or null if none.

Returns:

reference to the procedure information, or null.

getDates

@Deprecated(since="3.1")
@UML(identifier="dateTime",
     obligation=OPTIONAL,
     specification=ISO_19115,
     version=2003)
default Collection<? extends Date> getDates()

Deprecated.

Replaced by EvaluationMethod.getDates().

Date or range of dates on which a data quality measure was applied. The collection size is 1 for a single date, or 2 for a range. Returns an empty collection if this information is not available.

The default implementation returns a wrapper around @link EvaluationMethod#getDates()} collection. Calls to Iterator.next() may throw DateTimeException if the temporal object cannot be converted to a date.

Returns:

date or range of dates on which a data quality measure was applied.

getResults

@UML(identifier="result",
     obligation=MANDATORY,
     specification=ISO_19157)
Collection<? extends Result> getResults()

Value (or set of values) obtained from applying a data quality measure. May be an outcome of evaluating the obtained value (or set of values) against a specified acceptable conformance quality level.

Returns:

set of values obtained from applying a data quality measure.

getDerivedElements

@UML(identifier="derivedElement",
     obligation=OPTIONAL,
     specification=ISO_19157)
default Collection<? extends Element> getDerivedElements()

In case of aggregation or derivation, indicates the original elements.

Returns:

original element(s) when there is an aggregation or derivation.

Since:

3.1