Package org.apache.sis.internal.storage.csv

Class StoreProvider

java.lang.Object

org.apache.sis.storage.DataStoreProvider

org.apache.sis.internal.storage.URIDataStore.Provider

org.apache.sis.internal.storage.csv.StoreProvider

public final class StoreProvider
extends URIDataStore.Provider

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

Thread safety

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

Since:

0.8

Version:

1.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	StoreProvider.Peek	The object to use for verifying if the first keyword is the expected one.

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 org.opengis.parameter.ParameterDescriptor<FoliationRepresentation>	FOLIATION	Description of the optional parameter for specifying whether the reader should assemble distinct CSV lines into a single Feature instance forming a foliation.
(package private) static final String	MOVING	The format names for static features and moving features.
(package private) static final String	NAME	The format names for static features and moving features.

Fields inherited from class org.apache.sis.internal.storage.URIDataStore.Provider

CREATE_PARAM, ENCODING, LOCATION_PARAM

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
protected org.opengis.parameter.ParameterDescriptorGroup	build(ParameterBuilder builder)	Invoked by URIDataStore.Provider.getOpenParameters() the first time that a parameter descriptor needs to be created.
String	getShortName()	Returns a generic name for this data store, used mostly in warnings or error messages.
DataStore	open(StorageConnector connector)	Returns a CSV Store implementation associated with this provider.
DataStore	open(org.opengis.parameter.ParameterValueGroup parameters)	Returns a CSV Store implementation from the given parameters.
ProbeResult	probeContent(StorageConnector connector)	Returns the MIME type if the given storage appears to be supported by CSV Store.

Methods inherited from class org.apache.sis.internal.storage.URIDataStore.Provider

connector, descriptor, getOpenParameters, isWritable

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

Field Details

NAME

static final String NAME

The format names for static features and moving features.

See Also:

• Constant Field Values

MOVING

static final String MOVING

The format names for static features and moving features.

See Also:

• Constant Field Values

FOLIATION

private static final org.opengis.parameter.ParameterDescriptor<FoliationRepresentation> FOLIATION

Description of the optional parameter for specifying whether the reader should assemble distinct CSV lines into a single Feature instance forming a foliation. This is ignored if the CSV file does not seem to contain moving features.

Constructor Details

StoreProvider

public StoreProvider()

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

probeContent

public ProbeResult probeContent(StorageConnector connector)
                         throws DataStoreException

Returns the MIME type if the given storage appears to be supported by CSV Store. 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, JDBC connection, etc).

Returns:

a supported status with the MIME type if the given storage seems to be readable as a CSV file.

Throws:

DataStoreException - if an I/O error occurred.

open

public DataStore open(StorageConnector connector)
               throws DataStoreException

Returns a CSV Store 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)

open

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

Returns a CSV Store implementation from the given parameters.

Overrides:

open in class DataStoreProvider

Parameters:

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

Returns:

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

Throws:

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

See Also:

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

build

protected org.opengis.parameter.ParameterDescriptorGroup build(ParameterBuilder builder)

Invoked by URIDataStore.Provider.getOpenParameters() the first time that a parameter descriptor needs to be created.

Overrides:

build in class URIDataStore.Provider

Parameters:

builder - the builder to use for creating parameter descriptor. The group name is already set.

Returns:

the parameters descriptor for CSV files.