Class DefaultQuantitativeResult
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractResult
DefaultQuantitativeResult
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,QuantitativeResult,Result
Information about the value (or set of values) obtained from applying a data quality measure.
See the
QuantitativeResult GeoAPI interface for more details.
The following properties are mandatory in a well-formed metadata according ISO 19157:
DQ_QuantitativeResult
├─valueUnit…………………… Value unit for reporting a data quality result.
└─value……………………………… Quantitative value or values, content determined by the evaluation procedure used.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 Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty quantitative result.Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultQuantitativeResultcastOrCopy(QuantitativeResult object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Deprecated.Removed from ISO_19157:2013.Returns the metadata standard, which is ISO 19157.Returns the quantitative value or values, content determined by the evaluation procedure used.Returns the value type for reporting a data quality result.Unit<?>Returns the value unit for reporting a data quality result.voidsetErrorStatistic(InternationalString newValue) Deprecated.Removed from ISO_19157:2013.voidsetValues(List<? extends Record> newValues) Sets the quantitative value or values, content determined by the evaluation procedure used.voidsetValueType(RecordType newValue) Sets the value type for reporting a data quality result.voidsetValueUnit(Unit<?> newValue) Sets the value unit for reporting a data quality result.Methods inherited from class AbstractResult
castOrCopy, getDateTime, getResultScope, setDateTime, setResultScopeMethods 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, prune, toString
-
Constructor Details
-
DefaultQuantitativeResult
public DefaultQuantitativeResult()Constructs an initially empty quantitative result. -
DefaultQuantitativeResult
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.- See Also:
-
-
Method Details
-
castOrCopy
Returns 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 already an instance of
DefaultQuantitativeResult, then it is returned unchanged. - Otherwise a new
DefaultQuantitativeResultinstance 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, ornullif 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
-
getValues
Returns the quantitative value or values, content determined by the evaluation procedure used.- Specified by:
getValuesin interfaceQuantitativeResult- Returns:
- Quantitative value or values.
-
setValues
Sets the quantitative value or values, content determined by the evaluation procedure used.- Parameters:
newValues- the new values.
-
getValueType
Returns the value type for reporting a data quality result.Default value
If no type has been set but all values are of the same type, then this method defaults to that type. Otherwise this method returnsnull.- Specified by:
getValueTypein interfaceQuantitativeResult- Returns:
- value type for reporting a data quality result, or
null.
-
setValueType
Sets the value type for reporting a data quality result. Anullvalue restores the default value documented ingetValueType().- Parameters:
newValue- the new value type.
-
getValueUnit
Returns the value unit for reporting a data quality result.- Specified by:
getValueUnitin interfaceQuantitativeResult- Returns:
- value unit for reporting a data quality result, or
null.
-
setValueUnit
Sets the value unit for reporting a data quality result.- Parameters:
newValue- the new value unit.
-
getErrorStatistic
Deprecated.Removed from ISO_19157:2013.Returns the statistical method used to determine the value.- Specified by:
getErrorStatisticin interfaceQuantitativeResult- Returns:
- statistical method used to determine the value, or
null.
-
setErrorStatistic
Deprecated.Removed from ISO_19157:2013.Sets the statistical method used to determine the value, ornullif none.- Parameters:
newValue- the new error statistic.
-
getStandard
Returns the metadata standard, which is ISO 19157.- Overrides:
getStandardin classISOMetadata- Returns:
- the metadata standard, which is ISO 19157.
-