Class AbstractResult
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
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.quality.Result
- Direct Known Subclasses:
DefaultConformanceResult
,DefaultCoverageResult
,DefaultDescriptiveResult
,DefaultQuantitativeResult
Base class of more specific result classes.
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.3
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Temporal
Date when the result was generated, ornull
if none.private org.opengis.metadata.quality.Scope
Scope of the result.private static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty result.AbstractResult
(org.opengis.metadata.quality.Result object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic AbstractResult
castOrCopy
(org.opengis.metadata.quality.Result object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the date when the result was generated.org.opengis.metadata.quality.Scope
Returns the scope of the result.void
setDateTime
(Temporal newValue) Sets the date when the result was generated.void
setResultScope
(org.opengis.metadata.quality.Scope newValue) Sets the scope of the result.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 inter-operability with different versions.- See Also:
-
resultScope
private org.opengis.metadata.quality.Scope resultScopeScope of the result. -
dateTime
Date when the result was generated, ornull
if none.
-
-
Constructor Details
-
AbstractResult
public AbstractResult()Constructs an initially empty result. -
AbstractResult
public AbstractResult(org.opengis.metadata.quality.Result 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
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 an instance of
ConformanceResult
,QuantitativeResult
orCoverageResult
, then this method delegates to thecastOrCopy(…)
method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then thecastOrCopy(…)
method to be used is unspecified. - Otherwise if the given object is already an instance of
AbstractResult
, then it is returned unchanged. - Otherwise a new
AbstractResult
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
-
getResultScope
@UML(identifier="resultScope", obligation=OPTIONAL, specification=UNSPECIFIED) public org.opengis.metadata.quality.Scope getResultScope()Returns the scope of the result.- Returns:
- scope of the result, or
null
if unspecified. - Since:
- 1.3
-
setResultScope
public void setResultScope(org.opengis.metadata.quality.Scope newValue) Sets the scope of the result.- Parameters:
newValue
- the new evaluation procedure.- Since:
- 1.3
-
getDateTime
@UML(identifier="dateTime", obligation=OPTIONAL, specification=UNSPECIFIED) public Temporal getDateTime()Returns the date when the result was generated. This is typically aLocalDate
,LocalDateTime
orZonedDateTime
depending on whether the hour of the day and the time zone are provided.- Returns:
- date of the result, or
null
if none. - Since:
- 1.3
-
setDateTime
Sets the date when the result was generated.- Parameters:
newValue
- the new date, ornull
.- Since:
- 1.3
-