org.apache.sis.storage.netcdf

Class NetcdfStore

Object

DataStore

NetcdfStore

All Implemented Interfaces:

AutoCloseable, Localized

public class NetcdfStore
extends DataStore

A data store backed by NetCDF files. Instances of this data store are created by NetcdfStoreProvider.open(StorageConnector).

Since:

0.3

See Also:

NetcdfStoreProvider

Defined in the sis-netcdf module

Field Summary

Fields inherited from class DataStore

listeners

Constructor Summary

Constructors

Constructor and Description
NetcdfStore(StorageConnector storage) Creates a new NetCDF store from the given file, URL, stream or NetcdfFile object.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this NetCDF store and releases any underlying resources.
Metadata	getMetadata() Returns information about the dataset as a whole.
String	toString() Returns a string representation of this NetCDF store for debugging purpose.

Methods inherited from class DataStore

addWarningListener, getLocale, removeWarningListener, setLocale

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NetcdfStore

public NetcdfStore(StorageConnector storage)
            throws DataStoreException

Creates a new NetCDF store from the given file, URL, stream or NetcdfFile object. This constructor invokes StorageConnector.closeAllExcept(Object), keeping open only the needed resource.

Parameters:

storage - Information about the storage (URL, stream, NetcdfFile instance, etc).

Throws:

DataStoreException - If an error occurred while opening the NetCDF file.

Method Detail

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:

getMetadata in class DataStore

Returns:

Information about the dataset.

Throws:

DataStoreException - If an error occurred while reading the data.

close

public void close()
           throws DataStoreException

Closes this NetCDF store and releases any underlying resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in class DataStore

Throws:

DataStoreException - If an error occurred while closing the NetCDF file.

toString

@Debug
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:

toString in class Object

Returns:

A string representation of this datastore for debugging purpose.