ilog.views.util.data

Class IlvJDBCTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

ilog.views.util.data.IlvJDBCTableModel

All Implemented Interfaces:

Serializable, TableModel

public class IlvJDBCTableModel
extends AbstractTableModel

The IlvJDBCTableMode is an implementation of the Swing TableModel that connects to a database through JDBC 2.0. This implementation is a read-only version of a TableModel. Note: since JViews 6.5 IlvRowSetTableModel is a read and write implementation that instead of using JDBC 2.0 API relies on RowSet API. This is the recommended class to use if you don't need threaded loading of the data or if you need write capabilities.

Since:

JViews 6.0

See Also:

IlvRowSetTableModel, Serialized Form

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
IlvJDBCTableModel() Creates an IlvJDBCTableModel.
IlvJDBCTableModel(Connection connection, String query) Creates and initializes an IlvJDBCTableModel from a java.sql.Connection and an SQL query.
IlvJDBCTableModel(Connection connection, String query, Object[] queryParameters) Creates and initializes an IlvJDBCTableModel from a java.sql.Connection and an SQL query.
IlvJDBCTableModel(ResultSet resultSet) Creates and initializes an IlvJDBCTableModel from a java.sql.ResultSet.
IlvJDBCTableModel(String databaseURL, String user, String passwd, String driverName, String query) Creates and initializes an IlvJDBCTableModel from a set of JDBC parameters.
IlvJDBCTableModel(String databaseURL, String user, String passwd, String driverName, String query, Object[] queryParameters) Creates and initializes an IlvJDBCTableModel from a set of JDBC parameters.

Method Summary

Modifier and Type	Method and Description
protected void	finalize() Ensures that all the IlvJDBCTableModel resources are released.
Class<?>	getColumnClass(int columnIndex) Returns the most specific superclass for all the cell values in the column.
int	getColumnCount() Returns the number of columns in this table model.
String	getColumnName(int columnIndex) Returns the name of the column at index columnIndex.
int	getMaximumCacheSize() Returns the maximum size of the internal cache of the IlvJDBCTableModel.
ResultSet	getResultSet() Returns the ResultSet used internally by this IlvJDBCTableModel to query the database.
int	getRowCount() Returns the number of row in this table model.
Object	getValueAt(int rowIndex, int columnIndex) Returns the value at the specified indexes.
boolean	isThreadingEnabled() Sets whether or not threading must be used to compute the internal cache.
void	join() This method must be called to wait for the execution of the IlvJDBCTableModel caching thread to be finished.
protected void	releaseResources() Releases the resources acquired by the IlvJDBCTableModel.
void	setConnection(Connection connection, String query) Initializes an IlvJDBCTableModel with a java.sql.Connection and an SQL query.
void	setConnection(Connection connection, String query, Object[] queryParameters) Initializes an IlvJDBCTableModel with a java.sql.Connection and an SQL query.
void	setConnectionParameters(String databaseURL, String user, String passwd, String driverName, String query) Initializes an IlvJDBCTableModel with a set of JDBC parameters.
void	setConnectionParameters(String databaseURL, String user, String passwd, String driverName, String query, Object[] queryParameters) Initializes an IlvJDBCTableModel with a set of JDBC parameters.
void	setMaximumCacheSize(int size) Sets the maximum size of the internal cache of the IlvJDBCTableModel.
void	setResultSet(ResultSet resultSet) Initializes the IlvJDBCTableModel with the given java.sql.ResultSet.
void	setThreadingEnabled(boolean value) Sets whether or not threading must be used to compute the internal cache.

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, isCellEditable, removeTableModelListener, setValueAt

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvJDBCTableModel

public IlvJDBCTableModel()

Creates an IlvJDBCTableModel. It should then be initialized with one of the following methods: setConnection(Connection, String, Object[]), setConnectionParameters(String, String, String, String, String, Object[]) or setResultSet(ResultSet).

IlvJDBCTableModel

public IlvJDBCTableModel(Connection connection,
                         String query)
                  throws SQLException

Creates and initializes an IlvJDBCTableModel from a java.sql.Connection and an SQL query.

Parameters:

connection - The connection to the database

query - The query to be executed to fill the table model. In this query, every parameter should be validated, to prevent SQL injection attacks.

Throws:

SQLException - if the IlvJDBCTableModel is unable to perform the query.

IlvJDBCTableModel

public IlvJDBCTableModel(Connection connection,
                         String query,
                         Object[] queryParameters)
                  throws SQLException

