Class DefaultConformanceResult

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

    public class DefaultConformanceResult
    extends AbstractResult
    implements ConformanceResult
    Information about the outcome of evaluating the obtained value (or set of values) against a specified acceptable conformance quality level. The following properties are mandatory in a well-formed metadata according ISO 19115:
    DQ_Conformance­Result   ├─specification…………… Citation of product specification or user requirement against which data is being evaluated.   │   ├─title……………………… Name by which the cited resource is known.   │   └─date………………………… Reference date for the cited resource.   ├─explanation………………… Explanation of the meaning of conformance for this result.   └─pass…………………………………… Indication of the conformance result.

    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

      • DefaultConformanceResult

        public DefaultConformanceResult()
        Constructs an initially empty conformance result.
      • DefaultConformanceResult

        public DefaultConformanceResult​(Citation specification,
                                        CharSequence explanation,
                                        boolean pass)
        Creates a conformance result initialized to the given values.
        Parameters:
        specification - specification or requirement against which data is being evaluated, or null.
        explanation - the meaning of conformance for this result, or null.
        pass - indication of the conformance result, or null.
      • DefaultConformanceResult

        public DefaultConformanceResult​(ConformanceResult 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(Conformance­Result)
    • Method Detail

      • castOrCopy

        public static DefaultConformanceResult castOrCopy​(ConformanceResult 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­Conformance­Result, then it is returned unchanged.
        • Otherwise a new Default­Conformance­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.
      • getSpecification

        public Citation getSpecification()
        Returns the citation of product specification or user requirement against which data is being evaluated.
        Specified by:
        get­Specification in interface Conformance­Result
        Returns:
        citation of product specification or user requirement, or null.
      • setSpecification

        public void setSpecification​(Citation newValue)
        Sets the citation of product specification or user requirement against which data is being evaluated.
        Parameters:
        new­Value - the new specification.
      • setExplanation

        public void setExplanation​(InternationalString newValue)
        Sets the explanation of the meaning of conformance for this result.
        Parameters:
        new­Value - the new explanation.
      • pass

        public Boolean pass()
        Returns an indication of the conformance result.
        Specified by:
        pass in interface Conformance­Result
        Returns:
        indication of the conformance result, or null.
      • setPass

        public void setPass​(Boolean newValue)
        Sets the indication of the conformance result.
        Parameters:
        new­Value - true if the test pass.