org.geotools.imageio

Class GeoSpatialImageReader

Object

ImageReader

GeoSpatialImageReader

All Implemented Interfaces:

FileSetManager

Direct Known Subclasses:

NetCDFImageReader

public abstract class GeoSpatialImageReader
extends ImageReader
implements FileSetManager

Author:

Daniele Romagnoli, GeoSolutions SAS, Simone Giannecchini, GeoSolutions SAS

Field Summary

Fields

Modifier and Type	Field and Description
protected File	file The source file
protected int	numImages

Fields inherited from class ImageReader

availableLocales, ignoreMetadata, input, locale, minIndex, originatingProvider, progressListeners, seekForwardOnly, updateListeners, warningListeners, warningLocales

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GeoSpatialImageReader(ImageReaderSpi originatingProvider)

Method Summary

Modifier and Type	Method and Description
protected void	checkImageIndex(int imageIndex) Simple check of the specified image index.
void	dispose()
protected void	finalize()
String	getAuxiliaryDatastorePath()
String	getAuxiliaryFilesPath()
CoverageSlicesCatalog	getCatalog() Returns the underlying slicesCatalog.
abstract CoverageSourceDescriptor	getCoverageDescriptor(Name name)
abstract Collection<Name>	getCoveragesNames() Return the name of coverages made available by this provider
abstract int	getCoveragesNumber() The number of coverages made available by this provider.
List<Integer>	getImageIndex(Query filterQuery) Return the list of imageIndex related to the feature in the slicesCatalog which result from the specified query.
IIOMetadata	getImageMetadata(int imageIndex)
int	getNumImages(boolean allowSearch)
IIOMetadata	getStreamMetadata()
protected void	initCatalog(DataStoreConfiguration datastoreConfig) Initialize a slicesCatalog on top of the provided DataStoreConfiguration instance
protected void	initCatalog(File parentLocation, String databaseName) Init the slicesCatalog based on the provided parameters
void	setAuxiliaryDatastorePath(String auxiliaryDatastorePath)
void	setAuxiliaryFilesPath(String auxiliaryFilesPath)
protected void	setCatalog(CoverageSlicesCatalog catalog)

Methods inherited from class ImageReader

abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, canReadRaster, checkReadParamBandSettings, clearAbortRequest, computeRegions, getAspectRatio, getAvailableLocales, getDefaultReadParam, getDestination, getFormatName, getHeight, getImageMetadata, getImageTypes, getInput, getLocale, getMinIndex, getNumThumbnails, getOriginatingProvider, getRawImageType, getSourceRegion, getStreamMetadata, getThumbnailHeight, getThumbnailWidth, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, getWidth, hasThumbnails, isIgnoringMetadata, isImageTiled, isRandomAccessEasy, isSeekForwardOnly, processImageComplete, processImageProgress, processImageStarted, processImageUpdate, processPassComplete, processPassStarted, processReadAborted, processSequenceComplete, processSequenceStarted, processThumbnailComplete, processThumbnailPassComplete, processThumbnailPassStarted, processThumbnailProgress, processThumbnailStarted, processThumbnailUpdate, processWarningOccurred, processWarningOccurred, read, read, readAll, readAll, readAsRenderedImage, readerSupportsThumbnails, readRaster, readThumbnail, readTile, readTileRaster, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, reset, setInput, setInput, setInput, setLocale

Methods inherited from class Object

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

Methods inherited from interface FileSetManager

addFile, list, purge, removeFile

Field Detail

file

protected File file

The source file

numImages

protected int numImages

Constructor Detail

GeoSpatialImageReader

protected GeoSpatialImageReader(ImageReaderSpi originatingProvider)

Method Detail

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)
                             throws IOException

Specified by:

getImageMetadata in class ImageReader

Throws:

IOException

dispose

public void dispose()

Overrides:

dispose in class ImageReader

getStreamMetadata

public IIOMetadata getStreamMetadata()
                              throws IOException

Specified by:

getStreamMetadata in class ImageReader

Throws:

IOException

checkImageIndex

protected void checkImageIndex(int imageIndex)

Simple check of the specified image index. Valid indexes are belonging the range [0 - numRasters]. In case this constraint is not respected, an IndexOutOfBoundsException is thrown.

Parameters:

imageIndex - the index to be checked

getNumImages

public int getNumImages(boolean allowSearch)
                 throws IOException

Specified by:

getNumImages in class ImageReader

Throws:

IOException

getCoveragesNames

public abstract Collection<Name> getCoveragesNames()

Return the name of coverages made available by this provider

getCoveragesNumber

public abstract int getCoveragesNumber()

The number of coverages made available by this provider.

getCoverageDescriptor

public abstract CoverageSourceDescriptor getCoverageDescriptor(Name name)

Parameters:

name -

Returns:

setCatalog

protected void setCatalog(CoverageSlicesCatalog catalog)

getImageIndex

public List<Integer> getImageIndex(Query filterQuery)
                            throws IOException

Return the list of imageIndex related to the feature in the slicesCatalog which result from the specified query.

Parameters:

filterQuery - the filter query (temporal, vertical, name selection) to restrict the requested imageIndexes

Returns:

Throws:

IOException

getAuxiliaryFilesPath

public String getAuxiliaryFilesPath()

setAuxiliaryFilesPath

public void setAuxiliaryFilesPath(String auxiliaryFilesPath)

getAuxiliaryDatastorePath

public String getAuxiliaryDatastorePath()

setAuxiliaryDatastorePath

public void setAuxiliaryDatastorePath(String auxiliaryDatastorePath)

getCatalog

public CoverageSlicesCatalog getCatalog()

Returns the underlying slicesCatalog.

Returns:

initCatalog

protected void initCatalog(File parentLocation,
                           String databaseName)
                    throws IOException

Init the slicesCatalog based on the provided parameters

Parameters:

parentLocation -

databaseName -

Throws:

IOException

initCatalog

protected void initCatalog(DataStoreConfiguration datastoreConfig)
                    throws IOException

Initialize a slicesCatalog on top of the provided DataStoreConfiguration instance

Parameters:

datastoreConfig -

Throws:

IOException

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable