org.geotools.coverage.grid.io

Interface StructuredGridCoverage2DReader

All Superinterfaces:

GridCoverage2DReader, GridCoverageReader

All Known Implementing Classes:

ImageMosaicReader, NetCDFReader

public interface StructuredGridCoverage2DReader
extends GridCoverage2DReader

A GridCoverage2DReader which exposes the underlying granule structure and allows to create and remove coverages.

Author:

Simone Giannecchini, GeoSolutions SAS, Andrea Aime, GeoSolutions SAS, Daniele Romagnoli, GeoSolutions SAS

Field Summary

Fields inherited from interface GridCoverage2DReader

ELEVATION_DOMAIN, ELEVATION_DOMAIN_MAXIMUM, ELEVATION_DOMAIN_MINIMUM, ELEVATION_DOMAIN_RESOLUTION, FILE_SOURCE_PROPERTY, HAS_ELEVATION_DOMAIN, HAS_TIME_DOMAIN, MULTICRS_READER, REPROJECTING_READER, SOURCE_URL_PROPERTY, TIME_DOMAIN, TIME_DOMAIN_MAXIMUM, TIME_DOMAIN_MINIMUM, TIME_DOMAIN_RESOLUTION

Method Summary

Modifier and Type	Method and Description
void	createCoverage(String coverageName, SimpleFeatureType schema) Creates a granule store for a new coverage with the given feature type
void	delete(boolean deleteData) delete all stuff (database content, indexer files, property files, associated auxiliary files and so on).
List<DimensionDescriptor>	getDimensionDescriptors(String coverageName) Describes the dimensions supported by the specified coverage, if any.
GranuleSource	getGranules(String coverageName, boolean readOnly) Returns the granule source for the specified coverage (might be null, if there is only one supported coverage)
List<HarvestedSource>	harvest(String defaultTargetCoverage, Object source, Hints hints) Harvests the specified source into the reader.
boolean	isReadOnly() Return whether this reader can modify the granule source
boolean	removeCoverage(String coverageName) Deprecated. use removeCoverage(String, boolean)
boolean	removeCoverage(String coverageName, boolean delete) removes a granule store for the specified coverageName

Methods inherited from interface GridCoverage2DReader

getCoordinateReferenceSystem, getCoordinateReferenceSystem, getDatasetLayout, getDatasetLayout, getDynamicParameters, getDynamicParameters, getImageLayout, getImageLayout, getInfo, getInfo, getNumOverviews, getNumOverviews, getOriginalEnvelope, getOriginalEnvelope, getOriginalGridRange, getOriginalGridRange, getOriginalGridToWorld, getOriginalGridToWorld, getReadingResolutions, getReadingResolutions, getResolutionLevels, getResolutionLevels, read, read

Methods inherited from interface GridCoverageReader

dispose, getCurrentSubname, getFormat, getGridCoverageCount, getGridCoverageNames, getMetadataNames, getMetadataNames, getMetadataValue, getMetadataValue, getSource, hasMoreGridCoverages, listSubNames, skip

Method Detail

getGranules

GranuleSource getGranules(String coverageName,
                          boolean readOnly)
                   throws IOException,
                          UnsupportedOperationException

Returns the granule source for the specified coverage (might be null, if there is only one supported coverage)

Parameters:

coverageName - the name of the specified coverage

readOnly - a boolean indicating whether we may want modify the GranuleSource

Returns:

the requested GranuleSource

Throws:

IOException

UnsupportedOperationException

isReadOnly

boolean isReadOnly()

Return whether this reader can modify the granule source

Returns:

createCoverage

void createCoverage(String coverageName,
                    SimpleFeatureType schema)
             throws IOException,
                    UnsupportedOperationException

Creates a granule store for a new coverage with the given feature type

Throws:

IOException

UnsupportedOperationException

removeCoverage

boolean removeCoverage(String coverageName)
                throws IOException,
                       UnsupportedOperationException

Deprecated. use removeCoverage(String, boolean)

Throws:

IOException

UnsupportedOperationException

removeCoverage

boolean removeCoverage(String coverageName,
                       boolean delete)
                throws IOException,
                       UnsupportedOperationException

removes a granule store for the specified coverageName

Throws:

IOException

UnsupportedOperationException

delete

void delete(boolean deleteData)
     throws IOException

delete all stuff (database content, indexer files, property files, associated auxiliary files and so on).

Parameters:

deleteData - specifies whether data (granules) should be deleted too.

Throws:

IOException

harvest

List<HarvestedSource> harvest(String defaultTargetCoverage,
                              Object source,
                              Hints hints)
                       throws IOException,
                              UnsupportedOperationException

Harvests the specified source into the reader. Depending on the implementation, the original source is harvested in place (e.g., image mosaic), or might be copied into the reader persistent storage (e.g., database raster handling)

Parameters:

defaultCoverage - Default target coverage, to be used in case the sources being harvested are not structured ones. The parameter is optional, in case it's missing the reader will use the first coverage as the default target.

source - The source can be any kind of object, it's up to the reader implementation to understand and use it. Commons source types could be a single file, or a folder.

hints - Used to provide implementation specific hints on how to harvest the sources

Throws:

IOException

UnsupportedOperationException

getDimensionDescriptors

List<DimensionDescriptor> getDimensionDescriptors(String coverageName)
                                           throws IOException

Describes the dimensions supported by the specified coverage, if any. (coverageName might be null, if there is only one supported coverage)

Throws:

IOException