Package org.apache.sis.storage

Class DataStores

java.lang.Object

org.apache.sis.util.Static

org.apache.sis.storage.DataStores

public final class DataStores
extends Static

Static convenience methods creating DataStore instances from a given storage object. Storage objects are typically File or DataSource instances, but can also be any other objects documented in the StorageConnector class.

Since:

0.4

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private static DataStoreRegistry	registry	The registry to use for searching for DataStoreProvider implementations.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DataStores()	Do not allow instantiation of this class.

Method Summary

Modifier and Type	Method	Description
static DataStore	open(Object storage)	Creates a DataStore for the given storage.
static String	probeContentType(Object storage)	Returns the MIME type of the storage file format, or null if unknown or not applicable.
static Collection<DataStoreProvider>	providers()	Returns the set of data store providers available at this method invocation time.
private static DataStoreRegistry	registry()	Returns the registry, created when first needed.

Methods inherited from class java.lang.Object

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

Field Details

registry

private static volatile DataStoreRegistry registry

The registry to use for searching for DataStoreProvider implementations.

Class loader

In current implementation, this registry is instantiated when first needed using the context class loader. This means that the set of available formats may depend on the first thread that invoked a DataStores method.

Constructor Details

DataStores

private DataStores()

Do not allow instantiation of this class.

Method Details

registry

private static DataStoreRegistry registry()

Returns the registry, created when first needed.

providers

public static Collection<DataStoreProvider> providers()

Returns the set of data store providers available at this method invocation time. More providers may be added later in a running JVM if new modules are added on the classpath.

Returns:

descriptions of available data stores.

Since:

0.8

probeContentType

public static String probeContentType(Object storage)
                               throws DataStoreException

Returns the MIME type of the storage file format, or null if unknown or not applicable.

Parameters:

storage - the input/output object as a URL, file, image input stream, etc..

Returns:

the storage MIME type, or null if unknown or not applicable.

Throws:

DataStoreException - if an error occurred while opening the storage.

open

public static DataStore open(Object storage)
                      throws UnsupportedStorageException,
DataStoreException

Creates a DataStore for the given storage. The storage argument can be any of the following types:

• A Path or a File for a file or a directory.
• A URI or a URL to a distant resource.
• A CharSequence interpreted as a filename or a URL.
• A Channel, DataInput, InputStream or Reader.
• A DataSource or a Connection to a JDBC database.
• Any other DataStore-specific object, for example ucar.nc2.NetcdfFile.
• An existing StorageConnector instance.

Parameters:

storage - the input/output object as a URL, file, image input stream, etc..

Returns:

the object to use for reading geospatial data from the given storage.

Throws:

UnsupportedStorageException - if no DataStoreProvider is found for a given storage object.

DataStoreException - if an error occurred while opening the storage.