org.dashbuilder.dataprovider.sql

Class SQLDataSetProvider

java.lang.Object

org.dashbuilder.dataprovider.sql.SQLDataSetProvider

All Implemented Interfaces:

DataSetProvider, DataSetDefRegistryListener

public class SQLDataSetProvider
extends Object
implements DataSetProvider, DataSetDefRegistryListener

DataSetProvider implementation for JDBC-compliant data sources.

The SQL provider resolves every data set lookup request by transforming such request into the proper SQL query. In some cases, an extra processing of the resulting data is required since some lookup requests do not map directly into the SQL world. In such cases, specially the grouping of date based data, the core data set operation engine is used.

Pending stuff: - Filter on foreign data sets - Group (fixed) by date of week

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SQLDataSetProvider.MetadataHolder

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,SQLDataSetProvider.MetadataHolder>	_metadataMap
protected SQLDataSourceLocator	dataSourceLocator
protected IntervalBuilderDynamicDate	intervalBuilderDynamicDate
protected IntervalBuilderLocator	intervalBuilderLocator
protected org.slf4j.Logger	log
protected DataSetOpEngine	opEngine
protected StaticDataSetProvider	staticDataSetProvider

Constructor Summary

Constructors

Constructor and Description
SQLDataSetProvider()
SQLDataSetProvider(StaticDataSetProvider staticDataSetProvider, IntervalBuilderLocator intervalBuilderLocator, IntervalBuilderDynamicDate intervalBuilderDynamicDate, DataSetOpEngine opEngine)

Method Summary

Modifier and Type	Method and Description
protected void	_appendFilterBy(DataSetMetadata metadata, SQLDataSetDef def, ColumnFilter filter, Select _query)
protected void	_appendFilterBy(DataSetMetadata metadata, SQLDataSetDef def, DataSetFilter filterOp, Select _query)
protected void	_appendFrom(SQLDataSetDef def, Select _query)
protected int	_assertColumnExists(DataSetMetadata metadata, String columnId)
protected String	_columnFromMetadata(DataSetMetadata metadata, String columnId)
protected Condition	_createCondition(DataSetMetadata metadata, SQLDataSetDef def, ColumnFilter filter)
protected Table	_createTable(SQLDataSetDef def)
protected List<Column>	_getColumns(SQLDataSetDef def, Connection conn)
protected DataSetMetadata	_getDataSetMetadata(SQLDataSetDef def, Connection conn, boolean skipCache)
protected Column	_getDbColumn(Collection<Column> dbColumns, String columnId)
protected int	_getRowCount(DataSetMetadata metadata, SQLDataSetDef def, Connection conn)
protected DataSet	_lookupDataSet(SQLDataSetDef def, DataSetLookup lookup)
static SQLDataSetProvider	get()
DataSetMetadata	getDataSetMetadata(DataSetDef def)
SQLDataSourceLocator	getDataSourceLocator()
IntervalBuilderDynamicDate	getIntervalBuilderDynamicDate()
IntervalBuilderLocator	getIntervalBuilderLocator()
DataSetOpEngine	getOpEngine()
StaticDataSetProvider	getStaticDataSetProvider()
DataSetProviderType	getType()
boolean	isDataSetOutdated(DataSetDef def)
Select	logSQL(Select q)
DataSet	lookupDataSet(DataSetDef def, DataSetLookup lookup)
void	onDataSetDefModified(DataSetDef olDef, DataSetDef newDef)
void	onDataSetDefRegistered(DataSetDef newDef)
void	onDataSetDefRemoved(DataSetDef oldDef)
void	onDataSetDefStale(DataSetDef def)
void	setDataSourceLocator(SQLDataSourceLocator dataSourceLocator)
void	setIntervalBuilderDynamicDate(IntervalBuilderDynamicDate intervalBuilderDynamicDate)
void	setIntervalBuilderLocator(IntervalBuilderLocator intervalBuilderLocator)
void	setOpEngine(DataSetOpEngine opEngine)
void	setStaticDataSetProvider(StaticDataSetProvider staticDataSetProvider)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.slf4j.Logger log

staticDataSetProvider

protected StaticDataSetProvider staticDataSetProvider

dataSourceLocator

protected SQLDataSourceLocator dataSourceLocator

intervalBuilderLocator

protected IntervalBuilderLocator intervalBuilderLocator

intervalBuilderDynamicDate

protected IntervalBuilderDynamicDate intervalBuilderDynamicDate

opEngine

protected DataSetOpEngine opEngine

_metadataMap

protected transient Map<String,SQLDataSetProvider.MetadataHolder> _metadataMap

