Package org.apache.sis.storage.netcdf
Class NetcdfStoreProvider
- Object
-
- DataStoreProvider
-
- NetcdfStoreProvider
-
public class NetcdfStoreProvider extends DataStoreProvider
The provider ofNetcdfStore
instances. Given aStorageConnector
input, this class tries to instantiate aNetcdfStore
using the embedded netCDF decoder. If the embedded decoder can not decode the given input and the UCAR library is reachable on the classpath, then this class tries to instantiate aNetcdfStore
backed by the UCAR library.Thread safetyThe sameNetcdfStoreProvider
instance can be safely used by many threads without synchronization on the part of the caller. However theNetcdfStore
instances created by this factory are not thread-safe.- Since:
- 0.3
- See Also:
NetcdfStore
Defined in the
sis-netcdf
module
-
-
Field Summary
-
Fields inherited from class DataStoreProvider
CREATE, LOCATION
-
-
Constructor Summary
Constructors Constructor Description NetcdfStoreProvider()
Creates a new provider.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ParameterDescriptorGroup
getOpenParameters()
Returns a description of all parameters accepted by this provider for opening a netCDF file.String
getShortName()
Returns a generic name for this data store, used mostly in warnings or error messages.DataStore
open(StorageConnector connector)
Returns aNetcdfStore
implementation associated with this provider.ProbeResult
probeContent(StorageConnector connector)
ReturnsProbeResult.SUPPORTED
if the given storage appears to be supported byNetcdfStore
.-
Methods inherited from class DataStoreProvider
getFormat, getLogger, getSupportedVersions, open
-
-
-
-
Method Detail
-
getShortName
public String getShortName()
Returns a generic name for this data store, used mostly in warnings or error messages.- Specified by:
getShortName
in classDataStoreProvider
- Returns:
- a short name or abbreviation for the data format.
- See Also:
DataStoreProvider.getFormat()
-
getOpenParameters
public ParameterDescriptorGroup getOpenParameters()
Returns a description of all parameters accepted by this provider for opening a netCDF file.- Specified by:
getOpenParameters
in classDataStoreProvider
- Returns:
- description of available parameters for opening a netCDF file.
- Since:
- 0.8
- See Also:
DataStoreProvider.LOCATION
,DataStoreProvider.CREATE
,DataStoreProvider.open(ParameterValueGroup)
,DataStore.getOpenParameters()
-
probeContent
public ProbeResult probeContent(StorageConnector connector) throws DataStoreException
ReturnsProbeResult.SUPPORTED
if the given storage appears to be supported byNetcdfStore
. ReturningSUPPORTED
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 object or contents.- Specified by:
probeContent
in classDataStoreProvider
- Parameters:
connector
- information about the storage (URL, stream,NetcdfFile
instance, etc).- Returns:
SUPPORTED
if the given storage seems to be usable byNetcdfStore
instances.- Throws:
DataStoreException
- if an I/O error occurred.
-
open
public DataStore open(StorageConnector connector) throws DataStoreException
Returns aNetcdfStore
implementation associated with this provider.- Specified by:
open
in classDataStoreProvider
- Parameters:
connector
- information about the storage (URL, stream,NetcdfFile
instance, 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)
-
-