Class DefaultConformanceResult
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.DefaultConformanceResult
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.quality.ConformanceResult
,org.opengis.metadata.quality.Result
public class DefaultConformanceResult
extends AbstractResult
implements org.opengis.metadata.quality.ConformanceResult
Information about the outcome of evaluating the value(s) against a specified acceptable conformance quality level.
See the
ConformanceResult
GeoAPI interface for more details.
The following properties are mandatory in a well-formed metadata according ISO 19157:
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.
└─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
- Version:
- 1.0
- 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
Explanation of the meaning of conformance for this result.private Boolean
Indication of the conformance result.private static final long
Serial number for compatibility with different versions.private org.opengis.metadata.citation.Citation
Citation of product specification or user requirement against which data is being evaluated.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty conformance result.DefaultConformanceResult
(org.opengis.metadata.citation.Citation specification, CharSequence explanation, boolean pass) Creates a conformance result initialized to the given values.DefaultConformanceResult
(org.opengis.metadata.quality.ConformanceResult object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultConformanceResult
castOrCopy
(org.opengis.metadata.quality.ConformanceResult object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.util.InternationalString
Returns the explanation of the meaning of conformance for this result.org.opengis.metadata.citation.Citation
Returns the citation of product specification or user requirement against which data is being evaluated.pass()
Returns an indication of the conformance result.void
setExplanation
(org.opengis.util.InternationalString newValue) Sets the explanation of the meaning of conformance for this result.void
Sets the indication of the conformance result.void
setSpecification
(org.opengis.metadata.citation.Citation newValue) Sets the citation of product specification or user requirement against which data is being evaluated.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, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for compatibility with different versions.- See Also:
-
specification
private org.opengis.metadata.citation.Citation specificationCitation of product specification or user requirement against which data is being evaluated. -
explanation
private org.opengis.util.InternationalString explanationExplanation of the meaning of conformance for this result. -
pass
Indication of the conformance result.The field is directly annotated here, because the getter method is called
pass()
, and JAXB does not recognize it. The method should have been called getPass() or isPass().
-
-
Constructor Details
-
DefaultConformanceResult
public DefaultConformanceResult()Constructs an initially empty conformance result. -
DefaultConformanceResult
public DefaultConformanceResult(org.opengis.metadata.citation.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(org.opengis.metadata.quality.ConformanceResult 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 DefaultConformanceResult castOrCopy(org.opengis.metadata.quality.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, 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
-
getSpecification
public org.opengis.metadata.citation.Citation getSpecification()Returns the citation of product specification or user requirement against which data is being evaluated.- Specified by:
getSpecification
in interfaceorg.opengis.metadata.quality.ConformanceResult
- Returns:
- citation of product specification or user requirement, or
null
.
-
setSpecification
public void setSpecification(org.opengis.metadata.citation.Citation newValue) Sets the citation of product specification or user requirement against which data is being evaluated.- Parameters:
newValue
- the new specification.
-
getExplanation
public org.opengis.util.InternationalString getExplanation()Returns the explanation of the meaning of conformance for this result.- Specified by:
getExplanation
in interfaceorg.opengis.metadata.quality.ConformanceResult
- Returns:
- explanation of the meaning of conformance, or
null
.
-
setExplanation
public void setExplanation(org.opengis.util.InternationalString newValue) Sets the explanation of the meaning of conformance for this result.- Parameters:
newValue
- the new explanation.
-
pass
Returns an indication of the conformance result.- Specified by:
pass
in interfaceorg.opengis.metadata.quality.ConformanceResult
- Returns:
- indication of the conformance result, or
null
.
-
setPass
Sets the indication of the conformance result.- Parameters:
newValue
-true
if the test pass.
-