ilog.views.chart.data

Class IlvJDBCDataSource

java.lang.Object

ilog.views.chart.data.IlvAbstractDataSource

ilog.views.chart.data.IlvAbstractTableDataSource

ilog.views.chart.data.IlvSwingTableDataSource

ilog.views.chart.data.IlvJDBCDataSource

All Implemented Interfaces:

IlvDataSource, IlvBatchable, Serializable

public class IlvJDBCDataSource
extends IlvSwingTableDataSource

A data source that loads data from a database.

Since:

JViews 5.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ilog.views.chart.data.IlvSwingTableDataSource

IlvSwingTableDataSource.Mapping

Field Summary

Fields inherited from class ilog.views.chart.data.IlvSwingTableDataSource

COLUMN_SERIES, ROW_SERIES

Constructor Summary

Constructors

Constructor and Description
IlvJDBCDataSource() Creates a new IlvJDBCDataSource object in read-only mode.
IlvJDBCDataSource(boolean readOnly) Creates a new IlvJDBCDataSource object.
IlvJDBCDataSource(ResultSet resultSet) Creates a new IlvJDBCDataSource object attached to resultSet with no defined column for X abscissa and no data labels column.
IlvJDBCDataSource(ResultSet resultSet, int xColumnIndex, int dataLabelsColumnIndex) Creates a new IlvJDBCDataSource object attached to the specified result set using the specified column index for the x-values and the data labels.
IlvJDBCDataSource(String databaseURL, String user, String passwd, String driverName, String query, int xColumnIndex, int dataLabelsColumnIndex) Creates a new IlvJDBCDataSource object.
IlvJDBCDataSource(String databaseURL, String user, String passwd, String driverName, String query, int xColumnIndex, int dataLabelsColumnIndex, boolean readOnly) Creates a new IlvJDBCDataSource object.
IlvJDBCDataSource(String databaseURL, String user, String passwd, String driverName, String query, Object[] queryParameters, int xColumnIndex, int dataLabelsColumnIndex, boolean readOnly) Creates a new IlvJDBCDataSource object.

Method Summary

Modifier and Type	Method and Description
void	addProperties(Properties properties) Add properties to configure the JDBC driver
protected IlvDataSet[]	buildDataSets(ResultSet resultSet) Builds the data sets from the specified ResultSet.
protected int[]	computeColumnType(ResultSet resultSet) Returns an array of the types of every columns of the given ResultSet.
protected Connection	createConnection() Creates the connection.
void	endConnection() Closes the current connection.
void	executeQuery() Executes the query according to the current configuration.
protected void	finalize() Ensures that the current connection is closed when there are no more references to this object.
String	formatDataLabel(String label) Returns the data label to be used for a table cell value.
protected Connection	getConnection() Returns the connection used by the data source.
String	getConnectionParams() Returns the Bean connection parameters.
String	getDatabaseURL() Returns the database URL.
IlvDataConverter	getDataConverter(int col) Returns an IlvDataConverter object to convert data for the specified column.
String	getDriverClassname() Returns the driver classname.
protected Class<?>	getJavaType(int sqlType) Returns the type of the Java object corresponding to the specified built-in SQL type.
String	getPassword() Returns the user password.
String	getQuery() Returns the query string, potentially with question marks as placeholders for the parameters.
Object[]	getQueryParameters() Returns the parameters of the query, or null or an empty array if there are none.
String	getUserName() Returns the user name.
boolean	isReadOnly() Returns whether this model is read-only.
protected boolean	isReady() Returns whether all the parameters are properly initialized.
boolean	isTimeSeries(int index) Returns whether the specified column or row (depending on the type of this data source) represents a time series.
void	setConnectionParams(String params) Sets the Bean connection parameters.
void	setDatabaseURL(String databaseURL) Sets the database URL.
void	setDataLabelsIndex(int index) Sets the data labels index.
void	setDriverClassname(String classname) Sets the driver classname.
void	setPassword(String password) Sets the user password.
void	setQuery(String query) Sets the query string.
void	setQueryParameters(Object[] queryParameters) Sets the query parameters.
void	setResultSet(ResultSet resultSet) Sets the given result set as the new data source with no defined columns for X abscissa and data labels.
void	setResultSet(ResultSet resultSet, int xColumnIndex, int labelsColumnIndex) Sets the given result set as the new data source using the given columns for x-values and data labels.
void	setResultSet(ResultSet resultSet, String xColumnName, String labelsColumnName) Sets the given result set as the new data source using the specified columns for the x-values and data labels.
void	setTableModel(TableModel tableModel) Sets the table model associated with this data source.
void	setUserName(String userName) Sets the user name.
void	setXSeriesIndex(int index) Sets the xseries column index.

