org.apache.sis.storage.netcdf

Class NetcdfStore

Object

DataStore

NetcdfStore

All Implemented Interfaces:

Localized

public class NetcdfStore
extends DataStore

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

Defined in the sis-netcdf module

Field Summary

Fields inherited from class DataStore

listeners

Constructor Summary

Constructors

Constructor and Description
Netcdf­Store(Storage­Connector storage) Creates a new NetCDF store from the given file, URL, stream or Netcdf­File object.

Method Summary

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

Methods inherited from class DataStore

add­Warning­Listener, get­Locale, remove­Warning­Listener, set­Locale

Methods inherited from class Object

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

Constructor Detail

NetcdfStore

public NetcdfStore(StorageConnector storage)
            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:

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

Throws:

Data­Store­Exception - 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:

get­Metadata in class Data­Store

Returns:

Information about the dataset.

Throws:

Data­Store­Exception - 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 class Data­Store

Throws:

Data­Store­Exception - 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:

to­String in class Object

Returns:

A string representation of this datastore for debugging purpose.