Package org.apache.sis.internal.storage.wkt

Class StoreProvider

java.lang.Object

org.apache.sis.storage.DataStoreProvider

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

org.apache.sis.internal.storage.wkt.StoreProvider

public final class StoreProvider
extends URIDataStore.Provider

The provider of WKT Store instances.

Since:

0.7

Version:

1.2

Nested Class Summary

Nested Classes

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

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

DataStoreProvider.Prober<S>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The format name.

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
String	getShortName()	Returns a generic name for this data store, used mostly in warnings or error messages.
DataStore	open(StorageConnector connector)	Returns a Store implementation associated with this provider.
ProbeResult	probeContent(StorageConnector connector)	Returns WKT version if the given storage appears to be supported by WKT Store.

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

build, connector, descriptor, getOpenParameters, isWritable

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

NAME

public static final String NAME

The format name.

See Also:

• Constant Field Values

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 WKT version if the given storage appears to be supported by WKT 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 WKT version if the given storage seems to be readable as a WKT string.

Throws:

DataStoreException - if an I/O error occurred.

open

public DataStore open(StorageConnector connector)
               throws DataStoreException

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