Module org.apache.sis.storage.sql

Package org.apache.sis.storage.sql

Class SQLStoreProvider

Object

DataStoreProvider

SQLStoreProvider

public class SQLStoreProvider
extends DataStoreProvider

Provider of SQLStore instances.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from class DataStoreProvider

Data­Store­Provider.Prober<S>

Field Summary

Fields

Modifier and Type	Field	Description
static final Parameter­Descriptor<Map>	QUERIES_PARAM	Description of the parameter providing the queries to include as resources in the SQLStore.
static final Parameter­Descriptor<Data­Source>	SOURCE_PARAM	Description of the "location" parameter.
static final Parameter­Descriptor<Generic­Name[]>	TABLES_PARAM	Description of the parameter providing the list of tables or views to include as resources in the SQLStore.

Fields inherited from class DataStoreProvider

CREATE, LOCATION

Constructor Summary

Constructors

Constructor	Description
SQLStore­Provider()	Creates a new provider.

Method Summary

Modifier and Type	Method	Description
static Generic­Name	create­Table­Name(String catalog, String schema­Pattern, String table­Pattern)	Create a qualified table name.
Logger	get­Logger()	Returns the logger used by SQL stores.
Parameter­Descriptor­Group	get­Open­Parameters()	Returns a description of all parameters accepted by this provider for opening a connection to the database.
String	get­Short­Name()	Returns a generic name for this data store, used mostly in warnings or error messages.
Data­Store	open(Storage­Connector connector)	Returns a SQLStore implementation associated with this provider.
Data­Store	open(Parameter­Value­Group parameters)	Returns a data store implementation associated with this provider for the given parameters.
Probe­Result	probe­Content(Storage­Connector connector)	Returns Probe­Result.SUPPORTED if the given storage appears to be supported by SQLStore.

Methods inherited from class DataStoreProvider

get­Format, get­Supported­Versions, probe­Content

Methods inherited from class Object

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

Field Details

SOURCE_PARAM

public static final ParameterDescriptor<DataSource> SOURCE_PARAM

Description of the "location" parameter. This parameter is mandatory.

Since:

1.1

TABLES_PARAM

public static final ParameterDescriptor<GenericName[]> TABLES_PARAM

Description of the parameter providing the list of tables or views to include as resources in the SQLStore. At least one of TABLES_PARAM or QUERIES_PARAM must be provided.

Since:

1.1

QUERIES_PARAM

public static final ParameterDescriptor<Map> QUERIES_PARAM

Description of the parameter providing the queries to include as resources in the SQLStore. Map keys are the resource names as Generic­Name or String instances. Values are SQL statements (as String instances) to execute when the associated resource is requested. At least one of TABLES_PARAM or QUERIES_PARAM must be provided.

Since:

1.1

Constructor Details

SQLStoreProvider

public SQLStoreProvider()

Creates a new provider.

Method Details

createTableName

public static GenericName createTableName(String catalog,
 String schemaPattern,
 String tablePattern)

Create a qualified table name. The returned Generic­Name can be any of the following:

• catalog.schema­Pattern.table­Pattern
• schema­Pattern.table­Pattern
• table­Pattern

The schema and table names (but not the catalog) can contain SQL wildcard characters: '_' matches any single character and '%' matches any sequence of characters.

Parameters:

catalog - name of a catalog as it is stored in the database, or null for any catalog.

schema­Pattern - pattern (with '_' and '%' wildcards) of a schema, or null for any.

table­Pattern - pattern (with '_' and '%' wildcards) of a table.

Returns:

the fully qualified name.

getShortName

public String getShortName()

Returns a generic name for this data store, used mostly in warnings or error messages.

Specified by:

get­Short­Name in class Data­Store­Provider

Returns:

a short name or abbreviation for the data format.

See Also:

• Data­Store­Provider.get­Format()

getOpenParameters

public ParameterDescriptorGroup getOpenParameters()

Returns a description of all parameters accepted by this provider for opening a connection to the database. The group contains SOURCE_PARAM, TABLES_PARAM and QUERIES_PARAM.

Specified by:

get­Open­Parameters in class Data­Store­Provider

Returns:

description of available parameters for opening a connection to a database.

See Also:

• Data­Store­Provider.LOCATION
• Data­Store­Provider.CREATE
• Data­Store­Provider.open(Parameter­Value­Group)
• Data­Store.get­Open­Parameters()

probeContent

public ProbeResult probeContent(StorageConnector connector)
                         throws DataStoreException

Returns Probe­Result.SUPPORTED if the given storage appears to be supported by SQLStore. Returning SUPPORTED from this method does not guarantee that reading or writing will succeed, only that there appears to be a reasonable chance of success based on a brief inspection of the connection.

Specified by:

probe­Content in class Data­Store­Provider

Parameters:

connector - information about the storage (data source).

Returns:

SUPPORTED if the given storage seems to be usable by SQLStore instances.

Throws:

Data­Store­Exception - if an SQL error occurred.

open

public DataStore open(StorageConnector connector)
               throws DataStoreException

Returns a SQLStore implementation associated with this provider. The store will provide resources for all tables and views in all schemas and catalogs.

Specified by:

open in class Data­Store­Provider

Parameters:

connector - information about the storage (data source).

Returns:

a data store implementation associated with this provider for the given storage.

Throws:

Data­Store­Exception - if an error occurred while creating the data store instance.

See Also:

• Data­Stores.open(Object)

open

public DataStore open(ParameterValueGroup parameters)
               throws DataStoreException

Returns a data store implementation associated with this provider for the given parameters.

Overrides:

open in class Data­Store­Provider

Parameters:

parameters - opening parameters as defined by get­Open­Parameters().

Returns:

a data store implementation associated with this provider for the given parameters.

Throws:

Data­Store­Exception - if an error occurred while creating the data store instance.

See Also:

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

getLogger

public Logger getLogger()

Returns the logger used by SQL stores..

Overrides:

get­Logger in class Data­Store­Provider

Returns:

the logger used by SQL stores

See Also:

• Store­Listeners.get­Logger()