xdev.util

Interface DataSource<T extends DataSource>

All Known Subinterfaces:

DBDataSource<T>

All Known Implementing Classes:

AbstractDataSource, AbstractDBDataSource, JDBCDataSource, NullDBDataSource, ServletDBDataSource

public interface DataSource<T extends DataSource>

Base type of all data sources like DBMs, plain files or any other arbitrary data source.

Author:

XDEV Software Corp.

See Also:

DBDataSource

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataSource.Parameter<T>

Method Summary

Modifier and Type	Method and Description
void	clearCaches() Clears all caches of this data source.
DataSource.Parameter	getDefaultParameter(String name)
DataSource.Parameter[]	getDefaultParameters()
DataSourceMetaData	getMetaData()
String	getName()
DataSource.Parameter	getParameter(String name)
DataSource.Parameter[]	getParameters()
<P> P	getParameterValue(DataSource.Parameter<P> template)
<P> P	getParameterValue(DataSource.Parameter<P> template, P defaultValue)
boolean	isParameterRequired(DataSource.Parameter p)
void	putParameter(DataSource.Parameter param)

Method Detail

getName

String getName()

putParameter

void putParameter(DataSource.Parameter param)

getParameter

DataSource.Parameter getParameter(String name)

getParameters

DataSource.Parameter[] getParameters()

getDefaultParameters

DataSource.Parameter[] getDefaultParameters()

getDefaultParameter

DataSource.Parameter getDefaultParameter(String name)

getParameterValue

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

getParameterValue

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

isParameterRequired

boolean isParameterRequired(DataSource.Parameter p)

Parameters:

p -

Returns:

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

getMetaData

DataSourceMetaData getMetaData()
                        throws DataSourceException

Throws:

DataSourceException

clearCaches

void clearCaches()

Clears all caches of this data source.

This method should be called after a parameter's value is changed if the data source has been used before.