xdev.util

Class AbstractDataSource<T extends DataSource>

java.lang.Object

xdev.util.AbstractDataSource<T>

All Implemented Interfaces:

DataSource<T>

Direct Known Subclasses:

AbstractDBDataSource

public abstract class AbstractDataSource<T extends DataSource>
extends Object
implements DataSource<T>

Nested Class Summary

Nested classes/interfaces inherited from interface xdev.util.DataSource

DataSource.Parameter<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectionConfiguration	connConfig
protected Map<String,DataSource.Parameter>	params

Constructor Summary

Constructors

Constructor and Description
AbstractDataSource()

Method Summary

Modifier and Type	Method and Description
DataSource.Parameter	getDefaultParameter(String name)
String	getName()
<P> DataSource.Parameter<P>	getParameter(DataSource.Parameter<P> template)
DataSource.Parameter	getParameter(String name)
DataSource.Parameter[]	getParameters()
<P> P	getParameterValue(DataSource.Parameter<P> template)
<P> P	getParameterValue(DataSource.Parameter<P> template, P defaultValue)
void	init(Class dbClass) Initialize DataSource.
void	init(String qualifiedName, String simpleName, String path) Initialize DataSource.
boolean	isParameterRequired(DataSource.Parameter p)
void	putParameter(DataSource.Parameter param)
<P> void	putParameter(DataSource.Parameter<P> param, P value)
void	putParameterValue(String name, Object value)
void	putParameterValue(String name, Object defaultValue, boolean overrideWithSystemProperty) Use default or get new parameters and set them for connecting to databases.
protected static void	rankParams(DataSource.Parameter... params) ranks the params in descending order
void	setName(String name) Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface xdev.util.DataSource

clearCaches, getDefaultParameters, getMetaData

Field Detail

params

protected final Map<String,DataSource.Parameter> params

connConfig

protected ConnectionConfiguration connConfig

Constructor Detail

AbstractDataSource

public AbstractDataSource()

Method Detail

init

public void init(Class dbClass)

Initialize DataSource. qualifiedName/SimpleName and default path is generated by the class instance. Default location will set to source folder of the given class.

Parameters:

dbClass - of the specific JDBCDataSource implementation

init

public void init(String qualifiedName,
                 String simpleName,
                 String path)

Initialize DataSource.

Parameters:

qualifiedName - of the specific JDBCDataSource implementation

simpleName - simple name of the specific JDBCDataSource implementation

path - default path to db config property file

setName

@Deprecated
public void setName(String name)

Deprecated.

getName

public String getName()

Specified by:

getName in interface DataSource<T extends DataSource>

putParameterValue

public void putParameterValue(String name,
                              Object defaultValue,
                              boolean overrideWithSystemProperty)

Use default or get new parameters and set them for connecting to databases.

Parameters:

name - of the parameter

defaultValue - value of the parameter

overrideWithSystemProperty - if true it will be checked whether there is the system argument "XDEV_DB_DBPROPERTYFILE" set or there is a property file in the default location (same folder like the class who is calling this methode)

putParameter

public <P> void putParameter(DataSource.Parameter<P> param,
                             P value)

putParameter

public void putParameter(DataSource.Parameter param)

Specified by:

putParameter in interface DataSource<T extends DataSource>

putParameterValue

public void putParameterValue(String name,
                              Object value)

getParameter

public DataSource.Parameter getParameter(String name)

Specified by:

getParameter in interface DataSource<T extends DataSource>

getParameters

public DataSource.Parameter[] getParameters()

Specified by:

getParameters in interface DataSource<T extends DataSource>

getParameter

public <P> DataSource.Parameter<P> getParameter(DataSource.Parameter<P> template)

getParameterValue

public <P> P getParameterValue(DataSource.Parameter<P> template)

Specified by:

getParameterValue in interface DataSource<T extends DataSource>

getParameterValue

public <P> P getParameterValue(DataSource.Parameter<P> template,
                               P defaultValue)

Specified by:

getParameterValue in interface DataSource<T extends DataSource>

isParameterRequired

public boolean isParameterRequired(DataSource.Parameter p)

Specified by:

isParameterRequired in interface DataSource<T extends DataSource>

Returns:

true if the parameter p is required, depending on the other parameters' values, false otherwise

getDefaultParameter

public DataSource.Parameter getDefaultParameter(String name)

Specified by:

getDefaultParameter in interface DataSource<T extends DataSource>

rankParams

protected static void rankParams(DataSource.Parameter... params)

ranks the params in descending order

Parameters:

params -