org.geotoolkit.metadata.iso.quality
Class DefaultQuantitativeResult

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              AbstractResult
                  DefaultQuantitativeResult

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, QuantitativeResult, Result

@ThreadSafe
public class DefaultQuantitativeResult
extends AbstractResult
implements QuantitativeResult

Information about the value (or set of values) obtained from applying a data quality measure.

Since:

2.1

Version:

3.19

Author:

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

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

DefaultQuantitativeResult()
Constructs an initially empty quantitative result.

DefaultQuantitativeResult(double[] values)
Constructs a quantitative result initialized to the specified value.

DefaultQuantitativeResult(QuantitativeResult source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultQuantitativeResult	castOrCopy(QuantitativeResult object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
InternationalString	getErrorStatistic() Returns the statistical method used to determine the value, or null if none.
List<Record>	getValues() Returns the quantitative value or values, content determined by the evaluation procedure used.
RecordType	getValueType() Return the value type for reporting a data quality result, or null if none.
Unit<?>	getValueUnit() Returns the value unit for reporting a data quality result, or null if none.
void	setErrorStatistic(InternationalString newValue) Sets the statistical method used to determine the value, or null if none.
void	setValues(double[] newValues) Sets the quantitative value or values, content determined by the evaluation procedure used.
void	setValues(List<Record> newValues) Sets the quantitative value or values, content determined by the evaluation procedure used.
void	setValueType(RecordType newValue) Sets the value type for reporting a data quality result, or null if none.
void	setValueUnit(Unit<?> newValue) Sets the value unit for reporting a data quality result, or null if none.

Methods inherited from class AbstractResult

castOrCopy

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

DefaultQuantitativeResult

public DefaultQuantitativeResult()

Constructs an initially empty quantitative result.

DefaultQuantitativeResult

public DefaultQuantitativeResult(QuantitativeResult 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

DefaultQuantitativeResult

public DefaultQuantitativeResult(double[] values)

Constructs a quantitative result initialized to the specified value.

Parameters:

values - The quantitative values.

Method Detail

castOrCopy

public static DefaultQuantitativeResult castOrCopy(QuantitativeResult 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).

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

getValues

public List<Record> getValues()

Returns the quantitative value or values, content determined by the evaluation procedure used.

Specified by:

getValues in interface QuantitativeResult

TODO:

Find an implementation of Record. The one in this class is deprecated.

setValues

public void setValues(List<Record> newValues)

Sets the quantitative value or values, content determined by the evaluation procedure used.

Parameters:

newValues - The new values.

Since:

2.4

setValues

public void setValues(double[] newValues)

Sets the quantitative value or values, content determined by the evaluation procedure used.

Parameters:

newValues - The new values.

getValueType

public RecordType getValueType()

Return the value type for reporting a data quality result, or null if none.

Specified by:

getValueType in interface QuantitativeResult

setValueType

public void setValueType(RecordType newValue)

Sets the value type for reporting a data quality result, or null if none.

Parameters:

newValue - The new value type.

getValueUnit

public Unit<?> getValueUnit()

Returns the value unit for reporting a data quality result, or null if none.

Specified by:

getValueUnit in interface QuantitativeResult

setValueUnit

public void setValueUnit(Unit<?> newValue)

Sets the value unit for reporting a data quality result, or null if none.

Parameters:

newValue - The new value unit.

getErrorStatistic

public InternationalString getErrorStatistic()

Returns the statistical method used to determine the value, or null if none.

Specified by:

getErrorStatistic in interface QuantitativeResult

setErrorStatistic

public void setErrorStatistic(InternationalString newValue)

Sets the statistical method used to determine the value, or null if none.

Parameters:

newValue - The new error statistic.