Module org.apache.sis.storage.geotiff

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

Field Summary

Fields inherited from class DataStore

listeners, provider

Constructor Summary

Constructors

Constructor	Description
Geo­Tiff­Store(Data­Store parent, Data­Store­Provider provider, Storage­Connector connector, boolean hidden)	Creates a new GeoTIFF store as a component of a larger data store.
Geo­Tiff­Store(Geo­Tiff­Store­Provider provider, Storage­Connector connector)	Creates a new GeoTIFF store from the given file, URL or stream object.

Method Summary

Modifier and Type	Method	Description
<T extends Store­Event> void	add­Listener(Class<T> event­Type, Store­Listener<? 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<Grid­Coverage­Resource>	components()	Returns descriptions of all images in this GeoTIFF file.
Grid­Coverage­Resource	find­Resource(String sequence)	Returns the image at the given index.
Optional<Generic­Name>	get­Identifier()	Returns an identifier constructed from the name of the TIFF file.
Metadata	get­Metadata()	Returns information about the dataset as a whole.
Optional<Tree­Table>	get­Native­Metadata()	Returns TIFF tags and GeoTIFF keys as a tree for debugging purpose.
Optional<Parameter­Value­Group>	get­Open­Parameters()	Returns the parameters used to open this GeoTIFF data store.

Methods inherited from class DataStore

get­Display­Name, get­Locale, get­Provider, remove­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 Details

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.

GeoTiffStore

public GeoTiffStore(DataStore parent,
 DataStoreProvider provider,
 StorageConnector connector,
 boolean hidden)
             throws DataStoreException

Creates a new GeoTIFF store as a component of a larger data store. If the hidden parameter is true, some metadata that would normally be provided in this Geo­Tiff­Store will be provided by individual components instead.

Example

A Landsat data set is a collection of files in a directory or ZIP file, which includes more than 10 GeoTIFF files (one image per band or product for a scene). Landsat­Store is a data store opening the Landsat metadata file as the main file, then opening each band/product using a GeoTIFF data store. Those bands/products are components of the Landsat data store.

Parameters:

parent - the parent that contains this new GeoTIFF store component, or null if none.

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

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

hidden - true if this GeoTIFF store will not be directly accessible from the parent. It is the case if the parent store will expose only some components instead of the GeoTIFF store itself.

Throws:

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

Since:

1.1

Method Details

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 cannot 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()
• Default­Metadata.deep­Copy(Metadata)

getNativeMetadata

public Optional<TreeTable> getNativeMetadata()
                                      throws DataStoreException

Returns TIFF tags and GeoTIFF keys as a tree for debugging purpose. The tags and keys appear in the order they are declared in the file. The columns are tag numerical code as an Integer, tag name as a String and value as an Object.

This method should not be invoked during normal operations; the standard metadata are preferred because they allow abstraction of data format details. Native metadata should be used only when an information does not appear in standard metadata, or for debugging purposes.

Performance note

Since this method should not be invoked in normal operations, it has not been tuned for performance. Invoking this method may cause a lot of seek operations.

Overrides:

get­Native­Metadata in class Data­Store

Returns:

resources information structured in an implementation-specific way.

Throws:

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

Since:

1.2

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. If the given string has a scope (e.g. "filename:1"), then the scope

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 cannot 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 (cannot be null).

listener - listener to notify about events.

close

public void close()
           throws DataStoreException

Closes this GeoTIFF store and releases any underlying resources. This method can be invoked asynchronously for interrupting a long reading process.

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.

See Also:

• Store­Listeners.close()