Module org.apache.sis.storage.netcdf

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 cannot decode the given input and the UCAR library is reachable on the module path, 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:

• Netcdf­Store

Nested Class Summary

Nested classes/interfaces inherited from class DataStoreProvider

Data­Store­Provider.Prober<S>

Field Summary

Fields inherited from class DataStoreProvider

CREATE, LOCATION

Constructor Summary

Constructors

Constructor	Description
Netcdf­Store­Provider()	Creates a new provider.

Method Summary

Modifier and Type	Method	Description
Logger	get­Logger()	Returns the logger used by netCDF stores.
Parameter­Descriptor­Group	get­Open­Parameters()	Returns a description of all parameters accepted by this provider for opening a netCDF file.
String	get­Short­Name()	Returns a generic name for this data store, used mostly in warnings or error messages.
Data­Store	open(Storage­Connector connector)	Returns a Netcdf­Store implementation associated with this provider.
Probe­Result	probe­Content(Storage­Connector connector)	Returns the MIME type if the given storage appears to be supported by Netcdf­Store.

Methods inherited from class DataStoreProvider

get­Format, get­Supported­Versions, open, probe­Content

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

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.

See Also:

• Data­Store­Provider.get­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

See Also:

• Data­Store­Provider.LOCATION
• Data­Store­Provider.CREATE
• Data­Store­Provider.open(Parameter­Value­Group)
• Data­Store.get­Open­Parameters()

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.

See Also:

• Data­Stores.open(Object)

getLogger

public Logger getLogger()

Returns the logger used by netCDF stores..

Overrides:

get­Logger in class Data­Store­Provider

Returns:

the logger used by netCDF stores

See Also:

• Store­Listeners.get­Logger()