Module org.apache.sis.metadata
Class DefaultConformanceResult
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractResult
DefaultConformanceResult
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,ConformanceResult,Result
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
XMLinstead.
- Since:
- 0.3
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty conformance result.DefaultConformanceResult(Citation specification, CharSequence explanation, boolean pass) Creates a conformance result initialized to the given values.Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultConformanceResultcastOrCopy(ConformanceResult object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the explanation of the meaning of conformance for this result.Returns the citation of product specification or user requirement against which data is being evaluated.Returns the metadata standard, which is ISO 19157.pass()Returns an indication of the conformance result.voidsetExplanation(InternationalString newValue) Sets the explanation of the meaning of conformance for this result.voidSets the indication of the conformance result.voidsetSpecification(Citation newValue) Sets the citation of product specification or user requirement against which data is being evaluated.Methods inherited from class AbstractResult
castOrCopy, getDateTime, getResultScope, setDateTime, setResultScopeMethods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, setIdentifier, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Constructor Details
-
DefaultConformanceResult
public DefaultConformanceResult()Constructs an initially empty conformance result. -
DefaultConformanceResult
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
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, ornullif none.- See Also:
-
-
Method Details
-
castOrCopy
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
DefaultConformanceResultinstance 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, ornullif none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
nullif the argument was null.
- If the given object is
-
getSpecification
Returns the citation of product specification or user requirement against which data is being evaluated.- Specified by:
getSpecificationin interfaceConformanceResult- Returns:
- citation of product specification or user requirement, or
null.
-
setSpecification
Sets the citation of product specification or user requirement against which data is being evaluated.- Parameters:
newValue- the new specification.
-
getExplanation
Returns the explanation of the meaning of conformance for this result.- Specified by:
getExplanationin interfaceConformanceResult- Returns:
- explanation of the meaning of conformance, or
null.
-
setExplanation
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:
passin interfaceConformanceResult- Returns:
- indication of the conformance result, or
null.
-
setPass
Sets the indication of the conformance result.- Parameters:
newValue-trueif the test pass.
-
getStandard
Returns the metadata standard, which is ISO 19157.- Overrides:
getStandardin classISOMetadata- Returns:
- the metadata standard, which is ISO 19157.
-