Object
DataStoreProvider
SQLStoreProvider
Provider of
SQLStore instances.- Since:
- 1.0
-
Nested Class Summary
Nested classes/interfaces inherited from class DataStoreProvider
DataStoreProvider.Prober<S> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ParameterDescriptor<Map> Description of the parameter providing the queries to include as resources in theSQLStore.static final ParameterDescriptor<DataSource> Description of the "location" parameter.static final ParameterDescriptor<GenericName[]> Description of the parameter providing the list of tables or views to include as resources in theSQLStore.Fields inherited from class DataStoreProvider
CREATE, LOCATION -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic GenericNamecreateTableName(String catalog, String schemaPattern, String tablePattern) Create a qualified table name.Returns the logger used by SQL stores.Returns a description of all parameters accepted by this provider for opening a connection to the database.Returns a generic name for this data store, used mostly in warnings or error messages.open(StorageConnector connector) Returns aSQLStoreimplementation associated with this provider.open(ParameterValueGroup parameters) Returns a data store implementation associated with this provider for the given parameters.probeContent(StorageConnector connector) ReturnsProbeResult.SUPPORTEDif the given storage appears to be supported bySQLStore.Methods inherited from class DataStoreProvider
getFormat, getSupportedVersions, probeContent
-
Field Details
-
SOURCE_PARAM
Description of the "location" parameter. This parameter is mandatory.- Since:
- 1.1
-
TABLES_PARAM
Description of the parameter providing the list of tables or views to include as resources in theSQLStore. At least one ofTABLES_PARAMorQUERIES_PARAMmust be provided.- Since:
- 1.1
-
QUERIES_PARAM
Description of the parameter providing the queries to include as resources in theSQLStore. Map keys are the resource names asGenericNameorStringinstances. Values are SQL statements (asStringinstances) to execute when the associated resource is requested. At least one ofTABLES_PARAMorQUERIES_PARAMmust 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 returnedGenericNamecan be any of the following:catalog.schemaPattern.tablePatternschemaPattern.tablePatterntablePattern
'_'matches any single character and'%'matches any sequence of characters.- Parameters:
catalog- name of a catalog as it is stored in the database, ornullfor any catalog.schemaPattern- pattern (with'_'and'%'wildcards) of a schema, ornullfor any.tablePattern- pattern (with'_'and'%'wildcards) of a table.- Returns:
- the fully qualified name.
-
getShortName
Returns a generic name for this data store, used mostly in warnings or error messages.- Specified by:
getShortNamein classDataStoreProvider- Returns:
- a short name or abbreviation for the data format.
- See Also:
-
getOpenParameters
Returns a description of all parameters accepted by this provider for opening a connection to the database. The group containsSOURCE_PARAM,TABLES_PARAMandQUERIES_PARAM.- Specified by:
getOpenParametersin classDataStoreProvider- Returns:
- description of available parameters for opening a connection to a database.
- See Also:
-
probeContent
ReturnsProbeResult.SUPPORTEDif the given storage appears to be supported bySQLStore. ReturningSUPPORTEDfrom 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:
probeContentin classDataStoreProvider- Parameters:
connector- information about the storage (data source).- Returns:
SUPPORTEDif the given storage seems to be usable bySQLStoreinstances.- Throws:
DataStoreException- if an SQL error occurred.
-
open
Returns aSQLStoreimplementation associated with this provider. The store will provide resources for all tables and views in all schemas and catalogs.- Specified by:
openin classDataStoreProvider- Parameters:
connector- information about the storage (data source).- Returns:
- a data store implementation associated with this provider for the given storage.
- Throws:
DataStoreException- if an error occurred while creating the data store instance.- See Also:
-
open
Returns a data store implementation associated with this provider for the given parameters.- Overrides:
openin classDataStoreProvider- Parameters:
parameters- opening parameters as defined bygetOpenParameters().- Returns:
- a data store implementation associated with this provider for the given parameters.
- Throws:
DataStoreException- if an error occurred while creating the data store instance.- See Also:
-
getLogger
Returns the logger used by SQL stores..- Overrides:
getLoggerin classDataStoreProvider- Returns:
- the logger used by SQL stores
- See Also:
-