Package org.apache.sis.internal.storage.folder

Class StoreProvider

java.lang.Object

org.apache.sis.storage.DataStoreProvider

org.apache.sis.internal.storage.folder.StoreProvider

public final class StoreProvider
extends DataStoreProvider

The provider of Store instances. This provider is intentionally registered with lowest priority because it will open any directory, which may conflict with other providers opening only directory with some specific content.

Since:

0.8

Version:

1.1

Author:

Johann Sorel (Geomatys), Martin Desruisseaux (Geomatys)

Nested Class Summary

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

DataStoreProvider.Prober<S>

Field Summary

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

CREATE, LOCATION

Constructor Summary

Constructors

Constructor	Description
StoreProvider()	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 data store.
String	getShortName()	Returns a short name or abbreviation for the data format.
DataStore	open(StorageConnector connector)	Returns a data store implementation associated with this provider.
DataStore	open(org.opengis.parameter.ParameterValueGroup parameters)	Returns a data store implementation associated with this provider for the given parameters.
ProbeResult	probeContent(StorageConnector connector)	Returns ProbeResult.SUPPORTED if the given storage appears to be a folder.

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

getFormat, getLogger, getSupportedVersions, probeContent

Methods inherited from class java.lang.Object

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

Constructor Details

StoreProvider

public StoreProvider()

Creates a new provider.

Method Details

getShortName

public String getShortName()

Returns a short name or abbreviation for the data format.

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 data store.

Specified by:

getOpenParameters in class DataStoreProvider

Returns:

description of the parameters for opening a DataStore.

See Also:

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

probeContent

public ProbeResult probeContent(StorageConnector connector)
                         throws DataStoreException

Returns ProbeResult.SUPPORTED if the given storage appears to be a folder. 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 characteristics.

Specified by:

probeContent in class DataStoreProvider

Parameters:

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

Returns:

ProbeResult.SUPPORTED if the given storage seems to be readable as a folder.

Throws:

DataStoreException - if an I/O error occurred.

open

public DataStore open(StorageConnector connector)
               throws DataStoreException

Returns a data store implementation associated with this provider. The data store created by this method will try to auto-detect the format of every files in the directory. For exploring only the file of a known format, use open(ParameterValueGroup) instead.

Specified by:

open in class DataStoreProvider

Parameters:

connector - information about the storage (URL, path, 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)

open

public DataStore open(org.opengis.parameter.ParameterValueGroup parameters)
               throws DataStoreException

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

Overrides:

open in class DataStoreProvider

Parameters:

parameters - opening parameters as defined by DataStoreProvider.getOpenParameters().

Returns:

a folder data store implementation for the given parameters.

Throws:

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

See Also:

• DataStoreProvider.LOCATION
• DataStoreProvider.CREATE
• DataStoreProvider.getOpenParameters()