DefaultCoverageResult (Apache SIS 0.8 API)

Object
- AbstractMetadata
- - ModifiableMetadata
  - - ISOMetadata
    - - AbstractResult
      - DefaultCoverageResult

All Implemented Interfaces:

Serializable, Cloneable, Emptiable, LenientComparable, IdentifiedObject, CoverageResult, Result
```
public class DefaultCoverageResult
extends AbstractResult
implements CoverageResult
```
Result of a data quality measure organising the measured values as a coverage. The following properties are mandatory in a well-formed metadata according ISO 19115:
QE_CoverageResult ├─spatialRepresentationType…………………… Method used to spatially represent the coverage result. ├─resultSpatialRepresentation……………… Digital representation of data quality measures composing the coverage result. ├─resultContentDescription……………………… Description of the content of the result coverage, i.e. semantic definition of the data quality measures. │ └─attributeDescription……………………… Description of the attribute described by the measurement value. ├─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 XML instead.
Since:

0.3

See Also:

Serialized Form

Defined in the sis-metadata module

Field Summary
- Fields inherited from class ISOMetadata
  identifiers

Constructor Summary

Constructors
Constructor and Description
`DefaultCoverageResult()` Constructs an initially empty coverage result.
`DefaultCoverageResult(CoverageResult 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 and Description
`static DefaultCoverageResult`	`castOrCopy(CoverageResult object)` Returns a SIS metadata implementation with the values of the given arbitrary implementation.
`CoverageDescription`	`getResultContentDescription()` Returns the description of the content of the result coverage, i.e. semantic definition of the data quality measures.
`DataFile`	`getResultFile()` Returns the information about the data file containing the result coverage data.
`Format`	`getResultFormat()` Returns the information about the format of the result coverage data.
`SpatialRepresentation`	`getResultSpatialRepresentation()` Returns the digital representation of data quality measures composing the coverage result.
`SpatialRepresentationType`	`getSpatialRepresentationType()` Returns the method used to spatially represent the coverage result.
`void`	`setResultContentDescription(CoverageDescription newValue)` Sets the description of the content of the result coverage, i.e. semantic definition of the data quality measures.
`void`	`setResultFile(DataFile newValue)` Sets the information about the data file containing the result coverage data.
`void`	`setResultFormat(Format newValue)` Sets the information about the format of the result coverage data.
`void`	`setResultSpatialRepresentation(SpatialRepresentation newValue)` Sets the digital representation of data quality measures composing the coverage result.
`void`	`setSpatialRepresentationType(SpatialRepresentationType newValue)` Sets the method used to spatially represent the coverage result.

Methods inherited from class AbstractResult
castOrCopy

Methods inherited from class ISOMetadata
freeze, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata
checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, isModifiable, nonNullCollection, nonNullList, nonNullSet, singleton, unmodifiable, writeCollection, writeList, writeSet

Methods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString

Methods inherited from class Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DefaultCoverageResult
```
public DefaultCoverageResult()
```
    Constructs an initially empty coverage result.
  - DefaultCoverageResult
```
public DefaultCoverageResult(CoverageResult 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, or null if none.
    
    See Also:
    
    castOrCopy(CoverageResult)
- Method Detail
  - castOrCopy
```
public static DefaultCoverageResult castOrCopy(CoverageResult 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 returns null.
    - Otherwise if the given object is already an instance of DefaultCoverageResult, then it is returned unchanged.
    - Otherwise a new DefaultCoverageResult 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, or null 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.
  - getSpatialRepresentationType
```
public SpatialRepresentationType getSpatialRepresentationType()
```
    Returns the method used to spatially represent the coverage result.
    
    Specified by:
    
    getSpatialRepresentationType in interface CoverageResult
    
    Returns:
    
    spatial representation of the coverage result, or null.
  - setSpatialRepresentationType
```
public void setSpatialRepresentationType(SpatialRepresentationType newValue)
```
    Sets the method used to spatially represent the coverage result.
    
    Parameters:
    
    newValue - the new spatial representation type value.
  - getResultSpatialRepresentation
```
public SpatialRepresentation getResultSpatialRepresentation()
```
    Returns the digital representation of data quality measures composing the coverage result.
    
    Specified by:
    
    getResultSpatialRepresentation in interface CoverageResult
    
    Returns:
    
    digital representation of data quality measures composing the coverage result, or null.
  - setResultSpatialRepresentation
```
public void setResultSpatialRepresentation(SpatialRepresentation newValue)
```
    Sets the digital representation of data quality measures composing the coverage result.
    
    Parameters:
    
    newValue - the new spatial representation value.
  - getResultContentDescription
```
public CoverageDescription getResultContentDescription()
```
    Returns the description of the content of the result coverage, i.e. semantic definition of the data quality measures.
    
    Specified by:
    
    getResultContentDescription in interface CoverageResult
    
    Returns:
    
    description of the content of the result coverage, or null.
  - setResultContentDescription
```
public void setResultContentDescription(CoverageDescription newValue)
```
    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
```
public Format getResultFormat()
```
    Returns the information about the format of the result coverage data.
    
    Specified by:
    
    getResultFormat in interface CoverageResult
    
    Returns:
    
    format of the result coverage data, or null.
  - setResultFormat
```
public void setResultFormat(Format newValue)
```
    Sets the information about the format of the result coverage data.
    
    Parameters:
    
    newValue - the new result format value.
  - getResultFile
```
public DataFile getResultFile()
```
    Returns the information about the data file containing the result coverage data.
    
    Specified by:
    
    getResultFile in interface CoverageResult
    
    Returns:
    
    data file containing the result coverage data, or null.
  - setResultFile
```
public void setResultFile(DataFile newValue)
```
    Sets the information about the data file containing the result coverage data.
    
    Parameters:
    
    newValue - the new result file value.

Class DefaultCoverageResult

Field Summary

Fields inherited from class ISOMetadata

Constructor Summary

Method Summary

Methods inherited from class AbstractResult

Methods inherited from class ISOMetadata

Methods inherited from class ModifiableMetadata

Methods inherited from class AbstractMetadata

Methods inherited from class Object

Constructor Detail

DefaultCoverageResult

DefaultCoverageResult

Method Detail

castOrCopy

getSpatialRepresentationType

setSpatialRepresentationType

getResultSpatialRepresentation

setResultSpatialRepresentation

getResultContentDescription

setResultContentDescription

getResultFormat

setResultFormat

getResultFile

setResultFile