org.apache.sis.storage.geotiff

Class GeoTiffStoreProvider

Object

DataStoreProvider

GeoTiffStoreProvider

public class GeoTiffStoreProvider
extends DataStoreProvider

The provider of Geo­Tiff­Store instances. Given a Storage­Connector input, this class tries to instantiate a Geo­Tiff­Store.

Thread safety

The same Geo­Tiff­Store­Provider instance can be safely used by many threads without synchronization on the part of the caller. However the Geo­Tiff­Store instances created by this factory are not thread-safe.

Since:

0.8

See Also:

Geo­Tiff­Store

Defined in the sis-geotiff module

Field Summary

Fields inherited from class DataStoreProvider

LOCATION

Constructor Summary

Constructors

Constructor and Description
GeoTiffStoreProvider() Creates a new provider.

Method Summary

Modifier and Type	Method and Description
ParameterDescriptorGroup	getOpenParameters() Returns a description of all parameters accepted by this provider for opening a GeoTIFF file.
String	getShortName() Returns a generic name for this data store, used mostly in warnings or error messages.
DataStore	open(StorageConnector connector) Returns a Geo­Tiff­Store implementation associated with this provider.
ProbeResult	probeContent(StorageConnector connector) Returns Probe­Result.SUPPORTED if the given storage appears to be supported by Geo­Tiff­Store.

Methods inherited from class DataStoreProvider

get­Format, get­Supported­Versions, open

Methods inherited from class Object

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

Constructor Detail

GeoTiffStoreProvider

public GeoTiffStoreProvider()

Creates a new provider.

Method Detail

getShortName

public String getShortName()

Returns a generic name for this data store, used mostly in warnings or error messages.

Specified by:

get­Short­Name in class Data­Store­Provider

Returns:

a short name or abbreviation for the data format.

See Also:

Data­Store­Provider.get­Format()

getOpenParameters

public ParameterDescriptorGroup getOpenParameters()

Returns a description of all parameters accepted by this provider for opening a GeoTIFF file.

Specified by:

get­Open­Parameters in class Data­Store­Provider

Returns:

description of available parameters for opening a GeoTIFF file.

Since:

0.8

See Also:

Data­Store­Provider.open(Parameter­Value­Group), Data­Store.get­Open­Parameters()

probeContent

public ProbeResult probeContent(StorageConnector connector)
                         throws DataStoreException

Returns Probe­Result.SUPPORTED if the given storage appears to be supported by Geo­Tiff­Store. Returning SUPPORTED from this method does not guarantee that reading or writing will succeed, only that there appears to be a reasonable chance of success based on a brief inspection of the storage object or contents.

Specified by:

probe­Content in class Data­Store­Provider

Parameters:

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

Returns:

SUPPORTED if the given storage seems to be usable by Geo­Tiff­Store instances.

Throws:

Data­Store­Exception - if an I/O error occurred.

open

public DataStore open(StorageConnector connector)
               throws DataStoreException

Returns a Geo­Tiff­Store implementation associated with this provider.

Specified by:

open in class Data­Store­Provider

Parameters:

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

Returns:

a data store implementation associated with this provider for the given storage.

Throws:

Data­Store­Exception - if an error occurred while creating the data store instance.

See Also:

Data­Stores.open(Object)