org.apache.sis.storage

Class DataStore

Object

DataStore

All Implemented Interfaces:

AutoCloseable, Localized

public abstract class DataStore
extends Object
implements Localized, AutoCloseable

Manages a series of features, coverages or sensor data.

Thread safety policy

This DataStore base class is thread-safe. However subclasses are usually not. Unless otherwise specified by subclasses, users should assume that DataStore instances are not thread-safe.

Since:

0.3

See Also:

DataStores.open(Object)

Defined in the sis-storage module

Field Summary

Fields

Modifier and Type	Field and Description
protected WarningListeners<DataStore>	listeners The set of registered WarningListeners for this data store.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataStore() Creates a new instance with initially no listener.

Method Summary

Methods

Modifier and Type	Method and Description
void	addWarningListener(WarningListener<? super DataStore> listener) Adds a listener to be notified when a warning occurred while reading from or writing to the storage.
abstract void	close() Closes this data store and releases any underlying resources.
Locale	getLocale() The locale to use for formatting warnings and other messages.
abstract Metadata	getMetadata() Returns information about the dataset as a whole.
void	removeWarningListener(WarningListener<? super DataStore> listener) Removes a previously registered listener.
void	setLocale(Locale locale) Sets the locale to use for formatting warnings and other messages.

Methods inherited from class Object

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

Field Detail

listeners

protected final WarningListeners<DataStore> listeners

The set of registered WarningListeners for this data store.

Constructor Detail

DataStore

protected DataStore()

Creates a new instance with initially no listener.

Method Detail

getLocale

public Locale getLocale()

The locale to use for formatting warnings and other messages. This locale if for user interfaces only - it has no effect on the data to be read or written from/to the data store.

The default value is the system default locale.

Specified by:

getLocale in interface Localized

setLocale

public void setLocale(Locale locale)

Sets the locale to use for formatting warnings and other messages.

Parameters:

locale - The new locale to use.

getMetadata

public abstract Metadata getMetadata()
                              throws DataStoreException

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

Returns:

Information about the dataset, or null if none.

Throws:

DataStoreException - If an error occurred while reading the data.

addWarningListener

public void addWarningListener(WarningListener<? super DataStore> listener)
                        throws IllegalArgumentException

Adds a listener to be notified when a warning occurred while reading from or writing to the storage. When a warning occurs, there is a choice:

• If this data store has no warning listener, then the warning is logged at Level.WARNING.
• If this data store has at least one warning listener, then all listeners are notified and the warning is not logged by this data store instance.

Consider invoking this method in a try … finally block if the DataStore lifetime is longer than the listener lifetime, as below:

datastore.addWarningListener(listener);
try {
    // Do some work...
} finally {
    datastore.removeWarningListener(listener);
}

Parameters:

listener - The listener to add.

Throws:

IllegalArgumentException - If the given listener is already registered in this data store.

removeWarningListener

public void removeWarningListener(WarningListener<? super DataStore> listener)
                           throws NoSuchElementException

Removes a previously registered listener.

Parameters:

listener - The listener to remove.

Throws:

NoSuchElementException - If the given listener is not registered in this data store.

close

public abstract void close()
                    throws DataStoreException

Closes this data store and releases any underlying resources.

Specified by:

close in interface AutoCloseable

Throws:

DataStoreException - If an error occurred while closing this data store.