org.geotoolkit.metadata.iso.quality
Class AbstractElement

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              AbstractElement

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Element

Direct Known Subclasses:

AbstractCompleteness, AbstractLogicalConsistency, AbstractPositionalAccuracy, AbstractTemporalAccuracy, AbstractThematicAccuracy, DefaultUsability

@ThreadSafe
public class AbstractElement
extends MetadataEntity
implements Element

Type of test applied to the data specified by a data quality scope.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Guilhem Legal (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

AbstractElement()
Constructs an initially empty element.

AbstractElement(Element source)
Constructs a metadata entity initialized with the values from the specified metadata.

AbstractElement(Result result)
Creates an element initialized to the given result.

Method Summary

static AbstractElement	castOrCopy(Element object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Collection<Date>	getDates() Returns the date or range of dates on which a data quality measure was applied.
InternationalString	getEvaluationMethodDescription() Returns the description of the evaluation method.
EvaluationMethodType	getEvaluationMethodType() Returns the type of method used to evaluate quality of the dataset, or null if unspecified.
Citation	getEvaluationProcedure() Returns the reference to the procedure information, or null if none.
InternationalString	getMeasureDescription() Returns the description of the measure being determined.
Identifier	getMeasureIdentification() Returns the code identifying a registered standard procedure, or null if none.
Collection<InternationalString>	getNamesOfMeasure() Returns the name of the test applied to the data.
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.
void	setDates(Collection<Date> newValues) Sets the date or range of dates on which a data quality measure was applied.
void	setEvaluationMethodDescription(InternationalString newValue) Sets the description of the evaluation method.
void	setEvaluationMethodType(EvaluationMethodType newValue) Sets the ype of method used to evaluate quality of the dataset.
void	setEvaluationProcedure(Citation newValue) Sets the reference to the procedure information.
void	setMeasureDescription(InternationalString newValue) Sets the description of the measure being determined.
void	setMeasureIdentification(Identifier newValue) Sets the code identifying a registered standard procedure.
void	setNamesOfMeasure(Collection<? extends InternationalString> newValues) Sets the name of the test applied to the data.
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.

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractElement

public AbstractElement()

Constructs an initially empty element.

AbstractElement

public AbstractElement(Element source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Since:

2.4

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.

Method Detail

castOrCopy

public static AbstractElement castOrCopy(Element object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

This method checks for the PositionalAccuracy, TemporalAccuracy, ThematicAccuracy, LogicalConsistency, Completeness and Usability sub-interfaces. If one of those interfaces is found, then this method delegates to the corresponding castOrCopy static method. If the given object implements more than one of the above-cited interfaces, then the castOrCopy method to be used is unspecified.

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getNamesOfMeasure

public Collection<InternationalString> getNamesOfMeasure()

Returns the name of the test applied to the data.

Specified by:

getNamesOfMeasure in interface Element

setNamesOfMeasure

public void setNamesOfMeasure(Collection<? extends InternationalString> newValues)

Sets the name of the test applied to the data.

Parameters:

newValues - The new name of measures.

getMeasureIdentification

public Identifier getMeasureIdentification()

Returns the code identifying a registered standard procedure, or null if none.

Specified by:

getMeasureIdentification in interface Element

setMeasureIdentification

public void setMeasureIdentification(Identifier newValue)

Sets the code identifying a registered standard procedure.

Parameters:

newValue - The new measure identification.

getMeasureDescription

public InternationalString getMeasureDescription()

Returns the description of the measure being determined.

Specified by:

getMeasureDescription in interface Element

setMeasureDescription

public void setMeasureDescription(InternationalString newValue)

Sets the description of the measure being determined.

Parameters:

newValue - The new measure description.

getEvaluationMethodType

public EvaluationMethodType getEvaluationMethodType()

Returns the type of method used to evaluate quality of the dataset, or null if unspecified.

Specified by:

getEvaluationMethodType in interface Element

setEvaluationMethodType

public void setEvaluationMethodType(EvaluationMethodType newValue)

Sets the ype of method used to evaluate quality of the dataset.

Parameters:

newValue - The new evaluation method type.

getEvaluationMethodDescription

public InternationalString getEvaluationMethodDescription()

Returns the description of the evaluation method.

Specified by:

getEvaluationMethodDescription in interface Element

setEvaluationMethodDescription

public void setEvaluationMethodDescription(InternationalString newValue)

Sets the description of the evaluation method.

Parameters:

newValue - The new evaluation method description.

getEvaluationProcedure

public Citation getEvaluationProcedure()

Returns the reference to the procedure information, or null if none.

Specified by:

getEvaluationProcedure in interface Element

setEvaluationProcedure

public void setEvaluationProcedure(Citation newValue)

Sets the reference to the procedure information.

Parameters:

newValue - 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 array length is 1 for a single date, or 2 for a range. Returns an empty list if this information is not available.

Specified by:

getDates in interface Element

Since:

2.4

setDates

public void setDates(Collection<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.

Since:

2.4

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:

getResults in interface Element

Since:

2.4

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:

newValues - The new results.

Since:

2.4