Methods inherited from class ilog.views.chart.data.IlvSwingTableDataSource

getDataConverter, getDataLabelsIndex, getDefaultConverter, getLocale, getMapping, getSeriesType, getTableModel, getULocale, getUndefValue, getXSeriesIndex, setDataConverter, setDataSets, setDefaultConverter, setLocale, setMapping, setSeriesType, setULocale, setUndefValue, tableChanged

Methods inherited from class ilog.views.chart.data.IlvAbstractDataSource

addDataSet, addDataSet, addDataSourceListener, containsDataSet, endBatch, fireDataSourceEvent, getDataSet, getDataSetByName, getDataSetCount, getDataSetIndex, getDataSetIterator, getDataSetList, getDataSets, initDataSets, removeDataSourceListener, setDataSet, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvJDBCDataSource

public IlvJDBCDataSource()

Creates a new IlvJDBCDataSource object in read-only mode.

IlvJDBCDataSource

public IlvJDBCDataSource(boolean readOnly)

Creates a new IlvJDBCDataSource object.

Parameters:

readOnly - if true the model is read-only otherwise modifications are allowed and will automatically be committed back to the database.

Since:

JViews 6.5

IlvJDBCDataSource

public IlvJDBCDataSource(String databaseURL,
                         String user,
                         String passwd,
                         String driverName,
                         String query,
                         int xColumnIndex,
                         int dataLabelsColumnIndex)

Creates a new IlvJDBCDataSource object. This constructor does not execute the query. You have to call explicitly the executeQuery() method to initialize the data sets.

Parameters:

databaseURL - The database URL.

user - The user name.

passwd - The user password.

driverName - The JDBC driver classname to load.

query - The query to execute. In this query, every parameter should be validated, to prevent SQL injection attacks.

xColumnIndex - The index of the xseries column. The first column is 0, the second is 1... Passing -1 means no specific xseries should be used.

dataLabelsColumnIndex - The index of the data labels column. The first column is 0, the second is 1... Passing -1 means no data labels column should be used.

See Also:

executeQuery()

IlvJDBCDataSource

public IlvJDBCDataSource(String databaseURL,
                         String user,
                         String passwd,
                         String driverName,
                         String query,
                         int xColumnIndex,
                         int dataLabelsColumnIndex,
                         boolean readOnly)

Creates a new IlvJDBCDataSource object. This constructor does not execute the query. You have to call explicitly the executeQuery() method to initialize the data sets.

Parameters:

databaseURL - The database URL.

user - The user name.

passwd - The user password.

driverName - The JDBC driver classname to load.

query - The query to execute. In this query, every parameter should be validated, to prevent SQL injection attacks.

xColumnIndex - The index of the xseries column. The first column is 0, the second is 1... Passing -1 means no specific xseries should be used.

dataLabelsColumnIndex - The index of the data labels column. The first column is 0, the second is 1... Passing -1 means no data labels column should be used.

readOnly - if true the model is read-only otherwise modifications are allowed and will automatically be committed back to the database.

Since:

JViews 6.5

See Also:

executeQuery()

IlvJDBCDataSource

public IlvJDBCDataSource(String databaseURL,
                         String user,
                         String passwd,
                         String driverName,
                         String query,
                         Object[] queryParameters,
                         int xColumnIndex,
                         int dataLabelsColumnIndex,
                         boolean readOnly)

Creates a new IlvJDBCDataSource object. This constructor does not execute the query. You have to call explicitly the executeQuery() method to initialize the data sets.

Parameters:

databaseURL - The database URL.

user - The user name.

passwd - The user password.

driverName - The JDBC driver classname to load.

query - The query to execute, with a question mark placeholder for each parameter.

queryParameters - Parameters of the query.

xColumnIndex - The index of the xseries column. The first column is 0, the second is 1... Passing -1 means no specific xseries should be used.

dataLabelsColumnIndex - The index of the data labels column. The first column is 0, the second is 1... Passing -1 means no data labels column should be used.

readOnly - if true the model is read-only otherwise modifications are allowed and will automatically be committed back to the database.

