org.diirt.datasource

Class ConfigurableDataSourceProvider<D extends DataSource,C extends DataSourceConfiguration<D>>

java.lang.Object

org.diirt.datasource.DataSourceProvider

org.diirt.datasource.ConfigurableDataSourceProvider<D,C>

Type Parameters:

D - the data source created by the provider

C - the configuration loaded by the provider

Direct Known Subclasses:

FileDataSourceProvider, JCADataSourceProvider, WebPodsDataSourceProvider

public abstract class ConfigurableDataSourceProvider<D extends DataSource,C extends DataSourceConfiguration<D>>
extends DataSourceProvider

DataSourceProvider for a data source that require configuration.

Author:

carcassi

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<C>	clazz

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurableDataSourceProvider(Class<C> clazz) Create a new configurable data source provider.

Method Summary

Modifier and Type	Method and Description
D	createInstance() Creates the instance by reading the configuration file and creating the data source from the configuration.
String	getBundledDefaultConfiguration() The name of the bundled resource with the default configuration file.
String	getConfigurationFilename() The name of the configuration file.
String	getConfigurationPath() The path from DIIRT_HOME where to find the configuration file.

Methods inherited from class org.diirt.datasource.DataSourceProvider

createDataSource, getName

Methods inherited from class java.lang.Object

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

Field Detail

clazz

protected Class<C extends DataSourceConfiguration<D>> clazz

Constructor Detail

ConfigurableDataSourceProvider

protected ConfigurableDataSourceProvider(Class<C> clazz)

Create a new configurable data source provider.

Parameters:

clazz - the class token for the configuration object

Method Detail

getConfigurationPath

public String getConfigurationPath()

The path from DIIRT_HOME where to find the configuration file.

Default is "datasource/[providerName]".

Returns:

the path to the configuration directory for the data source

getConfigurationFilename

public String getConfigurationFilename()

The name of the configuration file.

Default is "[providerName].xml"

Returns:

the data source configuration filename

getBundledDefaultConfiguration

public String getBundledDefaultConfiguration()

The name of the bundled resource with the default configuration file. This is used by the framework to initialize the configuration file in the directory. It must be bundled in the same package of the provider.

Returns:

createInstance

public D createInstance()

Creates the instance by reading the configuration file and creating the data source from the configuration.

Specified by:

createInstance in class DataSourceProvider

Returns:

a new data source