Package org.apache.sis.storage.netcdf
Class NetcdfStoreProvider
Object
DataStoreProvider
NetcdfStoreProvider
The provider of
NetcdfStore instances. Given a StorageConnector input,
this class tries to instantiate a NetcdfStore using the embedded netCDF decoder.
If the embedded decoder cannot decode the given input and the UCAR library is reachable
on the classpath, then this class tries to instantiate a NetcdfStore backed by
the UCAR library.
Thread safety
The sameNetcdfStoreProvider instance can be safely used by many threads without synchronization on
the part of the caller. However, the NetcdfStore instances created by this factory are not thread-safe.- Since:
- 0.3
- See Also:
Defined in the sis-netcdf module
-
Nested Class Summary
Nested classes/interfaces inherited from class DataStoreProvider
DataStoreProvider.Prober<S> -
Field Summary
Fields inherited from class DataStoreProvider
CREATE, LOCATION -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a description of all parameters accepted by this provider for opening a netCDF file.Returns a generic name for this data store, used mostly in warnings or error messages.open(StorageConnector connector) Returns aNetcdfStoreimplementation associated with this provider.probeContent(StorageConnector connector) Returns the MIME type if the given storage appears to be supported byNetcdfStore.Methods inherited from class DataStoreProvider
getFormat, getLogger, getSupportedVersions, open, probeContent
-
Constructor Details
-
NetcdfStoreProvider
public NetcdfStoreProvider()Creates a new provider.
-
-
Method Details
-
getShortName
Returns a generic name for this data store, used mostly in warnings or error messages.- Specified by:
getShortNamein classDataStoreProvider- Returns:
- a short name or abbreviation for the data format.
- See Also:
-
getOpenParameters
Returns a description of all parameters accepted by this provider for opening a netCDF file.- Specified by:
getOpenParametersin classDataStoreProvider- Returns:
- description of available parameters for opening a netCDF file.
- Since:
- 0.8
- See Also:
-
probeContent
Returns the MIME type if the given storage appears to be supported byNetcdfStore. 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:
probeContentin classDataStoreProvider- Parameters:
connector- information about the storage (URL, stream,NetcdfFileinstance, etc).- Returns:
- a supported status with the MIME type
if the given storage seems to be readable by
NetcdfStoreinstances. - Throws:
DataStoreException- if an I/O error occurred.
-
open
Returns aNetcdfStoreimplementation associated with this provider.- Specified by:
openin classDataStoreProvider- Parameters:
connector- information about the storage (URL, stream,NetcdfFileinstance, 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:
-