Package org.apache.sis.storage.geotiff

Class GeoTiffStoreProvider

java.lang.Object

org.apache.sis.storage.DataStoreProvider

org.apache.sis.storage.geotiff.GeoTiffStoreProvider

public class GeoTiffStoreProvider
extends DataStoreProvider

The provider of GeoTiffStore instances. Given a StorageConnector input, this class tries to instantiate a GeoTiffStore.

Thread safety

The same GeoTiffStoreProvider instance can be safely used by many threads without synchronization on the part of the caller. However, the GeoTiffStore instances created by this factory are not thread-safe.

Since:

0.8

Version:

1.2

See Also:

• GeoTiffStore

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sis.storage.DataStoreProvider

DataStoreProvider.Prober<S>

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	MIME_TYPE	The MIME type for GeoTIFF files.
private static final org.opengis.parameter.ParameterDescriptorGroup	OPEN_DESCRIPTOR	The parameter descriptor to be returned by getOpenParameters().
private static final Version	VERSION	The TIFF version.

Fields inherited from class org.apache.sis.storage.DataStoreProvider

CREATE, LOCATION

Constructor Summary

Constructors

Constructor	Description
GeoTiffStoreProvider()	Creates a new provider.

Method Summary

Modifier and Type	Method	Description
org.opengis.parameter.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 GeoTiffStore implementation associated with this provider.
ProbeResult	probeContent(StorageConnector connector)	Returns the MIME type if the given storage appears to be supported by GeoTiffStore.

Methods inherited from class org.apache.sis.storage.DataStoreProvider

getFormat, getLogger, getSupportedVersions, open, probeContent

Methods inherited from class java.lang.Object

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

Field Details

MIME_TYPE

private static final String MIME_TYPE

The MIME type for GeoTIFF files.

See Also:

• Constant Field Values

VERSION

private static final Version VERSION

The TIFF version.

OPEN_DESCRIPTOR

private static final org.opengis.parameter.ParameterDescriptorGroup OPEN_DESCRIPTOR

The parameter descriptor to be returned by getOpenParameters().

Constructor Details

GeoTiffStoreProvider

public GeoTiffStoreProvider()

Creates a new provider.

Method Details

getShortName

public String getShortName()

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

Specified by:

getShortName in class DataStoreProvider

Returns:

a short name or abbreviation for the data format.

See Also:

• DataStoreProvider.getFormat()

getOpenParameters

public org.opengis.parameter.ParameterDescriptorGroup getOpenParameters()

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

Specified by:

getOpenParameters in class DataStoreProvider

Returns:

description of available parameters for opening a GeoTIFF file.

Since:

0.8

See Also:

• DataStoreProvider.LOCATION
• DataStoreProvider.CREATE
• DataStoreProvider.open(ParameterValueGroup)
• DataStore.getOpenParameters()

probeContent

public ProbeResult probeContent(StorageConnector connector)
                         throws DataStoreException

Returns the MIME type if the given storage appears to be supported by GeoTiffStore. A supported status 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 file header.

Specified by:

probeContent in class DataStoreProvider

Parameters:

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

Returns:

a supported status with the MIME type if the given storage seems to be readable by GeoTiffStore instances.

Throws:

DataStoreException - if an I/O error occurred.

open

public DataStore open(StorageConnector connector)
               throws DataStoreException

Returns a GeoTiffStore implementation associated with this provider.

Specified by:

open in class DataStoreProvider

Parameters:

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

Returns:

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

Throws:

DataStoreException - if an error occurred while creating the data store instance.

See Also:

• DataStores.open(Object)