Package org.geotools.coverage.io.impl

Class DefaultCoverageSource

Object

DefaultCoverageSource

All Implemented Interfaces:

CoverageSource

Direct Known Subclasses:

NetCDFSource

public abstract class DefaultCoverageSource
extends Object
implements CoverageSource

Default implementation of CoverageSource.

Author:

Daniele Romagnoli, GeoSolutions SAS

Nested Class Summary

Nested classes/interfaces inherited from interface CoverageSource

CoverageSource.AdditionalDomain, CoverageSource.DomainType, CoverageSource.SpatialDomain, CoverageSource.TemporalDomain, CoverageSource.VerticalDomain

Field Summary

Fields

Modifier and Type	Field	Description
protected static final EnumSet<CoverageCapabilities>	CAPABILITIES
protected final CoverageSourceDescriptor	coverageDescriptor
protected final Name	name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultCoverageSource(Name name, CoverageSourceDescriptor descriptor)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Closes this CoverageSource and releases any lock or cached information it holds.
protected void	ensureNotDisposed()
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 CoverageSource.read(CoverageReadRequest, ProgressListener) method.
CoverageSource.SpatialDomain	getSpatialDomain()
CoverageSource.TemporalDomain	getTemporalDomain()
CoverageSource.VerticalDomain	getVerticalDomain()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface CoverageSource

read

Field Details

CAPABILITIES

protected static final EnumSet<CoverageCapabilities> CAPABILITIES

name

protected final Name name

coverageDescriptor

protected final CoverageSourceDescriptor coverageDescriptor

Constructor Details

DefaultCoverageSource

protected DefaultCoverageSource(Name name,
 CoverageSourceDescriptor descriptor)

Method Details

getReadParameterInfo

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

Description copied from interface: CoverageSource

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

Specified by:

getReadParameterInfo in interface CoverageSource

Returns:

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

getMetadata

public MetadataNode getMetadata(String metadataDomain,
 ProgressListener listener)

Specified by:

getMetadata in interface CoverageSource

getMetadataDomains

public Set<Name> getMetadataDomains()

Specified by:

getMetadataDomains in interface CoverageSource

getOverviewsLayouts

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

Specified by:

getOverviewsLayouts in interface CoverageSource

Throws:

IOException

getOverviewsNumber

public int getOverviewsNumber(ProgressListener listener)
                       throws IOException

Specified by:

getOverviewsNumber in interface CoverageSource

Throws:

IOException

getName

public Name getName(ProgressListener listener)

Description copied from interface: CoverageSource

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

Specified by:

getName in interface CoverageSource

Returns:

Name of the Coverage (ie data product) provided.

ensureNotDisposed

protected void ensureNotDisposed()

getCapabilities

public EnumSet<CoverageCapabilities> getCapabilities()

Description copied from interface: CoverageSource

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 ) ){
     ...
 }
 

Specified by:

getCapabilities in interface CoverageSource

Returns:

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

getRangeType

public RangeType getRangeType(ProgressListener listener)
                       throws IOException

Description copied from interface: CoverageSource

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

Specified by:

getRangeType in interface CoverageSource

Returns:

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

Throws:

IOException - in case something bad occurs

getCoordinateReferenceSystem

public CoordinateReferenceSystem getCoordinateReferenceSystem()

Specified by:

getCoordinateReferenceSystem in interface CoverageSource

getSpatialDomain

public CoverageSource.SpatialDomain getSpatialDomain()
                                              throws IOException

Specified by:

getSpatialDomain in interface CoverageSource

Throws:

IOException

getTemporalDomain

public CoverageSource.TemporalDomain getTemporalDomain()
                                                throws IOException

Specified by:

getTemporalDomain in interface CoverageSource

Throws:

IOException

getVerticalDomain

public CoverageSource.VerticalDomain getVerticalDomain()
                                                throws IOException

Specified by:

getVerticalDomain in interface CoverageSource

Throws:

IOException

getAdditionalDomains

public List<CoverageSource.AdditionalDomain> getAdditionalDomains()
                                                           throws IOException

Specified by:

getAdditionalDomains in interface CoverageSource

Throws:

IOException

getDimensionDescriptors

public List<DimensionDescriptor> getDimensionDescriptors()
                                                  throws IOException

Specified by:

getDimensionDescriptors in interface CoverageSource

Throws:

IOException

getInfo

public ResourceInfo getInfo(ProgressListener listener)

Description copied from interface: CoverageSource

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

Specified by:

getInfo in interface CoverageSource

dispose

public void dispose()

Description copied from interface: CoverageSource

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.

Specified by:

dispose in interface CoverageSource