Class DefaultQuantitativeResult
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.AbstractResult
org.apache.sis.metadata.iso.quality.DefaultQuantitativeResult
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.quality.QuantitativeResult
,org.opengis.metadata.quality.Result
public class DefaultQuantitativeResult
extends AbstractResult
implements org.opengis.metadata.quality.QuantitativeResult
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
XML
instead.
- Since:
- 0.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 org.opengis.util.InternationalString
Deprecated.Removed from ISO 19157:2013.private static final long
Serial number for compatibility with different versions.private List
<org.opengis.util.Record> Quantitative value or values, content determined by the evaluation procedure used.private org.opengis.util.RecordType
Value type for reporting a data quality result, ornull
if none.private javax.measure.Unit
<?> Value unit for reporting a data quality result, ornull
if none.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty quantitative result.DefaultQuantitativeResult
(org.opengis.metadata.quality.QuantitativeResult object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultQuantitativeResult
castOrCopy
(org.opengis.metadata.quality.QuantitativeResult object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.util.InternationalString
Deprecated.Removed from ISO_19157:2013.List
<org.opengis.util.Record> Returns the quantitative value or values, content determined by the evaluation procedure used.org.opengis.util.RecordType
Returns the value type for reporting a data quality result.javax.measure.Unit
<?> Returns the value unit for reporting a data quality result.void
setErrorStatistic
(org.opengis.util.InternationalString newValue) Deprecated.Removed from ISO_19157:2013.void
Sets the quantitative value or values, content determined by the evaluation procedure used.void
setValueType
(org.opengis.util.RecordType newValue) Sets the value type for reporting a data quality result.void
setValueUnit
(javax.measure.Unit<?> newValue) Sets the value unit for reporting a data quality result.Methods inherited from class org.apache.sis.metadata.iso.quality.AbstractResult
castOrCopy, getDateTime, getResultScope, setDateTime, setResultScope
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, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for compatibility with different versions.- See Also:
-
values
Quantitative value or values, content determined by the evaluation procedure used. -
valueType
private org.opengis.util.RecordType valueTypeValue type for reporting a data quality result, ornull
if none. -
valueUnit
private javax.measure.Unit<?> valueUnitValue unit for reporting a data quality result, ornull
if none. -
errorStatistic
Deprecated.Removed from ISO 19157:2013.Statistical method used to determine the value, ornull
if none.
-
-
Constructor Details
-
DefaultQuantitativeResult
public DefaultQuantitativeResult()Constructs an initially empty quantitative result. -
DefaultQuantitativeResult
public DefaultQuantitativeResult(org.opengis.metadata.quality.QuantitativeResult object) 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.- See Also:
-
-
Method Details
-
castOrCopy
public static DefaultQuantitativeResult castOrCopy(org.opengis.metadata.quality.QuantitativeResult object) 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
DefaultQuantitativeResult
instance 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, ornull
if none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
null
if 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:
getValues
in interfaceorg.opengis.metadata.quality.QuantitativeResult
- 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
public org.opengis.util.RecordType 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:
getValueType
in interfaceorg.opengis.metadata.quality.QuantitativeResult
- Returns:
- value type for reporting a data quality result, or
null
.
-
setValueType
public void setValueType(org.opengis.util.RecordType newValue) Sets the value type for reporting a data quality result. Anull
value restores the default value documented ingetValueType()
.- Parameters:
newValue
- the new value type.
-
getValueUnit
public javax.measure.Unit<?> getValueUnit()Returns the value unit for reporting a data quality result.- Specified by:
getValueUnit
in interfaceorg.opengis.metadata.quality.QuantitativeResult
- Returns:
- value unit for reporting a data quality result, or
null
.
-
setValueUnit
public void setValueUnit(javax.measure.Unit<?> newValue) 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:
getErrorStatistic
in interfaceorg.opengis.metadata.quality.QuantitativeResult
- 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, ornull
if none.- Parameters:
newValue
- the new error statistic.
-