org.geotools.coverage.io

Interface CoverageSource

All Known Subinterfaces:

CoverageStore

All Known Implementing Classes:

DefaultCoverageSource, NetCDFSource

public interface CoverageSource

Allows read-only access to a Coverage.

Author:

Simone Giannecchini, GeoSolutions, Jody Garnett

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CoverageSource.AdditionalDomain
static class	CoverageSource.DomainType
static class	CoverageSource.SpatialDomain
static class	CoverageSource.TemporalDomain
static class	CoverageSource.VerticalDomain

Method Summary

Modifier and Type	Method and Description
void	dispose() Closes this CoverageSource and releases any lock or cached information it holds.
List<CoverageSource.AdditionalDomain>	getAdditionalDomains()
EnumSet<CoverageCapabilities>	getCapabilities() Set of supported CoverageCapabilities which can be used to discover capabilities of a certain CoverageSource.
CoordinateReferenceSystem	getCoordinateReferenceSystem()
List<DimensionDescriptor>	getDimensionDescriptors()
ResourceInfo	getInfo(ProgressListener listener) Information describing the contents of this resource.
MetadataNode	getMetadata(String metadataDomain, ProgressListener listener)
Set<Name>	getMetadataDomains()
Name	getName(ProgressListener listener) Name of the Coverage (ie data product) provided by this CoverageSource.
List<? extends RasterLayout>	getOverviewsLayouts(ProgressListener listener)
int	getOverviewsNumber(ProgressListener listener)
RangeType	getRangeType(ProgressListener listener) Retrieves a RangeType instance which can be used to describe the codomain for the underlying coverage.
Map<String,Parameter<?>>	getReadParameterInfo() Describes the required (and optional) parameters that can be passed to the read(CoverageReadRequest, ProgressListener) method.
CoverageSource.SpatialDomain	getSpatialDomain()
CoverageSource.TemporalDomain	getTemporalDomain()
CoverageSource.VerticalDomain	getVerticalDomain()
CoverageResponse	read(CoverageReadRequest request, ProgressListener listener) Obtain a CoverageResponse from this CoverageSource given a specified DefaultCoverageRequest.

Method Detail

getName

Name getName(ProgressListener listener)

Name of the Coverage (ie data product) provided by this CoverageSource.

Returns:

Name of the Coverage (ie data product) provided.

Since:

2.5

getInfo

ResourceInfo getInfo(ProgressListener listener)

Information describing the contents of this resource.

Please note that for FeatureContent:

• name - unique with in the context of a Service
• schema - used to identify the type of resource; usually the format or data product being represented

getReadParameterInfo

Map<String,Parameter<?>> getReadParameterInfo()

Describes the required (and optional) parameters that can be passed to the read(CoverageReadRequest, ProgressListener) method.

Returns:

Param a Map describing the Map for read(CoverageReadRequest, ProgressListener).

read

CoverageResponse read(CoverageReadRequest request,
                      ProgressListener listener)
               throws IOException

Obtain a CoverageResponse from this CoverageSource given a specified DefaultCoverageRequest.

Parameters:

request - the input DefaultCoverageRequest.

listener -

Returns:

Throws:

IOException

getRangeType

RangeType getRangeType(ProgressListener listener)
                throws IOException

Retrieves a RangeType instance which can be used to describe the codomain for the underlying coverage.

Parameters:

listener -

Returns:

a RangeType instance which can be used to describe the codomain for the underlying coverage.

Throws:

IOException - in case something bad occurs

dispose

void dispose()

Closes this CoverageSource and releases any lock or cached information it holds.

Once a CoverageAccess has been disposed it can be seen as being in unspecified state, hence calling a method on it may have unpredictable results.

getCapabilities

EnumSet<CoverageCapabilities> getCapabilities()

Set of supported CoverageCapabilities which can be used to discover capabilities of a certain CoverageSource.

You can use set membership to quickly test abilities:

 if( getCapabilities().contains( CoverageCapabilities.READ_SUBSAMPLING ) ){
     ...
 }
 

Returns:

a EnumSet of CoverageCapabilities which can be used to discover capabilities of this CoverageSource.

getMetadata

MetadataNode getMetadata(String metadataDomain,
                         ProgressListener listener)

getMetadataDomains

Set<Name> getMetadataDomains()

getCoordinateReferenceSystem

CoordinateReferenceSystem getCoordinateReferenceSystem()

getSpatialDomain

CoverageSource.SpatialDomain getSpatialDomain()
                                       throws IOException

Throws:

IOException

getTemporalDomain

CoverageSource.TemporalDomain getTemporalDomain()
                                         throws IOException

Throws:

IOException

getVerticalDomain

CoverageSource.VerticalDomain getVerticalDomain()
                                         throws IOException

Throws:

IOException

getAdditionalDomains

List<CoverageSource.AdditionalDomain> getAdditionalDomains()
                                                    throws IOException

Throws:

IOException

getOverviewsLayouts

List<? extends RasterLayout> getOverviewsLayouts(ProgressListener listener)
                                          throws IOException

Throws:

IOException

getOverviewsNumber

int getOverviewsNumber(ProgressListener listener)
                throws IOException

Throws:

IOException

getDimensionDescriptors

List<DimensionDescriptor> getDimensionDescriptors()
                                           throws IOException

Throws:

IOException