Package org.apache.sis.storage.netcdf

Class NetcdfStoreProvider

Object
DataStoreProvider
NetcdfStoreProvider
public class NetcdfStoreProvider extends DataStoreProvider
The provider of Netcdf­Store instances. Given a Storage­Connector input, this class tries to instantiate a Netcdf­Store 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 a Netcdf­Store backed by the UCAR library.

Thread safety

The same Netcdf­Store­Provider instance can be safely used by many threads without synchronization on the part of the caller. However the Netcdf­Store instances created by this factory are not thread-safe.
Since:
0.3
See Also:

Defined in the sis-netcdf module

  • Constructor Details

    • NetcdfStoreProvider

      public NetcdfStoreProvider()
      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:
      get­Short­Name in class Data­Store­Provider
      Returns:
      a short name or abbreviation for the data format.

    • getOpenParameters

      public ParameterDescriptorGroup getOpenParameters()
      Returns a description of all parameters accepted by this provider for opening a netCDF file.
      Specified by:
      get­Open­Parameters in class Data­Store­Provider
      Returns:
      description of available parameters for opening a netCDF file.
      Since:
      0.8

    • probeContent

      public ProbeResult probeContent(StorageConnector connector) throws DataStoreException
      Returns the MIME type if the given storage appears to be supported by Netcdf­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:
      probe­Content in class Data­Store­Provider
      Parameters:
      connector - information about the storage (URL, stream, Netcdf­File instance, etc).
      Returns:
      a supported status with the MIME type if the given storage seems to be readable by Netcdf­Store instances.
      Throws:
      Data­Store­Exception - if an I/O error occurred.

    • open

      public DataStore open(StorageConnector connector) throws DataStoreException
      Returns a Netcdf­Store implementation associated with this provider.
      Specified by:
      open in class Data­Store­Provider
      Parameters:
      connector - information about the storage (URL, stream, Netcdf­File instance, etc).
      Returns:
      a data store implementation associated with this provider for the given storage.
      Throws:
      Data­Store­Exception - if an error occurred while creating the data store instance.