Module org.apache.sis.storage.earthobservation

Package org.apache.sis.storage.landsat

Class LandsatStoreProvider

Object

DataStoreProvider

LandsatStoreProvider

public class LandsatStoreProvider
extends DataStoreProvider

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

Thread safety

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

Since:

1.1

Nested Class Summary

Nested classes/interfaces inherited from class DataStoreProvider

Data­Store­Provider.Prober<S>

Field Summary

Fields inherited from class DataStoreProvider

CREATE, LOCATION

Constructor Summary

Constructors

Constructor	Description
Landsat­Store­Provider()	Creates a new provider.

Method Summary

Modifier and Type	Method	Description
Logger	get­Logger()	Returns the logger used by Landsat stores.
Parameter­Descriptor­Group	get­Open­Parameters()	Returns a description of all parameters accepted by this provider for opening a Landsat file.
String	get­Short­Name()	Returns a generic name for this data store, used mostly in warnings or error messages.
Data­Store	open(Storage­Connector connector)	Returns a Landsat­Store implementation associated with this provider.
Probe­Result	probe­Content(Storage­Connector connector)	Returns Probe­Result.SUPPORTED if the given storage appears to be supported by Landsat­Store.

Methods inherited from class DataStoreProvider

get­Format, get­Supported­Versions, open, probe­Content

Methods inherited from class Object

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

Constructor Details

LandsatStoreProvider

public LandsatStoreProvider()

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:

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 Landsat file.

Specified by:

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

Returns:

description of available parameters for opening a Landsat file.

Since:

0.8

See Also:

• Data­Store­Provider.LOCATION
• Data­Store­Provider.CREATE
• 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 Landsat­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 header.

Specified by:

probe­Content in class Data­Store­Provider

Parameters:

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

Returns:

Probe­Result.SUPPORTED if the given storage seems to be readable as a Landsat file.

Throws:

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

open

public DataStore open(StorageConnector connector)
               throws DataStoreException

Returns a Landsat­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)

getLogger

public Logger getLogger()

Returns the logger used by Landsat stores..

Overrides:

get­Logger in class Data­Store­Provider

Returns:

the logger used by Landsat stores

See Also:

• Store­Listeners.get­Logger()