Class SimpleFeatureStore

Object

DataStore

SQLStore

SimpleFeatureStore

All Implemented Interfaces:

Auto­Closeable, Aggregate, Resource, Localized

public class SimpleFeatureStore
extends SQLStore

A concrete data store capable to read and write features from/to a spatial SQL database. All resources created by this class are Feature­Sets. The data are specified by two main arguments given at construction time:

• A Data­Source (specified indirectly) providing connections to the database. While not mandatory, a pooled data source is recommended because Simple­Feature­Store may open and close connections many times.
• A list of tables, views or queries to view as Feature­Sets. This list is provided by Resource­Definition objects. Only the main tables need to be specified. Dependencies inferred by foreigner keys will be followed automatically.

Despite the Simple­Feature­Store class name, this class supports complex features, i.e. features having associations to other features. The associations are discovered automatically by following the foreigner keys.

Since:

1.5

See Also:

• OGC Simple feature access - Part 2: SQL option

Nested Class Summary

Nested classes/interfaces inherited from interface Resource

Resource.File­Set

Modifier and Type	Interface	Description
static class	Resource.File­Set	Paths to the files potentially used by the enclosing resource.

Field Summary

Fields inherited from class SQLStore

content­Locale, source

Modifier and Type	Field	Description
protected final Locale	content­Locale	The locale to use for international texts to write in a database table.
protected final Data­Source	source	The data source to use for obtaining connections to the database.

Fields inherited from class DataStore

listeners, provider

Modifier and Type	Field	Description
protected final Store­Listeners	listeners	The set of registered Store­Listeners for this data store.
protected final Data­Store­Provider	provider	The factory that created this Data­Store instance, or null if unspecified.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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<Parameter­Value­Group>	get­Open­Parameters()	Returns parameters that can be used for opening this Simple Features data store.
protected Resource­Definition[]	read­Resource­Definitions(Data­Access dao)	Returns the resource definitions equivalent to the ones specified at construction time.

Methods inherited from class SQLStore

add­Listener, close, get­Database­Software­Versions, get­Data­Source, get­Identifier, get­Metadata, initialize, new­Data­Access, vacuum

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.
Map<String,Version>	get­Database­Software­Versions()	Returns the version of the database software, together with versions of extensions if any.
Data­Source	get­Data­Source()	Returns the data source to use for obtaining connections to the database.
Optional<Generic­Name>	get­Identifier()	Returns an identifier for the root resource of this SQL store, or an empty value if none.
Metadata	get­Metadata()	Returns information about the dataset as a whole.
protected void	initialize(Connection connection)	Invoked the first time that SQLStore opens a connection on the database, or after refresh.
Data­Access	new­Data­Access(boolean write)	Creates a new low-level data access object.
void	vacuum()	Executes the "VACUUM" statement on the database.

Methods inherited from class DataStore

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

Modifier and Type	Method	Description
String	get­Display­Name()	Returns a short name or label for this data store.
Locale	get­Locale()	The locale to use for formatting warnings and other messages.
Optional<Tree­Table>	get­Native­Metadata()	Returns implementation-specific metadata.
Data­Store­Provider	get­Provider()	Returns the factory that created this Data­Store instance.
<T extends Store­Event> void	remove­Listener(Class<T> event­Type, Store­Listener<? super T> listener)	Unregisters a listener previously added to this data store for the given type of events.
void	set­Locale(Locale locale)	Sets the locale to use for formatting warnings and other messages.
String	to­String()	Returns a string representation of this data store for debugging purpose.

Methods inherited from class Object

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

Methods inherited from interface Resource

get­File­Set

Modifier and Type	Method	Description
default Optional<Resource.File­Set>	get­File­Set()	Gets the paths to the files potentially used by this resource.

Constructor Details

SimpleFeatureStore

public SimpleFeatureStore(DataStoreProvider provider,
 StorageConnector connector,
 ResourceDefinition... resources)
                   throws DataStoreException

Creates a new Simple­Feature­Store 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, as 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.

Method Details

getOpenParameters

public Optional<ParameterValueGroup> getOpenParameters()

Returns parameters that can be used for opening this Simple Features data store. The parameters are described by SQLStore­Provider.get­Open­Parameters() and can contain some or all of the following:

• A parameter named "location" with a Data­Source value.
• SQLStore­Provider.TABLES_PARAM with Resource­Definitions specified at construction time for tables.
• SQLStore­Provider.QUERIES_PARAM with Resource­Definitions specified at construction time for queries.

Overrides:

get­Open­Parameters in class SQLStore

Returns:

parameters used for opening this data store.

See Also:

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

components

public Collection<FeatureSet> components()
                                  throws DataStoreException

Returns the tables (feature sets) in this SQL store. The collection contains only the tables matching a Resource­Definition given at construction time.

Specified by:

components in interface Aggregate

Overrides:

components in class SQLStore

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 shall match the name of one of the tables, views or queries inferred at construction time. It may be a table named explicitly at construction time, or a dependency inferred by following foreigner keys. The given identifier may be qualified with the schema name, or may be only the table name if there is no ambiguity.

Overrides:

find­Resource in class SQLStore

Parameters:

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

Returns:

resource associated with 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

readResourceDefinitions

protected ResourceDefinition[] readResourceDefinitions(DataAccess dao)

Returns the resource definitions equivalent to the ones specified at construction time. This method is defined for completness, but is not used by Simple­Feature­Store.

Specified by:

read­Resource­Definitions in class SQLStore

Parameters:

dao - ignored.

Returns:

tables or views to include in the store. Only the main tables need to be specified. Dependencies (inferred from the foreigner keys) will be followed automatically.

See Also:

• SQLStore.initialize(Connection)