Package org.apache.sis.storage.netcdf
Class NetcdfStore
- All Implemented Interfaces:
- AutoCloseable,- Aggregate,- Resource,- Localized
A data store backed by netCDF files.
 Instances of this data store are created by 
NetcdfStoreProvider.open(StorageConnector).- Since:
- 0.3
- See Also:
Defined in the sis-netcdf module
- 
Field Summary
- 
Constructor SummaryConstructorsConstructorDescriptionNetcdfStore(NetcdfStoreProvider provider, StorageConnector connector) Creates a new netCDF store from the given file, URL, stream orNetcdfFileobject.
- 
Method SummaryModifier and TypeMethodDescription<T extends StoreEvent>
 voidaddListener(Class<T> eventType, StoreListener<? super T> listener) Registers a listener to notify when the specified kind of event occurs in this data store.voidclose()Closes this netCDF store and releases any underlying resources.Returns the resources (features or coverages) in this netCDF store.Returns the version number of the Climate and Forecast (CF) conventions used in the netCDF file.Returns an identifier constructed from global attributes or the filename of the netCDF file.Returns information about the dataset as a whole.Returns netCDF attributes.Returns the parameters used to open this netCDF data store.Returns a string representation of this netCDF store for debugging purpose.Methods inherited from class DataStorefindResource, getDisplayName, getLocale, getProvider, removeListener, setLocaleMethods inherited from class Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface ResourceremoveListener
- 
Constructor Details- 
NetcdfStorepublic NetcdfStore(NetcdfStoreProvider provider, StorageConnector connector) throws DataStoreException Creates a new netCDF store from the given file, URL, stream orNetcdfFileobject. This constructor invokesStorageConnector.closeAllExcept(Object), keeping open only the needed resource.- Parameters:
- provider- the factory that created this- DataStoreinstance, or- nullif unspecified.
- connector- information about the storage (URL, stream,- NetcdfFileinstance, etc).
- Throws:
- DataStoreException- if an error occurred while opening the netCDF file.
- Since:
- 0.8
 
 
- 
- 
Method Details- 
getOpenParametersReturns the parameters used to open this netCDF data store. If non-null, the parameters are described byNetcdfStoreProvider.getOpenParameters()and contains at least a parameter named "location" with aURIvalue. This method may returnnullif the storage input cannot be described by a URI (for example a netCDF file reading directly from aReadableByteChannel).- Specified by:
- getOpenParametersin class- DataStore
- Returns:
- parameters used for opening this data store.
- Since:
- 0.8
- See Also:
 
- 
getConventionVersionReturns 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 nullif no information about CF convention has been found.
- Throws:
- DataStoreException- if an error occurred while reading the data.
- Since:
- 0.8
 
- 
getIdentifierReturns an identifier constructed from global attributes or the filename of the netCDF file.- Specified by:
- getIdentifierin interface- Resource
- Overrides:
- getIdentifierin class- DataStore
- Returns:
- the identifier fetched from global attributes or the filename. May be absent.
- Throws:
- DataStoreException- if an error occurred while fetching the identifier.
- Since:
- 1.0
- See Also:
 
- 
getMetadataReturns 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:
- getMetadatain interface- Resource
- Specified by:
- getMetadatain class- DataStore
- Returns:
- information about the dataset.
- Throws:
- DataStoreException- if an error occurred while reading the data.
- See Also:
 
- 
getNativeMetadataReturns 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:
- getNativeMetadatain class- DataStore
- Returns:
- resources information structured in an implementation-specific way.
- Throws:
- DataStoreException- if an error occurred while reading the metadata.
- Since:
- 1.1
 
- 
componentsReturns the resources (features or coverages) in this netCDF store.- Specified by:
- componentsin interface- Aggregate
- Returns:
- children resources that are components of this netCDF store.
- Throws:
- DataStoreException- if an error occurred while fetching the components.
- Since:
- 0.8
 
- 
addListenerpublic <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 onlyWarningEvents; any listener specified for another kind of events will be ignored.- Specified by:
- addListenerin interface- Resource
- Overrides:
- addListenerin class- DataStore
- Type Parameters:
- T- compile-time value of the- eventTypeargument.
- Parameters:
- eventType- type of- StoreEventto listen (cannot be- null).
- listener- listener to notify about events.
 
- 
closeCloses this netCDF store and releases any underlying resources.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein class- DataStore
- Throws:
- DataStoreException- if an error occurred while closing the netCDF file.
- See Also:
 
- 
toStringReturns 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:
- toStringin class- DataStore
- Returns:
- a string representation of this data store for debugging purpose.
 
 
-