Class DefaultConformanceResult
- Object
-
- AbstractMetadata
-
- ModifiableMetadata
-
- ISOMetadata
-
- AbstractResult
-
- DefaultConformanceResult
-
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,ConformanceResult
,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_ConformanceResult
├─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
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State
-
-
Field Summary
-
Fields inherited from class ISOMetadata
identifiers
-
-
Constructor Summary
Constructors Constructor Description DefaultConformanceResult()
Constructs an initially empty conformance result.DefaultConformanceResult(Citation specification, CharSequence explanation, boolean pass)
Creates a conformance result initialized to the given values.DefaultConformanceResult(ConformanceResult object)
Constructs a new instance initialized with the values from the specified metadata object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DefaultConformanceResult
castOrCopy(ConformanceResult object)
Returns a SIS metadata implementation with the values of the given arbitrary implementation.InternationalString
getExplanation()
Returns the explanation of the meaning of conformance for this result.Citation
getSpecification()
Returns the citation of product specification or user requirement against which data is being evaluated.Boolean
pass()
Returns an indication of the conformance result.void
setExplanation(InternationalString newValue)
Sets the explanation of the meaning of conformance for this result.void
setPass(Boolean newValue)
Sets the indication of the conformance result.void
setSpecification(Citation newValue)
Sets the citation of product specification or user requirement against which data is being evaluated.-
Methods inherited from class AbstractResult
castOrCopy
-
Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
-
Methods inherited from class ModifiableMetadata
checkWritePermission, checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, unmodifiable, writeCollection, writeList, writeMap, writeSet
-
Methods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
-
-
-
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, ornull
.explanation
- the meaning of conformance for this result, ornull
.pass
- indication of the conformance result, ornull
.
-
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, ornull
if none.- See Also:
castOrCopy(ConformanceResult)
-
-
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 returnsnull
. - Otherwise if the given object is already an instance of
DefaultConformanceResult
, then it is returned unchanged. - Otherwise a new
DefaultConformanceResult
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, 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
-
getSpecification
public Citation getSpecification()
Returns the citation of product specification or user requirement against which data is being evaluated.- Specified by:
getSpecification
in interfaceConformanceResult
- 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:
newValue
- the new specification.
-
getExplanation
public InternationalString getExplanation()
Returns the explanation of the meaning of conformance for this result.- Specified by:
getExplanation
in interfaceConformanceResult
- Returns:
- explanation of the meaning of conformance, or
null
.
-
setExplanation
public void setExplanation(InternationalString newValue)
Sets the explanation of the meaning of conformance for this result.- Parameters:
newValue
- the new explanation.
-
pass
public Boolean pass()
Returns an indication of the conformance result.- Specified by:
pass
in interfaceConformanceResult
- Returns:
- indication of the conformance result, or
null
.
-
setPass
public void setPass(Boolean newValue)
Sets the indication of the conformance result.- Parameters:
newValue
-true
if the test pass.
-
-