Module org.apache.sis.metadata
Class DefaultCoverageResult
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractResult
DefaultCoverageResult
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,CoverageResult,Result
Result of a data quality measure organising the measured values as a coverage.
The following properties are mandatory or conditional in a well-formed metadata according ISO 19157:
DQ_CoverageResult
├─spatialRepresentationType…………………… Method used to spatially represent the coverage result.
├─resultSpatialRepresentation……………… Digital representation of data quality measures composing the coverage result.
├─resultContent…………………………………………………… Description of the content of the result coverage, i.e. semantic definition of the data quality measures.
├─resultFormat……………………………………………………… Information about the format of the result coverage data.
│ └─formatSpecificationCitation…… Citation/URL of the specification format.
│ ├─title…………………………………………………… Name by which the cited resource is known.
│ └─date……………………………………………………… Reference date for the cited resource.
└─resultFile…………………………………………………………… Information about the data file containing the result coverage data.
└─fileFormat………………………………………………… Defines the format of the transfer data file.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 coverage result.Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultCoverageResultcastOrCopy(CoverageResult object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Provides the description of the content of the result coverage.Deprecated.Returns the information about the data file containing the result coverage data.Returns the information about the format of the result coverage data.Returns the digital representation of data quality measures composing the coverage result.Returns the method used to spatially represent the coverage result.Returns the metadata standard, which is ISO 19157.voidsetResultContent(Collection<RangeDimension> newValues) Sets the description of the content of the result coverage.voidDeprecated.Replaced bysetResultContent(Collection).voidsetResultFile(DataFile newValue) Sets the information about the data file containing the result coverage data.voidsetResultFormat(Format newValue) Sets the information about the format of the result coverage data.voidSets the digital representation of data quality measures composing the coverage result.voidSets the method used to spatially represent the coverage result.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
-
DefaultCoverageResult
public DefaultCoverageResult()Constructs an initially empty coverage result. -
DefaultCoverageResult
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
DefaultCoverageResult, then it is returned unchanged. - Otherwise a new
DefaultCoverageResultinstance 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
-
getSpatialRepresentationType
Returns the method used to spatially represent the coverage result.- Specified by:
getSpatialRepresentationTypein interfaceCoverageResult- Returns:
- spatial representation of the coverage result.
-
setSpatialRepresentationType
Sets the method used to spatially represent the coverage result.- Parameters:
newValue- the new spatial representation type value.
-
getResultSpatialRepresentation
Returns the digital representation of data quality measures composing the coverage result.- Specified by:
getResultSpatialRepresentationin interfaceCoverageResult- Returns:
- digital representation of data quality measures composing the coverage result.
-
setResultSpatialRepresentation
Sets the digital representation of data quality measures composing the coverage result.- Parameters:
newValue- the new spatial representation value.
-
getResultContent
@UML(identifier="resultContent", obligation=CONDITIONAL, specification=UNSPECIFIED) public Collection<RangeDimension> getResultContent()Provides the description of the content of the result coverage. This is the semantic definition of the data quality measures.- Returns:
- description of the content of the result coverage.
- Since:
- 1.3
-
setResultContent
Sets the description of the content of the result coverage.- Parameters:
newValues- the new descriptions.- Since:
- 1.3
-
getResultContentDescription
Deprecated.Replaced bygetResultContent().Returns the description of the content of the result coverage, i.e. semantic definition of the data quality measures.- Specified by:
getResultContentDescriptionin interfaceCoverageResult- Returns:
- description of the content of the result coverage, or
null.
-
setResultContentDescription
Deprecated.Replaced bysetResultContent(Collection).Sets the description of the content of the result coverage, i.e. semantic definition of the data quality measures.- Parameters:
newValue- the new content description value.
-
getResultFormat
Returns the information about the format of the result coverage data.- Specified by:
getResultFormatin interfaceCoverageResult- Returns:
- format of the result coverage data, or
null.
-
setResultFormat
Sets the information about the format of the result coverage data.- Parameters:
newValue- the new result format value.
-
getResultFile
Returns the information about the data file containing the result coverage data.- Specified by:
getResultFilein interfaceCoverageResult- Returns:
- data file containing the result coverage data, or
null.
-
setResultFile
Sets the information about the data file containing the result coverage data.- Parameters:
newValue- the new result file value.
-
getStandard
Returns the metadata standard, which is ISO 19157.- Overrides:
getStandardin classISOMetadata- Returns:
- the metadata standard, which is ISO 19157.
-
getResultContent().