org.geotools.coverage.grid.io

Interface GranuleSource

All Known Subinterfaces:

GranuleStore

All Known Implementing Classes:

CoverageSlicesCatalogSource, GranuleCatalogSource, GranuleCatalogStore, RenamingGranuleSource, RenamingGranuleStore

public interface GranuleSource

API to operate on Granules data.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static Hints.Key	FILE_VIEW Asks a GranuleSource to return a file based view of the granules instead of a slice based view.
static String	FILES Used as key in the granule feature user data, pointing to a FileGroupProvider.FileGroup with the infos about the group of files composing
static Hints.Key	NATIVE_BOUNDS
static String	NATIVE_BOUNDS_KEY

Method Summary

Modifier and Type	Method and Description
void	dispose() This will free/release any resource (cached granules, ...).
ReferencedEnvelope	getBounds(Query q) Get the spatial bounds of the granules that would be returned by the given Query.
int	getCount(Query q) Gets the number of the granules that would be returned by the given Query, taking into account any settings for max features and start index set on the Query.
SimpleFeatureCollection	getGranules(Query q) Retrieves granules, in the form of a SimpleFeatureCollection, based on a Query.
SimpleFeatureType	getSchema() Retrieves the schema (feature type) that will apply to granules retrieved from this GranuleSource.
default Set<RenderingHints.Key>	getSupportedHints() Returns the set of hints that this GranuleSource supports via Query requests.

Field Detail

NATIVE_BOUNDS

static final Hints.Key NATIVE_BOUNDS

NATIVE_BOUNDS_KEY

static final String NATIVE_BOUNDS_KEY

See Also:

Constant Field Values

FILE_VIEW

static final Hints.Key FILE_VIEW

Asks a GranuleSource to return a file based view of the granules instead of a slice based view. In case a granule file contains more than one slice (e.g., NetCDF). The returned features will also miss an eventual location attribute, and include a full FileGroupProvider.FileGroup as the feature metadata under the FILES key.

FILES

static final String FILES

Used as key in the granule feature user data, pointing to a FileGroupProvider.FileGroup with the infos about the group of files composing

See Also:

Constant Field Values

Method Detail

getGranules

SimpleFeatureCollection getGranules(Query q)
                             throws IOException

Retrieves granules, in the form of a SimpleFeatureCollection, based on a Query.

Parameters:

q - the Query to select granules

Returns:

the resulting granules.

Throws:

IOException

getCount

int getCount(Query q)
      throws IOException

Gets the number of the granules that would be returned by the given Query, taking into account any settings for max features and start index set on the Query.

Parameters:

q - the Query to select granules

Returns:

the number of granules

Throws:

IOException

getBounds

ReferencedEnvelope getBounds(Query q)
                      throws IOException

Get the spatial bounds of the granules that would be returned by the given Query.

Parameters:

q - the Query to select granules

Returns:

The bounding envelope of the requested data

Throws:

IOException

getSchema

SimpleFeatureType getSchema()
                     throws IOException

Retrieves the schema (feature type) that will apply to granules retrieved from this GranuleSource.

Throws:

IOException

dispose

void dispose()
      throws IOException

This will free/release any resource (cached granules, ...).

Throws:

IOException

getSupportedHints

default Set<RenderingHints.Key> getSupportedHints()

Returns the set of hints that this GranuleSource supports via Query requests.

Note: the existence of a specific hint does not guarantee that it will always be honored by the implementing class.

Returns:

a set of RenderingHints#Key objects; may be empty but never null

See Also:

Hints#SGCR_FILE_VIEW