Package org.apache.sis.storage.geotiff

Class GeoTiffStore

Object

DataStore

GeoTiffStore

All Implemented Interfaces:

Auto­Closeable, Aggregate, Resource, Localized

public class GeoTiffStore
extends DataStore
implements Aggregate

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	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	Description
<T extends StoreEvent> void	addListener(Class<T> eventType, StoreListener<? super T> listener)	Registers a listener to notify when the specified kind of event occurs in this data store.
void	close()	Closes this GeoTIFF store and releases any underlying resources.
List<GridCoverageResource>	components()	Returns descriptions of all images in this GeoTIFF file.
GridCoverageResource	findResource(String sequence)	Returns the image at the given index.
Optional<GenericName>	getIdentifier()	Returns an identifier constructed from the name of the TIFF file.
Metadata	getMetadata()	Returns information about the dataset as a whole.
Optional<ParameterValueGroup>	getOpenParameters()	Returns the parameters used to open this GeoTIFF data store.

Methods inherited from class DataStore

add­Warning­Listener, get­Display­Name, get­Locale, get­Provider, remove­Listener, remove­Warning­Listener, set­Locale, to­String

Methods inherited from class Object

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

Methods inherited from interface Resource

remove­Listener

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

getOpenParameters

public Optional<ParameterValueGroup> getOpenParameters()

Returns the parameters used to open this GeoTIFF data store. The parameters are described by Geo­Tiff­Store­Provider.get­Open­Parameters() and contains at least a parameter named "location" with a URI value. The return value may be empty 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.

See Also:

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

getIdentifier

public Optional<GenericName> getIdentifier()
                                    throws DataStoreException

Returns an identifier constructed from the name of the TIFF file. An identifier is available only if the storage input specified at construction time was something convertible to URI, for example an URL, File or Path.

Specified by:

get­Identifier in interface Resource

Overrides:

get­Identifier in class Data­Store

Returns:

the identifier derived from the filename.

Throws:

Data­Store­Exception - if an error occurred while fetching the identifier.

Since:

1.0

See Also:

Data­Store.get­Metadata(), Data­Store.get­Display­Name()

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:

Data­Store.get­Identifier()

components

public List<GridCoverageResource> components()
                                      throws DataStoreException

Returns descriptions of all images in this GeoTIFF file. Images are not immediately loaded.

If an error occurs during iteration in the returned collection, an unchecked Backing­Store­Exception will be thrown with a Data­Store­Exception as its cause.

Specified by:

components in interface Aggregate

Returns:

descriptions of all images in this GeoTIFF file.

Throws:

Data­Store­Exception - if an error occurred while fetching the image descriptions.

Since:

1.0

findResource

public GridCoverageResource findResource(String sequence)
                                  throws DataStoreException

Returns the image at the given index. Images numbering starts at 1.

Overrides:

find­Resource in class Data­Store

Parameters:

sequence - string representation of the image index, starting at 1.

Returns:

image at the given index.

Throws:

Data­Store­Exception - if the requested image can not be obtained.

See Also:

Resource.get­Identifier(), Feature­Naming

addListener

public <T extends StoreEvent> void addListener(Class<T> eventType,
                                               StoreListener<? super T> listener)

Registers a listener to notify when the specified kind of event occurs in this data store. The current implementation of this data store can emit only Warning­Events; any listener specified for another kind of events will be ignored.

Specified by:

add­Listener in interface Resource

Overrides:

add­Listener in class Data­Store

Type Parameters:

T - compile-time value of the event­Type argument.

Parameters:

event­Type - type of Store­Event to listen (can not be null).

listener - listener to notify about events.

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.