Module org.apache.sis.storage.netcdf

Package org.apache.sis.storage.netcdf

Class NetcdfStore

Object

DataStore

NetcdfStore

All Implemented Interfaces:

Auto­Closeable, Aggregate, Resource, Localized

public class NetcdfStore
extends DataStore
implements Aggregate

A data store backed by netCDF files. Instances of this data store are created by Netcdf­Store­Provider.open(Storage­Connector).

Since:

0.3

See Also:

• Netcdf­Store­Provider

Field Summary

Fields inherited from class DataStore

listeners, provider

Constructor Summary

Constructors

Constructor	Description
Netcdf­Store(Netcdf­Store­Provider provider, Storage­Connector connector)	Creates a new netCDF store from the given file, URL, stream or Netcdf­File object.

Method Summary

Modifier and Type	Method	Description
<T extends Store­Event> void	add­Listener(Class<T> event­Type, Store­Listener<? super T> listener)	Registers a listener to notify when the specified kind of event occurs in this data store.
void	close()	Closes this netCDF store and releases any underlying resources.
Collection<Resource>	components()	Returns the resources (features or coverages) in this netCDF store.
Version	get­Convention­Version()	Returns the version number of the Climate and Forecast (CF) conventions used in the netCDF file.
Optional<Generic­Name>	get­Identifier()	Returns an identifier constructed from global attributes or the filename of the netCDF file.
Metadata	get­Metadata()	Returns information about the dataset as a whole.
Optional<Tree­Table>	get­Native­Metadata()	Returns netCDF attributes.
Optional<Parameter­Value­Group>	get­Open­Parameters()	Returns the parameters used to open this netCDF data store.
String	to­String()	Returns a string representation of this netCDF store for debugging purpose.

Methods inherited from class DataStore

find­Resource, get­Display­Name, get­Locale, get­Provider, remove­Listener, set­Locale

Methods inherited from class Object

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

Methods inherited from interface Resource

remove­Listener

Constructor Details

NetcdfStore

public NetcdfStore(NetcdfStoreProvider provider,
 StorageConnector connector)
            throws DataStoreException

Creates a new netCDF store from the given file, URL, stream or Netcdf­File object. This constructor invokes Storage­Connector.close­All­Except(Object), keeping open only the needed resource.

Parameters:

provider - the factory that created this Data­Store instance, or null if unspecified.

connector - information about the storage (URL, stream, Netcdf­File instance, etc).

Throws:

Data­Store­Exception - if an error occurred while opening the netCDF file.

Since:

0.8

Method Details

getOpenParameters

public Optional<ParameterValueGroup> getOpenParameters()

Returns the parameters used to open this netCDF data store. If non-null, the parameters are described by Netcdf­Store­Provider.get­Open­Parameters() and contains at least a parameter named "location" with a URI value. This method may return null if the storage input cannot be described by a URI (for example a netCDF file reading directly from a Readable­Byte­Channel).

Specified by:

get­Open­Parameters in class Data­Store

Returns:

parameters used for opening this data store.

Since:

0.8

See Also:

• Data­Store­Provider.get­Open­Parameters()

getConventionVersion

public Version getConventionVersion()
                             throws DataStoreException

Returns the version number of the Climate and Forecast (CF) conventions used in the netCDF file. The use of CF convention is mandated by the OGC 11-165r2 standard (CF-netCDF3 Data Model Extension standard).

Returns:

CF-convention version, or null if no information about CF convention has been found.

Throws:

Data­Store­Exception - if an error occurred while reading the data.

Since:

0.8

getIdentifier

public Optional<GenericName> getIdentifier()
                                    throws DataStoreException

Returns an identifier constructed from global attributes or the filename of the netCDF file.

Specified by:

get­Identifier in interface Resource

Overrides:

get­Identifier in class Data­Store

Returns:

the identifier fetched from global attributes or the filename. May be absent.

Throws:

Data­Store­Exception - if an error occurred while fetching the identifier.

Since:

1.0

See Also:

• Data­Store.get­Metadata()
• Data­Store.get­Display­Name()

getMetadata

public Metadata getMetadata()
                     throws DataStoreException

Returns information about the dataset as a whole. The returned metadata object can contain information such as the spatiotemporal extent of the dataset, contact information about the creator or distributor, data quality, usage constraints and more.

Specified by:

get­Metadata in interface Resource

Specified by:

get­Metadata in class Data­Store

Returns:

information about the dataset.

Throws:

Data­Store­Exception - if an error occurred while reading the data.

See Also:

• Data­Store.get­Identifier()
• Default­Metadata.deep­Copy(Metadata)

getNativeMetadata

public Optional<TreeTable> getNativeMetadata()
                                      throws DataStoreException

Returns netCDF attributes. The meaning of those attributes may vary depending on data provider. The standard metadata should be preferred since they allow abstraction of data format details, but those native metadata are sometimes useful when an information is not provided by the standard metadata.

Overrides:

get­Native­Metadata in class Data­Store

Returns:

resources information structured in an implementation-specific way.

Throws:

Data­Store­Exception - if an error occurred while reading the metadata.

Since:

1.1

components

public Collection<Resource> components()
                                throws DataStoreException

Returns the resources (features or coverages) in this netCDF store.

Specified by:

components in interface Aggregate

Returns:

children resources that are components of this netCDF store.

Throws:

Data­Store­Exception - if an error occurred while fetching the components.

Since:

0.8

addListener

public <T extends StoreEvent> void addListener(Class<T> eventType,
 StoreListener<? super T> listener)

Registers a listener to notify when the specified kind of event occurs in this data store. The current implementation of this data store can emit only Warning­Events; any listener specified for another kind of events will be ignored.

Specified by:

add­Listener in interface Resource

Overrides:

add­Listener in class Data­Store

Type Parameters:

T - compile-time value of the event­Type argument.

Parameters:

event­Type - type of Store­Event to listen (cannot be null).

listener - listener to notify about events.

close

public void close()
           throws DataStoreException

Closes this netCDF store and releases any underlying resources. This method can be invoked asynchronously for interrupting a long reading process.

Specified by:

close in interface Auto­Closeable

Specified by:

close in class Data­Store

Throws:

Data­Store­Exception - if an error occurred while closing the netCDF file.

See Also:

• Store­Listeners.close()

toString

public String toString()

Returns a string representation of this netCDF store for debugging purpose. The content of the string returned by this method may change in any future SIS version.

Overrides:

to­String in class Data­Store

Returns:

a string representation of this data store for debugging purpose.