Module org.apache.sis.metadata
Class DefaultQualityMeasure
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
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
XMLinstead.
- Since:
- 1.3
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class 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 TypeMethodDescriptionReturns other recognized names, abbreviations or short names for the same data quality measure.Returns predefined basic measure on which this measure is based.Returns the definition of the fundamental concept for the data quality measure.Description of the data quality measure.Returns the names of the data quality element to which a measure applies.Returns illustrations of the use of a data quality measure.Returns the value uniquely identifying the measure within a namespace.getName()Returns the name of the data quality measure applied to the data.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.Returns the metadata standard, which is ISO 19157.Returns the value type for reporting a data quality result.voidsetAliases(Collection<? extends InternationalString> newValues) Sets other recognized names or abbreviations for the same data quality measure.voidsetBasicMeasure(DefaultBasicMeasure newValue) Sets the predefined basic measure on which this measure is based.voidsetDefinition(InternationalString newValue) Sets the definition of the fundamental concept for the data quality measure.voidsetDescription(DefaultMeasureDescription newValue) Sets the description of the data quality measure.voidsetElementNames(Collection<? extends TypeName> newValues) Sets the name of the data quality element for which quality is reported.voidsetExamples(Collection<? extends DefaultMeasureDescription> newValues) Sets the illustrations of the use of a data quality measure.voidsetMeasureIdentifier(Identifier newValue) Sets the value uniquely identifying the measure within a namespace.voidsetName(InternationalString newValue) Sets the name of the data quality measure applied to the data.voidsetParameters(Collection<? extends ParameterDescriptor<?>> newValues) Sets the auxiliary variable used by the data quality measure.voidsetSourceReferences(Collection<? extends DefaultSourceReference> newValues) Sets the reference to the source of an item that has been adopted from an external source.voidsetValueType(TypeName newValue) Sets the value type for reporting a data quality result.Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, setIdentifier, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
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, ornullif none.
-
-
Method Details
-
getMeasureIdentifier
@UML(identifier="measureIdentifier", obligation=MANDATORY, specification=UNSPECIFIED) public Identifier getMeasureIdentifier()Returns the value uniquely identifying the measure within a namespace.- Returns:
- value uniquely identifying the measure within a namespace.
-
setMeasureIdentifier
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 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
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<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<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
nullif 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 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
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
nullif 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 TypeName getValueType()Returns the value type for reporting a data quality result.- Returns:
- value type for reporting a data quality result.
-
setValueType
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<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_Parametertype defined by ISO 19157 is replaced byParameterDescriptorin order to provide a single parameter API. Seeorg.opengis.parameterfor more information.- Returns:
- auxiliary variable(s) used by data quality measure.
-
setParameters
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.
-
getStandard
Returns the metadata standard, which is ISO 19157.- Overrides:
getStandardin classISOMetadata- Returns:
- the metadata standard, which is ISO 19157.
-