Package org.dashbuilder.dataset.impl

Class SQLDataSetDefBuilderImpl

java.lang.Object

org.dashbuilder.dataset.impl.AbstractDataSetDefBuilder<SQLDataSetDefBuilderImpl>

org.dashbuilder.dataset.impl.SQLDataSetDefBuilderImpl

All Implemented Interfaces:

DataSetDefBuilder<SQLDataSetDefBuilderImpl>, SQLDataSetDefBuilder<SQLDataSetDefBuilderImpl>

public class SQLDataSetDefBuilderImpl
extends AbstractDataSetDefBuilder<SQLDataSetDefBuilderImpl>
implements SQLDataSetDefBuilder<SQLDataSetDefBuilderImpl>

Field Summary

Fields inherited from class org.dashbuilder.dataset.impl.AbstractDataSetDefBuilder

def

Constructor Summary

Constructors

Constructor	Description
SQLDataSetDefBuilderImpl()

Method Summary

Modifier and Type	Method	Description
protected DataSetDef	createDataSetDef()
SQLDataSetDefBuilderImpl	dataSource(String dataSource)	Set the data source where this data set is stored.
SQLDataSetDefBuilderImpl	dbSchema(String dbSchema)	Set the database schema where the target table relies
SQLDataSetDefBuilderImpl	dbSQL(String dbSQL, boolean allColumns)	Specifies a custom SQL for the retrieval of the data set rows.
SQLDataSetDefBuilderImpl	dbTable(String dbTable, boolean allColumns)	Set the database table holding all the data set rows.
SQLDataSetDefBuilderImpl	estimateSize(boolean estimateSize)

Methods inherited from class org.dashbuilder.dataset.impl.AbstractDataSetDefBuilder

buildDef, cacheOff, cacheOn, column, date, label, name, number, pushOff, pushOn, refreshOff, refreshOn, text, uuid

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dashbuilder.dataset.def.DataSetDefBuilder

buildDef, cacheOff, cacheOn, column, date, label, name, number, pushOff, pushOn, refreshOff, refreshOn, text, uuid

Constructor Detail

SQLDataSetDefBuilderImpl

public SQLDataSetDefBuilderImpl()

Method Detail

createDataSetDef

protected DataSetDef createDataSetDef()

Specified by:

createDataSetDef in class AbstractDataSetDefBuilder<SQLDataSetDefBuilderImpl>

dataSource

public SQLDataSetDefBuilderImpl dataSource(String dataSource)

Description copied from interface: SQLDataSetDefBuilder

Set the data source where this data set is stored.

Specified by:

dataSource in interface SQLDataSetDefBuilder<SQLDataSetDefBuilderImpl>

Parameters:

dataSource - the data source JNDI name

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

dbSchema

public SQLDataSetDefBuilderImpl dbSchema(String dbSchema)

Description copied from interface: SQLDataSetDefBuilder

Set the database schema where the target table relies

Specified by:

dbSchema in interface SQLDataSetDefBuilder<SQLDataSetDefBuilderImpl>

Parameters:

dbSchema - the schema name

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

dbTable

public SQLDataSetDefBuilderImpl dbTable(String dbTable,
                                        boolean allColumns)

Description copied from interface: SQLDataSetDefBuilder

Set the database table holding all the data set rows.

NOTE: You can either specify a DB table containing all the rows or provide a custom SQL (see the dbSQL method). The SQL settings has preference over the DB table. Therefore, calling to this method will have no effect if the method dbSQL has been previously invoked.

Specified by:

dbTable in interface SQLDataSetDefBuilder<SQLDataSetDefBuilderImpl>

Parameters:

dbTable - the table name

allColumns - If true then all the DB table columns will be part of the data set. If false then only the columns defined (see the DataSetDefBuilder column definition methods)

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

dbSQL

public SQLDataSetDefBuilderImpl dbSQL(String dbSQL,
                                      boolean allColumns)

Description copied from interface: SQLDataSetDefBuilder

Specifies a custom SQL for the retrieval of the data set rows.

Specified by:

dbSQL in interface SQLDataSetDefBuilder<SQLDataSetDefBuilderImpl>

Parameters:

dbSQL - the data retrieval SQL

allColumns - If true then all the column returned by the SQL will be part of the data set. If false then only the columns defined (see the DataSetDefBuilder column definition methods)

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

estimateSize

public SQLDataSetDefBuilderImpl estimateSize(boolean estimateSize)