org.geotools.coverage.grid.io.footprint

Interface FootprintGeometryProvider

All Known Implementing Classes:

SidecarFootprintProvider

public interface FootprintGeometryProvider

Method Summary

Modifier and Type	Method and Description
void	dispose() Close up the provider (in case it holds onto persistent resources such as files or database connections)
Geometry	getFootprint(SimpleFeature feature) Retrieves the footprint.
default List<File>	getSidecars(SimpleFeature feature) Returns the list of sidecar files defining masks for the specified feature.

Method Detail

getFootprint

Geometry getFootprint(SimpleFeature feature)
               throws IOException

Retrieves the footprint. If a feature is specified, return the footprint from the current granule representative feature as it comes from the index.

Parameters:

feature - the granule representative feature (if any). Specifying a null feature will return a default footprint (this is used in general for single-granule stores)

Throws:

IOException

getSidecars

default List<File> getSidecars(SimpleFeature feature)
                        throws IOException

Returns the list of sidecar files defining masks for the specified feature. The default implementation returns an empty list.

Parameters:

feature - the granule representative feature (if any)

Returns:

A list of files defining the masks for this granule (might be more than one)

Throws:

IOException

dispose

void dispose()

Close up the provider (in case it holds onto persistent resources such as files or database connections)