Creates and initializes an IlvJDBCTableModel from a java.sql.Connection and an SQL query.

Parameters:

connection - The connection to the database

query - The query to be executed to fill the table model, with a question mark placeholder for each parameter.

queryParameters - Parameters of the query.

Throws:

SQLException - if the IlvJDBCTableModel is unable to perform the query.

Since:

JViews 8.8

IlvJDBCTableModel

public IlvJDBCTableModel(String databaseURL,
                         String user,
                         String passwd,
                         String driverName,
                         String query)
                  throws SQLException

Creates and initializes an IlvJDBCTableModel from a set of JDBC parameters.

Parameters:

databaseURL - the database URL

user - the user used to access the database

passwd - the user password

driverName - the driver used to connect the database, can be null if the driver is already registered.

query - The query to be executed to fill the table model. In this query, every parameter should be validated, to prevent SQL injection attacks.

Throws:

SQLException - if the connection to the database cannot be done.

IlvJDBCTableModel

public IlvJDBCTableModel(String databaseURL,
                         String user,
                         String passwd,
                         String driverName,
                         String query,
                         Object[] queryParameters)
                  throws SQLException

Creates and initializes an IlvJDBCTableModel from a set of JDBC parameters.

Parameters:

databaseURL - the database URL

user - the user used to access the database

passwd - the user password

driverName - the driver used to connect the database, can be null if the driver is already registered.

query - The query to be executed to fill the table model, with a question mark placeholder for each parameter.

queryParameters - Parameters of the query.

Throws:

SQLException - if the connection to the database cannot be done.

Since:

JViews 8.8

IlvJDBCTableModel

public IlvJDBCTableModel(ResultSet resultSet)
                  throws SQLException

Creates and initializes an IlvJDBCTableModel from a java.sql.ResultSet.

Parameters:

resultSet - The result set that will be used to fill the table model.

Throws:

SQLException - if the ResultSet cannot be accessed.

Method Detail

setConnection

public final void setConnection(Connection connection,
                                String query)
                         throws SQLException

Initializes an IlvJDBCTableModel with a java.sql.Connection and an SQL query.

Parameters:

connection - The connection to the database.

query - The query to be executed to fill the table model. In this query, every parameter should be validated, to prevent SQL injection attacks.

Throws:

SQLException - if the IlvJDBCTableModel is unable to perform the query.

See Also:

setConnection(Connection, String, Object[])

setConnection

public final void setConnection(Connection connection,
                                String query,
                                Object[] queryParameters)
                         throws SQLException

Initializes an IlvJDBCTableModel with a java.sql.Connection and an SQL query.

Parameters:

connection - The connection to the database.

query - The query to be executed to fill the table model, with a question mark placeholder for each parameter.

queryParameters - Parameters of the query.

Throws:

SQLException - if the IlvJDBCTableModel is unable to perform the query.

Since:

JViews 8.8

setResultSet

public final void setResultSet(ResultSet resultSet)
                        throws SQLException

Initializes the IlvJDBCTableModel with the given java.sql.ResultSet.

Parameters:

resultSet - the ResultSet used to fill the table model.

Throws:

SQLException - if the ResultSet cannot be accessed.

setConnectionParameters

public final void setConnectionParameters(String databaseURL,
                                          String user,
                                          String passwd,
                                          String driverName,
                                          String query)
                                   throws SQLException

Initializes an IlvJDBCTableModel with a set of JDBC parameters.

Parameters:

databaseURL - the database URL

user - the user used to access the database

passwd - the user password

driverName - the driver used to connect the database, can be null if the driver is already registered.

query - The query to be executed to fill the table model. In this query, every parameter should be validated, to prevent SQL injection attacks.

Throws:

SQLException - if the connection to the database cannot be done.

See Also:

setConnectionParameters(String, String, String, String, String, Object[])

setConnectionParameters

public final void setConnectionParameters(String databaseURL,
                                          String user,
                                          String passwd,
                                          String driverName,
                                          String query,
                                          Object[] queryParameters)
                                   throws SQLException

Initializes an IlvJDBCTableModel with a set of JDBC parameters.

Parameters:

databaseURL - the database URL

user - the user used to access the database

passwd - the user password

driverName - the driver used to connect the database, can be null if the driver is already registered.

query - The query to be executed to fill the table model, with a question mark placeholder for each parameter.

queryParameters - Parameters of the query.

Throws:

SQLException - if the connection to the database cannot be done.

Since:

