Module org.apache.sis.storage.sql

Package org.apache.sis.storage.sql

Class SQLStore

Object

DataStore

SQLStore

All Implemented Interfaces:

Auto­Closeable, Aggregate, Resource, Localized

public class SQLStore
extends DataStore
implements Aggregate

A data store capable to read and create features from a spatial database. SQLStore requires a Data­Source to be specified (indirectly) at construction time. The Data­Source should provide pooled connections, because SQLStore will frequently opens and closes them.

Since:

1.0

Field Summary

Fields inherited from class DataStore

listeners, provider

Constructor Summary

Constructors

Constructor	Description
SQLStore(SQLStore­Provider provider, Storage­Connector connector, Resource­Definition... resources)	Creates a new SQLStore for the given data source and tables, views or queries.

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 SQL store and releases any underlying resources.
Collection<Feature­Set>	components()	Returns the tables (feature sets) in this SQL store.
Feature­Set	find­Resource(String identifier)	Searches for a resource identified by the given identifier.
Optional<Generic­Name>	get­Identifier()	SQL data store root resource has no identifier.
Metadata	get­Metadata()	Returns information about the dataset as a whole.
Optional<Parameter­Value­Group>	get­Open­Parameters()	Returns the parameters used to open this netCDF data store.

Methods inherited from class DataStore

get­Display­Name, get­Locale, get­Native­Metadata, get­Provider, remove­Listener, set­Locale, to­String

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

SQLStore

public SQLStore(SQLStoreProvider provider,
 StorageConnector connector,
 ResourceDefinition... resources)
         throws DataStoreException

Creates a new SQLStore for the given data source and tables, views or queries. The given connector shall contain a Data­Source instance. Tables or views to include in the store are specified by the resources argument. Only the main tables need to be specified; dependencies will be followed automatically.

Parameters:

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

connector - information about the storage (JDBC data source, etc).

resources - tables, views or queries to include in this store.

Throws:

Data­Store­Exception - if an error occurred while creating the data store for the given storage.

Since:

1.1

Method Details

getOpenParameters

public Optional<ParameterValueGroup> getOpenParameters()

Returns the parameters used to open this netCDF data store. The parameters are described by SQLStore­Provider.get­Open­Parameters() and contains at least a parameter named "location" with a Data­Source value.

Specified by:

get­Open­Parameters in class Data­Store

Returns:

parameters used for opening this data store.

See Also:

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

getIdentifier

public Optional<GenericName> getIdentifier()
                                    throws DataStoreException

SQL data store root resource has no identifier.

Specified by:

get­Identifier in interface Resource

Overrides:

get­Identifier in class Data­Store

Returns:

empty.

Throws:

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

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 list of feature types.

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)

components

public Collection<FeatureSet> components()
                                  throws DataStoreException

Returns the tables (feature sets) in this SQL store. The list contains only the tables explicitly named at construction time.

Specified by:

components in interface Aggregate

Returns:

children resources that are components of this SQL store.

Throws:

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

findResource

public FeatureSet findResource(String identifier)
                        throws DataStoreException

Searches for a resource identified by the given identifier. The given identifier should match one of the table names. It may be one of the tables named at construction time, or one of the dependencies. The given name may be qualified with the schema name, or may be only the table name if there is no ambiguity.

Overrides:

find­Resource in class Data­Store

Parameters:

identifier - identifier of the resource to fetch. Must be non-null.

Returns:

resource associated to the given identifier (never null).

Throws:

Illegal­Name­Exception - if no resource is found for the given identifier, or if more than one resource is found.

Data­Store­Exception - if another kind of error occurred while searching resources.

See Also:

• Resource.get­Identifier()
• Feature­Naming

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 SQL store and releases any underlying resources.

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 SQL store.

See Also:

• Store­Listeners.close()