Class DefaultQuantitativeResult

  • All Implemented Interfaces:
    Serializable, Emptiable, Lenient­Comparable, Identified­Object, Quantitative­Result, Result

    public class DefaultQuantitativeResult
    extends AbstractResult
    implements QuantitativeResult
    Information about the value (or set of values) obtained from applying a data quality measure. The following properties are mandatory in a well-formed metadata according ISO 19115:
    DQ_Quantitative­Result   ├─value­Unit…………………… 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
    See Also:
    Serialized Form

    Defined in the sis-metadata module

    • Constructor Detail

      • DefaultQuantitativeResult

        public DefaultQuantitativeResult()
        Constructs an initially empty quantitative result.
      • DefaultQuantitativeResult

        public DefaultQuantitativeResult​(QuantitativeResult object)
        Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since the other metadata contained in the given object are not recursively copied.
        Parameters:
        object - the metadata to copy values from, or null if none.
        See Also:
        cast­Or­Copy(Quantitative­Result)
    • Method Detail

      • castOrCopy

        public static DefaultQuantitativeResult castOrCopy​(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 returns null.
        • Otherwise if the given object is already an instance of Default­Quantitative­Result, then it is returned unchanged.
        • Otherwise a new Default­Quantitative­Result instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since the other metadata contained in the given object are not recursively copied.
        Parameters:
        object - the object to get as a SIS implementation, or null 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.
      • getValues

        public List<Record> getValues()
        Returns the quantitative value or values, content determined by the evaluation procedure used.
        Specified by:
        get­Values in interface Quantitative­Result
        Returns:
        Quantitative value or values.
      • setValues

        public void setValues​(List<? extends Record> newValues)
        Sets the quantitative value or values, content determined by the evaluation procedure used.
        Parameters:
        new­Values - the new values.
      • getValueType

        public RecordType getValueType()
        Return 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 returns null.
        Specified by:
        get­Value­Type in interface Quantitative­Result
        Returns:
        value type for reporting a data quality result, or null.
      • setValueType

        public void setValueType​(RecordType newValue)
        Sets the value type for reporting a data quality result. A null value restores the default value documented in get­Value­Type().
        Parameters:
        new­Value - the new value type.
      • getValueUnit

        public Unit<?> getValueUnit()
        Returns the value unit for reporting a data quality result.
        Specified by:
        get­Value­Unit in interface Quantitative­Result
        Returns:
        value unit for reporting a data quality result, or null.
      • setValueUnit

        public void setValueUnit​(Unit<?> newValue)
        Sets the value unit for reporting a data quality result.
        Parameters:
        new­Value - the new value unit.
      • setErrorStatistic

        public void setErrorStatistic​(InternationalString newValue)
        Sets the statistical method used to determine the value, or null if none.
        Parameters:
        new­Value - the new error statistic.