Constructor Detail

SQLDataSetProvider

public SQLDataSetProvider()

SQLDataSetProvider

public SQLDataSetProvider(StaticDataSetProvider staticDataSetProvider,
                          IntervalBuilderLocator intervalBuilderLocator,
                          IntervalBuilderDynamicDate intervalBuilderDynamicDate,
                          DataSetOpEngine opEngine)

Method Detail

get

public static SQLDataSetProvider get()

getStaticDataSetProvider

public StaticDataSetProvider getStaticDataSetProvider()

setStaticDataSetProvider

public void setStaticDataSetProvider(StaticDataSetProvider staticDataSetProvider)

getDataSourceLocator

public SQLDataSourceLocator getDataSourceLocator()

setDataSourceLocator

public void setDataSourceLocator(SQLDataSourceLocator dataSourceLocator)

getIntervalBuilderLocator

public IntervalBuilderLocator getIntervalBuilderLocator()

setIntervalBuilderLocator

public void setIntervalBuilderLocator(IntervalBuilderLocator intervalBuilderLocator)

getIntervalBuilderDynamicDate

public IntervalBuilderDynamicDate getIntervalBuilderDynamicDate()

setIntervalBuilderDynamicDate

public void setIntervalBuilderDynamicDate(IntervalBuilderDynamicDate intervalBuilderDynamicDate)

getOpEngine

public DataSetOpEngine getOpEngine()

setOpEngine

public void setOpEngine(DataSetOpEngine opEngine)

getType

public DataSetProviderType getType()

Specified by:

getType in interface DataSetProvider

lookupDataSet

public DataSet lookupDataSet(DataSetDef def,
                             DataSetLookup lookup)
                      throws Exception

Specified by:

lookupDataSet in interface DataSetProvider

Throws:

Exception

isDataSetOutdated

public boolean isDataSetOutdated(DataSetDef def)

Specified by:

isDataSetOutdated in interface DataSetProvider

getDataSetMetadata

public DataSetMetadata getDataSetMetadata(DataSetDef def)
                                   throws Exception

Specified by:

getDataSetMetadata in interface DataSetProvider

Throws:

Exception

onDataSetDefStale

public void onDataSetDefStale(DataSetDef def)

Specified by:

onDataSetDefStale in interface DataSetDefRegistryListener

onDataSetDefModified

public void onDataSetDefModified(DataSetDef olDef,
                                 DataSetDef newDef)

Specified by:

onDataSetDefModified in interface DataSetDefRegistryListener

onDataSetDefRemoved

public void onDataSetDefRemoved(DataSetDef oldDef)

Specified by:

onDataSetDefRemoved in interface DataSetDefRegistryListener

onDataSetDefRegistered

public void onDataSetDefRegistered(DataSetDef newDef)

Specified by:

onDataSetDefRegistered in interface DataSetDefRegistryListener

_getDbColumn

protected Column _getDbColumn(Collection<Column> dbColumns,
                              String columnId)

_getDataSetMetadata

protected DataSetMetadata _getDataSetMetadata(SQLDataSetDef def,
                                              Connection conn,
                                              boolean skipCache)
                                       throws Exception

Throws:

Exception

_getColumns

protected List<Column> _getColumns(SQLDataSetDef def,
                                   Connection conn)
                            throws Exception

Throws:

Exception

_getRowCount

protected int _getRowCount(DataSetMetadata metadata,
                           SQLDataSetDef def,
                           Connection conn)
                    throws Exception

Throws:

Exception

_lookupDataSet

protected DataSet _lookupDataSet(SQLDataSetDef def,
                                 DataSetLookup lookup)
                          throws Exception

Throws:

Exception

_createTable

protected Table _createTable(SQLDataSetDef def)

_appendFrom

protected void _appendFrom(SQLDataSetDef def,
                           Select _query)

_appendFilterBy

protected void _appendFilterBy(DataSetMetadata metadata,
                               SQLDataSetDef def,
                               DataSetFilter filterOp,
                               Select _query)

_appendFilterBy

protected void _appendFilterBy(DataSetMetadata metadata,
                               SQLDataSetDef def,
                               ColumnFilter filter,
                               Select _query)

_createCondition

protected Condition _createCondition(DataSetMetadata metadata,
                                     SQLDataSetDef def,
                                     ColumnFilter filter)

_columnFromMetadata

protected String _columnFromMetadata(DataSetMetadata metadata,
                                     String columnId)

_assertColumnExists

protected int _assertColumnExists(DataSetMetadata metadata,
                                  String columnId)

logSQL

public Select logSQL(Select q)