Since:

JViews 8.8

See Also:

executeQuery()

IlvJDBCDataSource

public IlvJDBCDataSource(ResultSet resultSet)
                  throws SQLException

Creates a new IlvJDBCDataSource object attached to resultSet with no defined column for X abscissa and no data labels column.

Throws:

SQLException - The connection to the database has failed.

IlvJDBCDataSource

public IlvJDBCDataSource(ResultSet resultSet,
                         int xColumnIndex,
                         int dataLabelsColumnIndex)
                  throws SQLException

Creates a new IlvJDBCDataSource object attached to the specified result set using the specified column index for the x-values and the data labels.

Parameters:

xColumnIndex - The index of the xseries column. The first column is 0, the second is 1... Passing -1 means no specific x-series should be used.

dataLabelsColumnIndex - The index of the data labels column. The first column is 0, the second is 1... Passing -1 means no data labels column should be used.

Throws:

SQLException - The connection to the database has failed.

Method Detail

setConnectionParams

public void setConnectionParams(String params)
                         throws SQLException

Sets the Bean connection parameters. Note that you should not call this method directly.

Throws:

SQLException - If a database access error occurs.

getConnectionParams

public String getConnectionParams()

Returns the Bean connection parameters. Note that you should not call this method directly.

getDatabaseURL

public String getDatabaseURL()

Returns the database URL.

See Also:

setDatabaseURL(java.lang.String)

setDatabaseURL

public void setDatabaseURL(String databaseURL)

Sets the database URL.

Parameters:

databaseURL - The database URL. This string should be formatted according to the database specifications.

getDriverClassname

public String getDriverClassname()

Returns the driver classname.

See Also:

setDriverClassname(java.lang.String)

setDriverClassname

public void setDriverClassname(String classname)

Sets the driver classname.

Parameters:

classname - The classname of the driver to use.

getQuery

public String getQuery()

Returns the query string, potentially with question marks as placeholders for the parameters.

setQuery

public void setQuery(String query)

Sets the query string.

See Also:

setQueryParameters(Object[])

getQueryParameters

public Object[] getQueryParameters()

Returns the parameters of the query, or null or an empty array if there are none.

Returns:

An array of parameter objects, or null.

Since:

JViews 8.8

setQueryParameters

public void setQueryParameters(Object[] queryParameters)

Sets the query parameters.

Parameters:

queryParameters - An array of parameter objects. It should have as many elements as there are question mark placeholders in the getQuery() string.

Since:

JViews 8.8

getUserName

public String getUserName()

Returns the user name.

setUserName

public void setUserName(String userName)

Sets the user name.

getPassword

public String getPassword()

Returns the user password.

setPassword

public void setPassword(String password)

Sets the user password.

addProperties

public void addProperties(Properties properties)

Add properties to configure the JDBC driver

Parameters:

properties - The set of properties added to configure the JDBC driver

setXSeriesIndex

public void setXSeriesIndex(int index)

Sets the xseries column index.

Overrides:

setXSeriesIndex in class IlvSwingTableDataSource

Parameters:

index - The xseries column or row index depending on the series type. A value equals to -1 means that no specific xseries should be used.

setDataLabelsIndex

public void setDataLabelsIndex(int index)

Sets the data labels index.

Overrides:

setDataLabelsIndex in class IlvSwingTableDataSource

Parameters:

index - The data labels column or row index depending on the series type. A value of -1 means that no data labels are available.

getConnection

protected Connection getConnection()
                            throws SQLException,
                                   IllegalArgumentException

Returns the connection used by the data source. If the connection has not been established yet, this method calls createConnection(). May return null if the connection fails.

Throws:

SQLException - If a database access error occurs.

IllegalArgumentException - If one or several parameters required to establish the connection have not been properly initialized (including errors during jdbc driver instantiation).

See Also:

createConnection()

createConnection

protected Connection createConnection()
                               throws SQLException,
                                      IllegalArgumentException

Creates the connection. The default implementation calls DriverManager.getConnection().

Throws:

IllegalStateException - One or several parameters required for the connection have not been properly initialized.

SQLException - If a database access error occurs.

IllegalArgumentException - If one or several parameters required to establish the connection have not been properly initialized (including errors during JDBC driver instantiation).

isReady

protected boolean isReady()

Returns whether all the parameters are properly initialized.

finalize

protected void finalize()
                 throws Throwable

