Class AbstractElement

All Implemented Interfaces:
Serializable, Emptiable, LenientComparable, IdentifiedObject, org.opengis.metadata.quality.Element
Direct Known Subclasses:
AbstractCompleteness, AbstractLogicalConsistency, AbstractMetaquality, AbstractPositionalAccuracy, AbstractTemporalQuality, AbstractThematicAccuracy, DefaultUsability

public class AbstractElement extends ISOMetadata implements org.opengis.metadata.quality.Element
Aspect of quantitative quality information. See the Element GeoAPI interface for more details. The following property is mandatory in a well-formed metadata according ISO 19157:
DQ_Element   └─result…………… Value obtained from applying a data quality measure.

Limitations

  • Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
  • Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.
Since:
0.3
Version:
1.3
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serial number for inter-operability with different versions.
      See Also:
    • standaloneQualityReportDetails

      private org.opengis.util.InternationalString standaloneQualityReportDetails
      Clause in the standalone quality report where this data quality element is described.
    • measureReference

      private DefaultMeasureReference measureReference
      Reference to measure used.
    • evaluationMethod

      private DefaultEvaluationMethod evaluationMethod
      Evaluation information.
    • results

      private Collection<org.opengis.metadata.quality.Result> results
      Value (or set of values) obtained from applying a data quality measure.
    • derivedElements

      private Collection<org.opengis.metadata.quality.Element> derivedElements
      In case of aggregation or derivation, indicates the original element.
  • Constructor Details

    • AbstractElement

      public AbstractElement()
      Constructs an initially empty element.
    • AbstractElement

      public AbstractElement(org.opengis.metadata.quality.Result result)
      Creates an element initialized to the given result.
      Parameters:
      result - the value obtained from applying a data quality measure against a specified acceptable conformance quality level.
    • AbstractElement

      public AbstractElement(org.opengis.metadata.quality.Element object)
      Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the metadata to copy values from, or null if none.
      See Also:
  • Method Details

    • castOrCopy

      public static AbstractElement castOrCopy(org.opengis.metadata.quality.Element object)
      Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:
      • If the given object is null, then this method returns null.
      • Otherwise if the given object is an instance of PositionalAccuracy, ThematicAccuracy, LogicalConsistency or Completeness, then this method delegates to the castOrCopy(…) method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then the castOrCopy(…) method to be used is unspecified.
      • Otherwise if the given object is already an instance of AbstractElement, then it is returned unchanged.
      • Otherwise a new AbstractElement instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the object to get as a SIS implementation, or null if none.
      Returns:
      a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.
    • getStandaloneQualityReportDetails

      @UML(identifier="standaloneQualityReportDetails", obligation=OPTIONAL, specification=UNSPECIFIED) public org.opengis.util.InternationalString getStandaloneQualityReportDetails()
      Returns the 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:
      1.3
    • setStandaloneQualityReportDetails

      public void setStandaloneQualityReportDetails(org.opengis.util.InternationalString newValue)
      Sets the clause in the standalone quality report where this data quality element is described.
      Parameters:
      newValue - the clause in the standalone quality report.
      Since:
      1.3
    • getMeasureReference

      @UML(identifier="measure", obligation=OPTIONAL, specification=UNSPECIFIED) public DefaultMeasureReference getMeasureReference()
      Returns an identifier of a measure fully described elsewhere.
      Returns:
      reference to the measure used, or null if none.
      Since:
      1.3
    • setMeasureReference

      public void setMeasureReference(DefaultMeasureReference newValues)
      Sets an identifier of a measure fully described elsewhere.
      Parameters:
      newValues - the new measure identifier.
      Since:
      1.3
    • getMeasureReferenceProperty

      private <V> V getMeasureReferenceProperty(Function<DefaultMeasureReference,V> getter)
      Returns the value of a measureReference property. This is used only for deprecated setter methods from older ISO 19115 version.
      See Also:
    • setMeasureReferenceProperty

      private <V> void setMeasureReferenceProperty(BiConsumer<DefaultMeasureReference,V> setter, V newValue)
      Sets the value of a measureReference property. This is used only for deprecated setter methods from older ISO 19115 version.
      See Also:
    • getNamesOfMeasure

      @Deprecated public Collection<org.opengis.util.InternationalString> getNamesOfMeasure()
      Returns the name of the test applied to the data.
      Specified by:
      getNamesOfMeasure in interface org.opengis.metadata.quality.Element
      Returns:
      name of the test applied to the data.
    • setNamesOfMeasure

      @Deprecated public void setNamesOfMeasure(Collection<? extends org.opengis.util.InternationalString> newValues)
      Sets the name of the test applied to the data.
      Parameters:
      newValues - the new name of measures.
    • getMeasureIdentification

      @Deprecated public org.opengis.metadata.Identifier getMeasureIdentification()
      Returns the code identifying a registered standard procedure, or null if none.
      Specified by:
      getMeasureIdentification in interface org.opengis.metadata.quality.Element
      Returns:
      code identifying a registered standard procedure, or null.
    • setMeasureIdentification

      @Deprecated public void setMeasureIdentification(org.opengis.metadata.Identifier newValue)
      Sets the code identifying a registered standard procedure.
      Parameters:
      newValue - the new measure identification.
    • getMeasureDescription

      @Deprecated public org.opengis.util.InternationalString getMeasureDescription()
      Returns the description of the measure being determined.
      Specified by:
      getMeasureDescription in interface org.opengis.metadata.quality.Element
      Returns:
      description of the measure being determined, or null.
    • setMeasureDescription

      @Deprecated public void setMeasureDescription(org.opengis.util.InternationalString newValue)
      Sets the description of the measure being determined.
      Parameters:
      newValue - the new measure description.
    • getEvaluationMethod

      @UML(identifier="evaluationMethod", obligation=OPTIONAL, specification=UNSPECIFIED) public DefaultEvaluationMethod getEvaluationMethod()
      Returns the evaluation information.
      Returns:
      information about the evaluation method, or null if none.
      Since:
      1.3
    • setEvaluationMethod

      public void setEvaluationMethod(DefaultEvaluationMethod newValue)
      Sets the evaluation information.
      Parameters:
      newValue - the new evaluation information.
      Since:
      1.3
    • getEvaluationMethodProperty

      private <V> V getEvaluationMethodProperty(Function<DefaultEvaluationMethod,V> getter)
      Returns the value of a evaluationMethod property. This is used only for deprecated setter methods from older ISO 19115 version.
      See Also:
    • setEvaluationMethodProperty

      private <V> void setEvaluationMethodProperty(BiConsumer<DefaultEvaluationMethod,V> setter, V newValue)
      Sets the value of a evaluationMethod property. This is used only for deprecated setter methods from older ISO 19115 version.
      See Also:
    • getEvaluationMethodType

      @Deprecated public org.opengis.metadata.quality.EvaluationMethodType getEvaluationMethodType()
      Returns the type of method used to evaluate quality of the dataset.
      Specified by:
      getEvaluationMethodType in interface org.opengis.metadata.quality.Element
      Returns:
      type of method used to evaluate quality, or null.
    • setEvaluationMethodType

      @Deprecated public void setEvaluationMethodType(org.opengis.metadata.quality.EvaluationMethodType newValue)
      Sets the type of method used to evaluate quality of the dataset.
      Parameters:
      newValue - the new evaluation method type.
    • getEvaluationMethodDescription

      @Deprecated public org.opengis.util.InternationalString getEvaluationMethodDescription()
      Returns the description of the evaluation method.
      Specified by:
      getEvaluationMethodDescription in interface org.opengis.metadata.quality.Element
      Returns:
      description of the evaluation method, or null.
    • setEvaluationMethodDescription

      @Deprecated public void setEvaluationMethodDescription(org.opengis.util.InternationalString newValue)
      Sets the description of the evaluation method.
      Parameters:
      newValue - the new evaluation method description.
    • getEvaluationProcedure

      @Deprecated public org.opengis.metadata.citation.Citation getEvaluationProcedure()
      Returns the reference to the procedure information, or null if none.
      Specified by:
      getEvaluationProcedure in interface org.opengis.metadata.quality.Element
      Returns:
      reference to the procedure information, or null.
    • setEvaluationProcedure

      @Deprecated public void setEvaluationProcedure(org.opengis.metadata.citation.Citation newValue)
      Sets the reference to the procedure information.
      Parameters:
      newValue - the new evaluation procedure.
    • getDates

      @Deprecated public Collection<Date> getDates()
      Deprecated.
      Returns the 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.
      Specified by:
      getDates in interface org.opengis.metadata.quality.Element
      Returns:
      date or range of dates on which a data quality measure was applied.
    • setDates

      @Deprecated public void setDates(Collection<? extends Date> newValues)
      Sets the 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.
      Parameters:
      newValues - the new dates, or null.
    • getResults

      public Collection<org.opengis.metadata.quality.Result> getResults()
      Returns the value(s) 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.
      Specified by:
      getResults in interface org.opengis.metadata.quality.Element
      Returns:
      set of values obtained from applying a data quality measure.
    • setResults

      public void setResults(Collection<? extends org.opengis.metadata.quality.Result> newValues)
      Sets the value(s) obtained from applying a data quality measure.
      Parameters:
      newValues - the new set of value.
    • getDerivedElements

      @UML(identifier="derivedElement", obligation=OPTIONAL, specification=UNSPECIFIED) public Collection<org.opengis.metadata.quality.Element> getDerivedElements()
      Returns the original elements in case of aggregation or derivation.
      Returns:
      original element(s) when there is an aggregation or derivation.
      Since:
      1.3
    • setDerivedElements

      public void setDerivedElements(Collection<? extends org.opengis.metadata.quality.Element> newValues)
      Sets the original elements in case of aggregation or derivation.
      Parameters:
      newValues - the new elements.
      Since:
      1.3
    • getDerivedElement

      private Collection<org.opengis.metadata.quality.Element> getDerivedElement()
      Invoked by JAXB at both marshalling and unmarshalling time. This attribute has been added by ISO 19157:2013 standard. If (and only if) marshalling an older standard version, we omit this attribute.