Class AbstractElement
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractElement
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- Element
- Direct Known Subclasses:
- AbstractCompleteness,- AbstractLogicalConsistency,- AbstractMetaquality,- AbstractPositionalAccuracy,- AbstractTemporalQuality,- AbstractThematicAccuracy,- DefaultUsability
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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty element.AbstractElement(Element object) Constructs a new instance initialized with the values from the specified metadata object.AbstractElement(Result result) Creates an element initialized to the given result.
- 
Method SummaryModifier and TypeMethodDescriptionstatic AbstractElementcastOrCopy(Element object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Deprecated.Returns the original elements in case of aggregation or derivation.Returns the evaluation information.Deprecated.Deprecated.Deprecated.Deprecated.Replaced byDefaultMeasureReference.getMeasureDescription().Deprecated.Returns an identifier of a measure fully described elsewhere.Deprecated.Replaced byDefaultMeasureReference.getNamesOfMeasure().Returns the value(s) obtained from applying a data quality measure.Returns the clause in the standalone quality report where this data quality element is described.Returns the metadata standard, which is ISO 19157.voidsetDates(Collection<? extends Date> newValues) Deprecated.Replaced byDefaultEvaluationMethod.setDates(Collection).voidsetDerivedElements(Collection<? extends Element> newValues) Sets the original elements in case of aggregation or derivation.voidsetEvaluationMethod(DefaultEvaluationMethod newValue) Sets the evaluation information.voidDeprecated.voidsetEvaluationMethodType(EvaluationMethodType newValue) Deprecated.voidsetEvaluationProcedure(Citation newValue) Deprecated.voidsetMeasureDescription(InternationalString newValue) Deprecated.voidsetMeasureIdentification(Identifier newValue) Deprecated.voidsetMeasureReference(DefaultMeasureReference newValues) Sets an identifier of a measure fully described elsewhere.voidsetNamesOfMeasure(Collection<? extends InternationalString> newValues) Deprecated.voidsetResults(Collection<? extends Result> newValues) Sets the value(s) obtained from applying a data quality measure.voidSets the clause in the standalone quality report where this data quality element is described.Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
AbstractElementpublic AbstractElement()Constructs an initially empty element.
- 
AbstractElementCreates 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.
 
- 
AbstractElementConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 returnsnull.
- Otherwise if the given object is an instance of PositionalAccuracy,ThematicAccuracy,LogicalConsistencyorCompleteness, then this method delegates to thecastOrCopy(…)method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then thecastOrCopy(…)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 AbstractElementinstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getStandaloneQualityReportDetails@UML(identifier="standaloneQualityReportDetails", obligation=OPTIONAL, specification=UNSPECIFIED) public 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 nullif none.
- Since:
- 1.3
 
- 
setStandaloneQualityReportDetailsSets 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 nullif none.
- Since:
- 1.3
 
- 
setMeasureReferenceSets an identifier of a measure fully described elsewhere.- Parameters:
- newValues- the new measure identifier.
- Since:
- 1.3
 
- 
getNamesOfMeasureDeprecated.Replaced byDefaultMeasureReference.getNamesOfMeasure().Returns the name of the test applied to the data.- Specified by:
- getNamesOfMeasurein interface- Element
- Returns:
- name of the test applied to the data.
 
- 
setNamesOfMeasureDeprecated.Sets the name of the test applied to the data.- Parameters:
- newValues- the new name of measures.
 
- 
getMeasureIdentificationDeprecated.Returns the code identifying a registered standard procedure, ornullif none.- Specified by:
- getMeasureIdentificationin interface- Element
- Returns:
- code identifying a registered standard procedure, or null.
 
- 
setMeasureIdentificationDeprecated.Sets the code identifying a registered standard procedure.- Parameters:
- newValue- the new measure identification.
 
- 
getMeasureDescriptionDeprecated.Replaced byDefaultMeasureReference.getMeasureDescription().Returns the description of the measure being determined.- Specified by:
- getMeasureDescriptionin interface- Element
- Returns:
- description of the measure being determined, or null.
 
- 
setMeasureDescriptionDeprecated.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 nullif none.
- Since:
- 1.3
 
- 
setEvaluationMethodSets the evaluation information.- Parameters:
- newValue- the new evaluation information.
- Since:
- 1.3
 
- 
getEvaluationMethodTypeDeprecated.Returns the type of method used to evaluate quality of the dataset.- Specified by:
- getEvaluationMethodTypein interface- Element
- Returns:
- type of method used to evaluate quality, or null.
 
- 
setEvaluationMethodTypeDeprecated.Sets the type of method used to evaluate quality of the dataset.- Parameters:
- newValue- the new evaluation method type.
 
- 
getEvaluationMethodDescriptionDeprecated.Returns the description of the evaluation method.- Specified by:
- getEvaluationMethodDescriptionin interface- Element
- Returns:
- description of the evaluation method, or null.
 
- 
setEvaluationMethodDescriptionDeprecated.Sets the description of the evaluation method.- Parameters:
- newValue- the new evaluation method description.
 
- 
getEvaluationProcedureDeprecated.Returns the reference to the procedure information, ornullif none.- Specified by:
- getEvaluationProcedurein interface- Element
- Returns:
- reference to the procedure information, or null.
 
- 
setEvaluationProcedureDeprecated.Sets the reference to the procedure information.- Parameters:
- newValue- the new evaluation procedure.
 
- 
getDatesDeprecated.Replaced byDefaultEvaluationMethod.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.
- 
setDatesDeprecated.Replaced byDefaultEvaluationMethod.setDates(Collection).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.
 
- 
getResultsReturns 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:
- getResultsin interface- Element
- Returns:
- set of values obtained from applying a data quality measure.
 
- 
setResultsSets 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<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
 
- 
setDerivedElementsSets the original elements in case of aggregation or derivation.- Parameters:
- newValues- the new elements.
- Since:
- 1.3
 
- 
getStandardReturns the metadata standard, which is ISO 19157.- Overrides:
- getStandardin class- ISOMetadata
- Returns:
- the metadata standard, which is ISO 19157.
 
 
- 
DefaultEvaluationMethod.getDates().