Package org.apache.sis.metadata.iso.quality

Class AbstractElement

Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractElement
All Implemented Interfaces:
Serializable, Emptiable, Lenient­Comparable, Identified­Object, Element
Direct Known Subclasses:
Abstract­Completeness, Abstract­Logical­Consistency, Abstract­Positional­Accuracy, Abstract­Temporal­Accuracy, Abstract­Thematic­Accuracy, Default­Usability
public class AbstractElement extends ISOMetadata implements Element
Type of test applied to the data specified by a data quality scope. The following property is mandatory in a well-formed metadata according ISO 19115:
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
See Also:

Defined in the sis-metadata module

  • Constructor Details

    • AbstractElement

      public AbstractElement()
      Constructs an initially empty element.

    • AbstractElement

      public AbstractElement(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(Element object)
      Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since 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(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 Positional­Accuracy, Temporal­Accuracy, Thematic­Accuracy, Logical­Consistency, Completeness or Usability, then this method delegates to the cast­Or­Copy(…) method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then the cast­Or­Copy(…) method to be used is unspecified.
      • Otherwise if the given object is already an instance of Abstract­Element, then it is returned unchanged.
      • Otherwise a new Abstract­Element instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since 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.

    • getNamesOfMeasure

      public Collection<InternationalString> getNamesOfMeasure()
      Returns the name of the test applied to the data.
      Specified by:
      get­Names­Of­Measure in interface Element
      Returns:
      name of the test applied to the data.
      See Also:

    • setNamesOfMeasure

      public void setNamesOfMeasure(Collection<? extends InternationalString> newValues)
      Sets the name of the test applied to the data.
      Parameters:
      new­Values - the new name of measures.

    • getMeasureIdentification

      public Identifier getMeasureIdentification()
      Returns the code identifying a registered standard procedure, or null if none.
      Specified by:
      get­Measure­Identification in interface Element
      Returns:
      code identifying a registered standard procedure, or null.
      See Also:

    • setMeasureIdentification

      public void setMeasureIdentification(Identifier newValue)
      Sets the code identifying a registered standard procedure.
      Parameters:
      new­Value - the new measure identification.

    • getMeasureDescription

      public InternationalString getMeasureDescription()
      Returns the description of the measure being determined.
      Specified by:
      get­Measure­Description in interface Element
      Returns:
      description of the measure being determined, or null.
      See Also:

    • setMeasureDescription

      public void setMeasureDescription(InternationalString newValue)
      Sets the description of the measure being determined.
      Parameters:
      new­Value - the new measure description.

    • getEvaluationMethodType

      public EvaluationMethodType getEvaluationMethodType()
      Returns the type of method used to evaluate quality of the dataset.
      Specified by:
      get­Evaluation­Method­Type in interface Element
      Returns:
      type of method used to evaluate quality, or null.
      See Also:

    • setEvaluationMethodType

      public void setEvaluationMethodType(EvaluationMethodType newValue)
      Sets the type of method used to evaluate quality of the dataset.
      Parameters:
      new­Value - the new evaluation method type.

    • getEvaluationMethodDescription

      public InternationalString getEvaluationMethodDescription()
      Returns the description of the evaluation method.
      Specified by:
      get­Evaluation­Method­Description in interface Element
      Returns:
      description of the evaluation method, or null.
      See Also:

    • setEvaluationMethodDescription

      public void setEvaluationMethodDescription(InternationalString newValue)
      Sets the description of the evaluation method.
      Parameters:
      new­Value - the new evaluation method description.

    • getEvaluationProcedure

      public Citation getEvaluationProcedure()
      Returns the reference to the procedure information, or null if none.
      Specified by:
      get­Evaluation­Procedure in interface Element
      Returns:
      reference to the procedure information, or null.
      See Also:

    • setEvaluationProcedure

      public void setEvaluationProcedure(Citation newValue)
      Sets the reference to the procedure information.
      Parameters:
      new­Value - the new evaluation procedure.

    • getDates

      public Collection<Date> getDates()
      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:
      get­Dates in interface Element
      Returns:
      date or range of dates on which a data quality measure was applied.

    • setDates

      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:
      new­Values - the new dates, or null.

    • getResults

      public Collection<Result> getResults()
      Returns the value (or set of values) obtained from applying a data quality measure or the out come of evaluating the obtained value (or set of values) against a specified acceptable conformance quality level.
      Specified by:
      get­Results in interface Element
      Returns:
      set of values obtained from applying a data quality measure.

    • setResults

      public void setResults(Collection<? extends Result> newValues)
      Sets the value (or set of values) obtained from applying a data quality measure or the out come of evaluating the obtained value (or set of values) against a specified acceptable conformance quality level.
      Parameters:
      new­Values - the new results.