JViews 8.8

getResultSet

public ResultSet getResultSet()

Returns the ResultSet used internally by this IlvJDBCTableModel to query the database. If the IlvJDBCTableModel has not been yet initialized this method may return null. If the caching operation is finished the returned ResultSet may be closed.

finalize

protected void finalize()
                 throws Throwable

Ensures that all the IlvJDBCTableModel resources are released.

Overrides:

finalize in class Object

Throws:

Throwable

setMaximumCacheSize

public final void setMaximumCacheSize(int size)

Sets the maximum size of the internal cache of the IlvJDBCTableModel. The default value is Integer.MAX_VALUE which means the entire ResultSet will be cached in the IlvJDBCTableModel . There are typically two reasons for which it would be set to smaller values:

• If the number of rows in the ResultSet is huge and memory need to be saved.
• If the ResultSet implementation of the database driver is already managing a cache.

In this case the connection to the database must not be closed and must be fast enough to allow user interaction. When the ResultSet is of type ResultSet.TYPE_FORWARD_ONLY whatever is the maximum cache size, a full caching will be performed. Calling this method will erase the cache and so in order for this new value to be taken into account and the model to be workable a new connection must be performed ( setConnection(Connection, String, Object[]), setConnectionParameters(String, String, String, String, String, Object[]) , setResultSet(ResultSet) after calling this method.

Parameters:

size - the size of the cache

See Also:

getMaximumCacheSize()

getMaximumCacheSize

public final int getMaximumCacheSize()

Returns the maximum size of the internal cache of the IlvJDBCTableModel. The default value is Integer.MAX_VALUE which means the entire ResultSet will be cached in the IlvJDBCTableModel . There are typically two reasons for which it would be set to smaller values:

• If the number of rows in the ResultSet is huge and memory need to be saved.
• If the ResultSet implementation of the database driver is already managing a cache.

In this case the connection to the database must not be closed and must be fast enough to allow user interaction. When the ResultSet is of type ResultSet.TYPE_FORWARD_ONLY whatever is the maximum cache size, a full caching will be performed.

See Also:

setMaximumCacheSize(int)

setThreadingEnabled

public final void setThreadingEnabled(boolean value)

Sets whether or not threading must be used to compute the internal cache. Threading may improve the user interaction when visualizing the table model inside a JTable. The default values is false.

Parameters:

value - threading enabled or not

isThreadingEnabled

public final boolean isThreadingEnabled()

Sets whether or not threading must be used to compute the internal cache. Threading may improve the user interaction when the table model is used inside a JTable. The default values is false.

See Also:

setThreadingEnabled(boolean)

join

public final void join()
                throws InterruptedException

This method must be called to wait for the execution of the IlvJDBCTableModel caching thread to be finished. This is particularly useful in case of full caching (i.e. getMaximumCacheSize() returns Integer.MAX_VALUE) to not ask for values before they have been cached. Moreover this method does nothing if isThreadingEnabled() returns false or when the caching mechanism is not activated (i.e. getMaximumCacheSize() does return 0.

Throws:

InterruptedException

See Also:

isThreadingEnabled()

getRowCount

public int getRowCount()

Returns the number of row in this table model.

See Also:

TableModel.getRowCount()

getColumnCount

public int getColumnCount()

Returns the number of columns in this table model.

See Also:

TableModel.getColumnCount()

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Returns the value at the specified indexes.

See Also:

TableModel.getValueAt(int, int)

getColumnName

public String getColumnName(int columnIndex)

Returns the name of the column at index columnIndex.

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractTableModel

getColumnClass

public Class<?> getColumnClass(int columnIndex)

Returns the most specific superclass for all the cell values in the column. This is used by the JTable to set up a default renderer and editor for the column.

Specified by:

getColumnClass in interface TableModel

Overrides:

getColumnClass in class AbstractTableModel

Parameters:

columnIndex - the index of the column

Returns:

the common ancestor class of the object values in the model.

releaseResources

protected void releaseResources()
                         throws SQLException

Releases the resources acquired by the IlvJDBCTableModel. This method is called when the IlvJDBCTableModel has finished the caching operation. Which means this method is called only when a full caching is performed. The default implementation is closing the java.sql.ResultSet used by the table model except if it has been explicitly set by the user by calling IlvJDBCTableModel(ResultSet) or setResultSet(ResultSet). It can be overridden to close other resources or not close the ResultSet.

Throws:

SQLException

See Also:

getMaximumCacheSize(), getResultSet()