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

Nested Class Summary

Nested classes/interfaces inherited from class DataStoreProvider

DataStoreProvider.Prober<S>

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.opengis.parameter.ParameterDescriptor<Charset>	ENCODING	Description of the parameter for character encoding used by the data store.
private static final org.opengis.parameter.ParameterDescriptor<String>	FORMAT	Description of the parameter for name of format or DataStoreProvider to use for reading or writing the directory content.
private static final org.opengis.parameter.ParameterDescriptor<Locale>	LOCALE	Description of the parameter for formatting conventions of dates and numbers.
(package private) static final String	NAME	A short name or abbreviation for the data format.
(package private) static final org.opengis.parameter.ParameterDescriptorGroup	PARAMETERS	The group of parameter descriptors to be returned by getOpenParameters().
private static final org.opengis.parameter.ParameterDescriptor<TimeZone>	TIMEZONE	Description of the parameter for timezone of dates in the data store.

Fields inherited from class DataStoreProvider

CREATE, LOCATION

Constructor Summary

Constructors

Constructor	Description
StoreProvider()	Creates a new provider.

Method Summary

Modifier and Type	Method	Description
private static <T> org.opengis.parameter.ParameterDescriptor<T>	annotate(ParameterBuilder builder, org.opengis.parameter.ParameterDescriptor<T> e, org.opengis.util.InternationalString remark)	Creates a parameter descriptor equals to the given one except for the remarks which are set to the given value.
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.
private DataStore	open(StorageConnector connector, String format, EnumSet<StandardOpenOption> options)	Shared implementation of public open(…) methods.
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 DataStoreProvider

getFormat, getLogger, getSupportedVersions, probeContent

Methods inherited from class Object

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

Field Details

NAME

static final String NAME

A short name or abbreviation for the data format.

See Also:

• Constant Field Values

LOCALE

private static final org.opengis.parameter.ParameterDescriptor<Locale> LOCALE

Description of the parameter for formatting conventions of dates and numbers.

TIMEZONE

private static final org.opengis.parameter.ParameterDescriptor<TimeZone> TIMEZONE

Description of the parameter for timezone of dates in the data store.

ENCODING

private static final org.opengis.parameter.ParameterDescriptor<Charset> ENCODING

Description of the parameter for character encoding used by the data store.

FORMAT

private static final org.opengis.parameter.ParameterDescriptor<String> FORMAT

Description of the parameter for name of format or DataStoreProvider to use for reading or writing the directory content.

PARAMETERS

static final org.opengis.parameter.ParameterDescriptorGroup PARAMETERS

The group of parameter descriptors to be returned by getOpenParameters().

Constructor Details

StoreProvider

public StoreProvider()

Creates a new provider.

Method Details

annotate

private static <T>
org.opengis.parameter.ParameterDescriptor<T> annotate(ParameterBuilder builder,
 org.opengis.parameter.ParameterDescriptor<T> e,
 org.opengis.util.InternationalString remark)

Creates a parameter descriptor equals to the given one except for the remarks which are set to the given value.

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

private DataStore open(StorageConnector connector,
 String format,
 EnumSet<StandardOpenOption> options)
                throws DataStoreException

Shared implementation of public open(…) methods. Note that this method may modify the given options set for its own purpose.

Parameters:

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

format - format name for directory content, or null if unspecified.

options - whether to create a new directory, overwrite existing content, etc.

Throws:

DataStoreException

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()