Class DefaultQualityMeasure
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.quality.ISOMetadata
org.apache.sis.metadata.iso.quality.DefaultQualityMeasure
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
@UML(identifier="DQM_Measure",
specification=UNSPECIFIED)
public class DefaultQualityMeasure
extends ISOMetadata
Data quality measure.
The following properties are mandatory in a well-formed metadata according ISO 19157:
DQM_Measure
├─measureIdentifier……
Value uniquely identifying the measure within a namespace.
├─name………………………………………
Name of the data quality measure applied to the data.
├─elementName……………………
Name of the data quality element for which quality is reported.
├─definition………………………
Definition of the fundamental concept for the data quality measure.
└─valueType…………………………
Value type for reporting a data quality result (shall be one of the data types defined in ISO/19103:2005).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:
- 1.3
- Version:
- 1.3
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Collection
<org.opengis.util.InternationalString> Another recognized name, an abbreviation or a short name for the same data quality measure.private DefaultBasicMeasure
Definition of the fundamental concept for the data quality measure.private org.opengis.util.InternationalString
Definition of the fundamental concept for the data quality measure.private DefaultMeasureDescription
Description of the data quality measure.private Collection
<org.opengis.util.TypeName> Name of the data quality element for which quality is reported.private Collection
<DefaultMeasureDescription> Illustration of the use of a data quality measure.private org.opengis.metadata.Identifier
Value uniquely identifying the measure within a namespace.private org.opengis.util.InternationalString
Name of the data quality measure applied to the data.private Collection
<org.opengis.parameter.ParameterDescriptor<?>> Auxiliary variable used by the data quality measure, including its name, definition and optionally its description.private static final long
Serial number for inter-operability with different versions.private Collection
<DefaultSourceReference> Reference to the source of an item that has been adopted from an external source.private org.opengis.util.TypeName
Value type for reporting a data quality result.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty element.Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionCollection
<org.opengis.util.InternationalString> Returns other recognized names, abbreviations or short names for the same data quality measure.Returns predefined basic measure on which this measure is based.org.opengis.util.InternationalString
Returns the definition of the fundamental concept for the data quality measure.Description of the data quality measure.Collection
<org.opengis.util.TypeName> Returns the names of the data quality element to which a measure applies.Returns illustrations of the use of a data quality measure.org.opengis.metadata.Identifier
Returns the value uniquely identifying the measure within a namespace.org.opengis.util.InternationalString
getName()
Returns the name of the data quality measure applied to the data.Collection
<org.opengis.parameter.ParameterDescriptor<?>> Returns auxiliary variable(s) used by the data quality measure.Returns references to the source of an item that has been adopted from an external source.org.opengis.util.TypeName
Returns the value type for reporting a data quality result.void
setAliases
(Collection<? extends org.opengis.util.InternationalString> newValues) Sets other recognized names or abbreviations for the same data quality measure.void
setBasicMeasure
(DefaultBasicMeasure newValue) Sets the predefined basic measure on which this measure is based.void
setDefinition
(org.opengis.util.InternationalString newValue) Sets the definition of the fundamental concept for the data quality measure.void
setDescription
(DefaultMeasureDescription newValue) Sets the description of the data quality measure.void
setElementNames
(Collection<? extends org.opengis.util.TypeName> newValues) Sets the name of the data quality element for which quality is reported.void
setExamples
(Collection<? extends DefaultMeasureDescription> newValues) Sets the illustrations of the use of a data quality measure.void
setMeasureIdentifier
(org.opengis.metadata.Identifier newValue) Sets the value uniquely identifying the measure within a namespace.void
setName
(org.opengis.util.InternationalString newValue) Sets the name of the data quality measure applied to the data.void
setParameters
(Collection<? extends org.opengis.parameter.ParameterDescriptor<?>> newValues) Sets the auxiliary variable used by the data quality measure.void
setSourceReferences
(Collection<? extends DefaultSourceReference> newValues) Sets the reference to the source of an item that has been adopted from an external source.void
setValueType
(org.opengis.util.TypeName newValue) Sets the value type for reporting a data quality result.Methods inherited from class org.apache.sis.metadata.iso.quality.ISOMetadata
getStandard
Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
measureIdentifier
private org.opengis.metadata.Identifier measureIdentifierValue uniquely identifying the measure within a namespace. -
name
private org.opengis.util.InternationalString nameName of the data quality measure applied to the data. -
aliases
Another recognized name, an abbreviation or a short name for the same data quality measure. -
elementNames
Name of the data quality element for which quality is reported. -
basicMeasure
Definition of the fundamental concept for the data quality measure. -
definition
private org.opengis.util.InternationalString definitionDefinition of the fundamental concept for the data quality measure. -
description
Description of the data quality measure. Includes methods of calculation, with all formulae and/or illustrations needed to establish the result of applying the measure. -
sourceReferences
Reference to the source of an item that has been adopted from an external source. -
valueType
private org.opengis.util.TypeName valueTypeValue type for reporting a data quality result. -
parameters
Auxiliary variable used by the data quality measure, including its name, definition and optionally its description. -
examples
Illustration of the use of a data quality measure.
-
-
Constructor Details
-
DefaultQualityMeasure
public DefaultQualityMeasure()Constructs an initially empty element. -
DefaultQualityMeasure
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, ornull
if none.
-
-
Method Details
-
getMeasureIdentifier
@UML(identifier="measureIdentifier", obligation=MANDATORY, specification=UNSPECIFIED) public org.opengis.metadata.Identifier getMeasureIdentifier()Returns the value uniquely identifying the measure within a namespace.- Returns:
- value uniquely identifying the measure within a namespace.
-
setMeasureIdentifier
public void setMeasureIdentifier(org.opengis.metadata.Identifier newValue) Sets the value uniquely identifying the measure within a namespace.- Parameters:
newValue
- the new measure identification.
-
getName
@UML(identifier="name", obligation=MANDATORY, specification=UNSPECIFIED) public org.opengis.util.InternationalString getName()Returns the name of the data quality measure applied to the data.- Returns:
- name of the data quality measure applied to the data.
-
setName
public void setName(org.opengis.util.InternationalString newValue) Sets the name of the data quality measure applied to the data.- Parameters:
newValue
- the new quality measure name.
-
getAliases
@UML(identifier="alias", obligation=OPTIONAL, specification=UNSPECIFIED) public Collection<org.opengis.util.InternationalString> getAliases()Returns other recognized names, abbreviations or short names for the same data quality measure. It may be a different commonly used name, or an abbreviation, or a short name.- Returns:
- others recognized names, abbreviations or short names.
-
setAliases
Sets other recognized names or abbreviations for the same data quality measure.- Parameters:
newValues
- the new measure aliases.
-
getElementNames
@UML(identifier="elementName", obligation=MANDATORY, specification=UNSPECIFIED) public Collection<org.opengis.util.TypeName> getElementNames()Returns the names of the data quality element to which a measure applies.- Returns:
- names of the data quality element for which quality is reported.
-
setElementNames
Sets the name of the data quality element for which quality is reported.- Parameters:
newValues
- the new measure element names.
-
getBasicMeasure
@UML(identifier="basicMeasure", obligation=CONDITIONAL, specification=UNSPECIFIED) public DefaultBasicMeasure getBasicMeasure()Returns predefined basic measure on which this measure is based.- Returns:
- predefined basic measure on which this measure is based, or
null
if none.
-
setBasicMeasure
Sets the predefined basic measure on which this measure is based.- Parameters:
newValue
- the new basic measure.
-
getDefinition
@UML(identifier="definition", obligation=MANDATORY, specification=UNSPECIFIED) public org.opengis.util.InternationalString getDefinition()Returns the definition of the fundamental concept for the data quality measure. If the measure is derived from a basic measure, the definition is based on the basic measure definition and specialized for this measure.- Returns:
- definition of the fundamental concept for the data quality measure.
-
setDefinition
public void setDefinition(org.opengis.util.InternationalString newValue) Sets the definition of the fundamental concept for the data quality measure.- Parameters:
newValue
- the new measure definition.
-
getDescription
@UML(identifier="description", obligation=CONDITIONAL, specification=UNSPECIFIED) public DefaultMeasureDescription getDescription()Description of the data quality measure. Includes methods of calculation, with all formulae and/or illustrations needed to establish the result of applying the measure.- Returns:
- description of data quality measure, or
null
if none.
-
setDescription
Sets the description of the data quality measure.- Parameters:
newValue
- the new measure description.
-
getSourceReferences
@UML(identifier="sourceReference", obligation=CONDITIONAL, specification=UNSPECIFIED) public Collection<DefaultSourceReference> getSourceReferences()Returns references to the source of an item that has been adopted from an external source.- Returns:
- references to the source.
-
setSourceReferences
Sets the reference to the source of an item that has been adopted from an external source.- Parameters:
newValues
- the new source references.
-
getValueType
@UML(identifier="valueType", obligation=MANDATORY, specification=UNSPECIFIED) public org.opengis.util.TypeName getValueType()Returns the value type for reporting a data quality result.- Returns:
- value type for reporting a data quality result.
-
setValueType
public void setValueType(org.opengis.util.TypeName newValue) Sets the value type for reporting a data quality result.- Parameters:
newValue
- the new measure value type.
-
getParameters
@UML(identifier="parameter", obligation=CONDITIONAL, specification=UNSPECIFIED) public Collection<org.opengis.parameter.ParameterDescriptor<?>> getParameters()Returns auxiliary variable(s) used by the data quality measure. It shall include its name, definition and value type.Unified parameter API
In GeoAPI, theDQM_Parameter
type defined by ISO 19157 is replaced byParameterDescriptor
in order to provide a single parameter API. Seeinvalid reference
org.opengis.parameter
- Returns:
- auxiliary variable(s) used by data quality measure.
-
setParameters
public void setParameters(Collection<? extends org.opengis.parameter.ParameterDescriptor<?>> newValues) Sets the auxiliary variable used by the data quality measure.- Parameters:
newValues
- the new measure parameters.
-
getExamples
@UML(identifier="example", obligation=OPTIONAL, specification=UNSPECIFIED) public Collection<DefaultMeasureDescription> getExamples()Returns illustrations of the use of a data quality measure.- Returns:
- examples of applying the measure or the result obtained for the measure.
-
setExamples
Sets the illustrations of the use of a data quality measure.- Parameters:
newValues
- the new examples.
-