org.geotools.gce.imagemosaic.catalog

Class MultiLevelROIGeometryOverviewsProvider

Object

MultiLevelROIGeometryOverviewsProvider

All Implemented Interfaces:

MultiLevelROIProvider

public class MultiLevelROIGeometryOverviewsProvider
extends Object
implements MultiLevelROIProvider

A MultiLevelROIProvider implementation used for returning MultiLevelROIGeometryOverviewss

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_OVERVIEWS_ROI_IN_RASTER_SPACE
static String	DEFAULT_OVERVIEWS_SUFFIX_FORMAT
static String	FOOTPRINT_LOADER_SPI
static int	LOOK_FOR_OVERVIEWS
static String	OVERVIEWS_FOOTPRINT_LOADER_SPI
static String	OVERVIEWS_ROI_IN_RASTER_SPACE_KEY
static String	OVERVIEWS_SUFFIX_FORMAT_KEY

Constructor Summary

Constructors

Constructor and Description
MultiLevelROIGeometryOverviewsProvider(File baseFile, String overviewSuffixFormat, int numOverviews, FootprintLoader footprintLoader, FootprintLoader overviewsFootprintLoader, boolean overviewsRoiInRasterSpace, Hints hints)

Method Summary

Modifier and Type	Method and Description
void	dispose() Optional method to call for disposing the Provider
List<File>	getFootprintFiles(SimpleFeature feature) Returns the footprint file used to load the footprint, or none if there was no file involved
MultiLevelROI	getMultiScaleROI(SimpleFeature sf) Returns a MultiLevelROI object from a granule

Methods inherited from class Object

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

Field Detail

LOOK_FOR_OVERVIEWS

public static final int LOOK_FOR_OVERVIEWS

See Also:

Constant Field Values

OVERVIEWS_SUFFIX_FORMAT_KEY

public static final String OVERVIEWS_SUFFIX_FORMAT_KEY

See Also:

Constant Field Values

DEFAULT_OVERVIEWS_SUFFIX_FORMAT

public static final String DEFAULT_OVERVIEWS_SUFFIX_FORMAT

See Also:

Constant Field Values

DEFAULT_OVERVIEWS_ROI_IN_RASTER_SPACE

public static final boolean DEFAULT_OVERVIEWS_ROI_IN_RASTER_SPACE

See Also:

Constant Field Values

OVERVIEWS_ROI_IN_RASTER_SPACE_KEY

public static final String OVERVIEWS_ROI_IN_RASTER_SPACE_KEY

See Also:

Constant Field Values

FOOTPRINT_LOADER_SPI

public static final String FOOTPRINT_LOADER_SPI

See Also:

Constant Field Values

OVERVIEWS_FOOTPRINT_LOADER_SPI

public static final String OVERVIEWS_FOOTPRINT_LOADER_SPI

See Also:

Constant Field Values

Constructor Detail

MultiLevelROIGeometryOverviewsProvider

public MultiLevelROIGeometryOverviewsProvider(File baseFile,
                                              String overviewSuffixFormat,
                                              int numOverviews,
                                              FootprintLoader footprintLoader,
                                              FootprintLoader overviewsFootprintLoader,
                                              boolean overviewsRoiInRasterSpace,
                                              Hints hints)

Method Detail

getMultiScaleROI

public MultiLevelROI getMultiScaleROI(SimpleFeature sf)
                               throws IOException

Description copied from interface: MultiLevelROIProvider

Returns a MultiLevelROI object from a granule

Specified by:

getMultiScaleROI in interface MultiLevelROIProvider

Parameters:

sf - SimpleFeature related to a granule (if several are available). Specifying a null feature should return the default provider.

Returns:

a MultiLevelROI object associated to the input SimpleFeature

Throws:

IOException

dispose

public void dispose()

Description copied from interface: MultiLevelROIProvider

Optional method to call for disposing the Provider

Specified by:

dispose in interface MultiLevelROIProvider

getFootprintFiles

public List<File> getFootprintFiles(SimpleFeature feature)
                             throws IOException

Description copied from interface: MultiLevelROIProvider

Returns the footprint file used to load the footprint, or none if there was no file involved

Specified by:

getFootprintFiles in interface MultiLevelROIProvider

Returns:

The files used to load the footprints, or an empty list otherwise

Throws:

IOException