Ensures that the current connection is closed when there are no more references to this object.

Overrides:

finalize in class Object

Throws:

Throwable

endConnection

public void endConnection()
                   throws SQLException

Closes the current connection.

Throws:

SQLException - If a database access error occurs.

executeQuery

public void executeQuery()
                  throws SQLException,
                         IllegalArgumentException

Executes the query according to the current configuration.

Throws:

IllegalArgumentException - One or several parameters required for the connection have not been properly initialized.

SQLException - If a database access error occurs.

setResultSet

public void setResultSet(ResultSet resultSet)
                  throws SQLException

Sets the given result set as the new data source with no defined columns for X abscissa and data labels.

Throws:

SQLException - If a database access error occurs.

setResultSet

public void setResultSet(ResultSet resultSet,
                         String xColumnName,
                         String labelsColumnName)
                  throws SQLException

Sets the given result set as the new data source using the specified columns for the x-values and data labels.

Throws:

SQLException - If a database access error occurs.

setResultSet

public void setResultSet(ResultSet resultSet,
                         int xColumnIndex,
                         int labelsColumnIndex)
                  throws SQLException

Sets the given result set as the new data source using the given columns for x-values and data labels.

Parameters:

resultSet - The result set containing the data.

xColumnIndex - The index of the x-series column. The first column is 0, the second is 1... Passing -1 means no specific x-series should be used.

labelsColumnIndex - The index of the data labels column. The first column is 0, the second is 1... Passing -1 means no specific x-series should be used.

Throws:

SQLException - If a database access error occurs.

See Also:

setXSeriesIndex(int)

buildDataSets

protected IlvDataSet[] buildDataSets(ResultSet resultSet)
                              throws SQLException

Builds the data sets from the specified ResultSet.

Throws:

SQLException

computeColumnType

protected int[] computeColumnType(ResultSet resultSet)
                           throws SQLException

Returns an array of the types of every columns of the given ResultSet. The default implementation invokes ResultSetMetaData.getColumnType() for each column.

Parameters:

resultSet - The result set to compute the column types.

Returns:

An array containing the type of each column. Cannot be null and must be of the same length than the result set column count.

Throws:

SQLException

Since:

JViews 6.5

getDataConverter

public IlvDataConverter getDataConverter(int col)

Returns an IlvDataConverter object to convert data for the specified column. The default implementation returns the default data converter associated with the Java type mapped on the SQL type of the specified column, as returned by the getJavaType method.

Overrides:

getDataConverter in class IlvSwingTableDataSource

Parameters:

col - The column index. The first column is 0, the second is 1, and so on.

Since:

JViews 5.5

See Also:

IlvSwingTableDataSource.getDefaultConverter(java.lang.Class<?>), getJavaType(int)

getJavaType

protected Class<?> getJavaType(int sqlType)

Returns the type of the Java object corresponding to the specified built-in SQL type. The default mapping is the same as the mapping used by the ResultSet.getObject() method, as indicated in the JDBC specification.

Since:

JViews 5.5

isTimeSeries

public boolean isTimeSeries(int index)

Returns whether the specified column or row (depending on the type of this data source) represents a time series. The default implementation makes the distinction between ROW_SERIES and COLUMN_SERIES data source:

• For COLUMN_SERIES, it returns true if the class returned by getTableModel().getColumnClass(idx) is an instance of java.util.Date. It returns false otherwise.
• For ROW_SERIES, it returns true if the class returned by getTableModel().getColumnClass(0) is an instance of java.util.Date. It returns false otherwise (that is, it tests only the type of the first column of the model.

Overrides:

isTimeSeries in class IlvSwingTableDataSource

Parameters:

index - The index of the column or rows.

Since:

JViews 6.0

isReadOnly

public final boolean isReadOnly()

Returns whether this model is read-only. The ready-only status must be set at construction time, by default a model is read-only. When the model is not read-only, modifications are allowed and will automatically be committed back to the database.

Since:

JViews 6.5

setTableModel

public void setTableModel(TableModel tableModel)

Sets the table model associated with this data source.

Overrides:

setTableModel in class IlvSwingTableDataSource

Since:

JViews 6.0

formatDataLabel

public final String formatDataLabel(String label)

Returns the data label to be used for a table cell value.

Overrides:

formatDataLabel in class IlvSwingTableDataSource

Parameters:

label - A value from the table model.