org.apache.sis.storage.geotiff

Class GeoTiffStore

Object

DataStore

GeoTiffStore

All Implemented Interfaces:

AutoCloseable, Resource, Localized

public class GeoTiffStore
extends DataStore

A data store backed by GeoTIFF files.

Since:

0.8

Defined in the sis-geotiff module

Field Summary

Fields inherited from class DataStore

listeners, provider

Constructor Summary

Constructors

Constructor and Description
GeoTiffStore(GeoTiffStoreProvider provider, StorageConnector connector) Creates a new GeoTIFF store from the given file, URL or stream object.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this GeoTIFF store and releases any underlying resources.
Metadata	getMetadata() Returns information about the dataset as a whole.
ParameterValueGroup	getOpenParameters() Returns the parameters used to open this GeoTIFF data store.

Methods inherited from class DataStore

add­Warning­Listener, find­Resource, get­Display­Name, get­Locale, get­Provider, remove­Warning­Listener, set­Locale

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Constructor Detail

GeoTiffStore

public GeoTiffStore(GeoTiffStoreProvider provider,
                    StorageConnector connector)
             throws DataStoreException

Creates a new GeoTIFF store from the given file, URL or stream object. This constructor invokes Storage­Connector.close­All­Except(Object), keeping open only the needed resource.

Parameters:

provider - the factory that created this Data­Store instance, or null if unspecified.

connector - information about the storage (URL, stream, etc).

Throws:

Data­Store­Exception - if an error occurred while opening the GeoTIFF file.

Method Detail

getMetadata

public Metadata getMetadata()
                     throws DataStoreException

Returns information about the dataset as a whole. The returned metadata object can contain information such as the spatiotemporal extent of the dataset, contact information about the creator or distributor, data quality, usage constraints and more.

Specified by:

get­Metadata in interface Resource

Specified by:

get­Metadata in class Data­Store

Returns:

information about the dataset.

Throws:

Data­Store­Exception - if an error occurred while reading the data.

See Also:

Resource.get­Metadata()

getOpenParameters

public ParameterValueGroup getOpenParameters()

Returns the parameters used to open this GeoTIFF data store. If non-null, the parameters are described by Geo­Tiff­Store­Provider.get­Open­Parameters() and contains at least a parameter named "location" with a URI value. This method may return null if the storage input can not be described by a URI (for example a GeoTIFF file reading directly from a Readable­Byte­Channel).

Specified by:

get­Open­Parameters in class Data­Store

Returns:

parameters used for opening this data store, or null if not available.

Since:

0.8

See Also:

Data­Store­Provider.get­Open­Parameters()

close

public void close()
           throws DataStoreException

Closes this GeoTIFF store and releases any underlying resources.

Specified by:

close in interface Auto­Closeable

Specified by:

close in class Data­Store

Throws:

Data­Store­Exception - if an error occurred while closing the GeoTIFF file.