ilog.views.util.data

Class IlvRowSetTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

ilog.views.util.data.IlvRowSetTableModel

All Implemented Interfaces:

IlvTableModel, Serializable, TableModel

public class IlvRowSetTableModel
extends AbstractTableModel
implements IlvTableModel

The IlvRowSetTableModel is an implementation of the Swing TableModel that connects to a RowSet. A RowSet usually corresponds to results of a database query which means this class allows the model to be connected to a database. This implementation allows both read and write operations on the TableModel if the underlying RowSet is not readonly. For that purpose IlvRowSetTableModel also implements IlvTableModel and fires events provided by IlvTableModelEvent to correctly warn listeners a modification is going to happen. If caching is needed one can use an implementation of CachedRowSet instead of a regular RowSet as data provider.

Since:

JViews 6.5

See Also:

setRowSet(RowSet), createRowSet(String, String, String, String, boolean, int), createRowSet(String, String, String, String, Object[], boolean, int), Serialized Form

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
IlvRowSetTableModel() Builds an IlvRowSetTableModel instance to be initialized later on with a call to setRowSet(RowSet).
IlvRowSetTableModel(boolean autocommit) Builds a IlvRowSetTableModel instance to be initialized later on with a call to setRowSet(RowSet).
IlvRowSetTableModel(RowSet rowSet) Builds and initializes a IlvRowSetTableModel instance.
IlvRowSetTableModel(RowSet rowSet, boolean autocommit) Builds and initializes a IlvRowSetTableModel instance.

Method Summary

Modifier and Type	Method and Description
void	addRow(Object[] rowData) Adds a row.
void	commit() Tries to commit the rows content modifications that occur since last commit to the back end.
static RowSet	createRowSet(Connection connection, String command, boolean readonly, int pageSize) Creates a RowSet instance with the given parameters that can be used by a IlvRowSetTableModel.
static RowSet	createRowSet(Connection connection, String command, Object[] parameters, boolean readonly, int pageSize) Creates a RowSet instance with the given parameters that can be used by a IlvRowSetTableModel.
static RowSet	createRowSet(ResultSet resultSet, int pageSize) Creates a RowSet instance with the given parameters that can be used by a IlvRowSetTableModel.
static RowSet	createRowSet(String url, String username, String password, String command, boolean readonly, int pageSize) Creates a RowSet instance with the given parameters that can be used by a IlvRowSetTableModel.
static RowSet	createRowSet(String url, String username, String password, String command, Object[] parameters, boolean readonly, int pageSize) Creates a RowSet instance with the given parameters that can be used by a IlvRowSetTableModel.
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	getRowCount() Returns the number of row in this table model.
RowSet	getRowSet() Returns the RowSet that is connected to this IlvRowSetTableModel.
Object	getValueAt(int rowIndex, int columnIndex) Returns the value at the specified indexes.
void	insertRow(int rowIndex, Object[] rowData) Deprecated. use addRow(Object[]) instead.
boolean	isAutoCommit() Returns whether or not the RowSet will use auto commit.
boolean	isCellEditable(int rowIndex, int columnIndex) Returns whether or not the given cell is editable.
void	refreshRows() Tries to refresh the rows content from the back end.
void	removeRow(int rowIndex) Removes the row at row from the model.
void	rollback() Tries to rollback the rows to the content they have last time a commit occurred.
void	setAutoCommit(boolean value) Tries to override whether or not the RowSet will use auto commit.
void	setRowSet(RowSet rowSet) Initializes the IlvRowSetTableModel instance with the given RowSet.
void	setValueAt(Object value, int rowIndex, int columnIndex) Sets the value at the specified indexes.

Methods inherited from class javax.swing.table.AbstractTableModel

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, removeTableModelListener

Constructor Detail

IlvRowSetTableModel

public IlvRowSetTableModel()

Builds an IlvRowSetTableModel instance to be initialized later on with a call to setRowSet(RowSet).

IlvRowSetTableModel

public IlvRowSetTableModel(RowSet rowSet)
                    throws SQLException

Builds and initializes a IlvRowSetTableModel instance. No autocommit will be performed so commit() must be called when needed. Once the RowSet has been passed to the IlvRowSetTable, user must not interact with it anymore. If caching is needed one can use an implementation of CachedRowSet instead of a regular RowSet.

Parameters:

rowSet - the RowSet used to populate the TableModel

Throws:

SQLException - if a problem occurs with the RowSet

See Also:

setRowSet(RowSet)

IlvRowSetTableModel

public IlvRowSetTableModel(boolean autocommit)

Builds a IlvRowSetTableModel instance to be initialized later on with a call to setRowSet(RowSet).

Parameters:

autocommit - whether or not the IlvRowSetTableModel will be in auto commit mode.

IlvRowSetTableModel

public IlvRowSetTableModel(RowSet rowSet,
                           boolean autocommit)
                    throws SQLException

Builds and initializes a IlvRowSetTableModel instance. Once the RowSet has been passed to the IlvRowSetTable, user must not interact with it anymore. If caching is needed one can use an implementation of CachedRowSet instead of a regular RowSet.

Parameters:

rowSet - the RowSet used to populate the TableModel

autocommit - whether or not the IlvRowSetTableModel will be in auto commit mode.

Throws:

SQLException - if a problem occurs with the RowSet

See Also:

setRowSet(RowSet), setAutoCommit(boolean)

Method Detail

setRowSet

public final void setRowSet(RowSet rowSet)
                     throws SQLException

Initializes the IlvRowSetTableModel instance with the given RowSet. Once the RowSet has been passed to this method, user must not interact with it anymore. If caching is needed one can use an implementation of CachedRowSet instead of a regular RowSet. To fully benefit from disconnected caching the CachedRowSet must not be populated using CachedRowSet.populate() method but by correctly setting connection and query parameters on the CachedRowSet or by calling createRowSet(String, String, String, String, boolean, int) or createRowSet(String, String, String, String, Object[], boolean, int) . The RowSet is never closed by IlvRowSetTableModel and must thus be closed by the user when not needed anymore.

Parameters:

rowSet - the RowSet used to populate the TableModel

Throws:

SQLException - if a problem occurs with the RowSet

See Also:

createRowSet(String, String, String, String, boolean, int), createRowSet(String, String, String, String, Object[], boolean, int)

getRowSet

public final RowSet getRowSet()

Returns the RowSet that is connected to this IlvRowSetTableModel. User must not interact with that RowSet.

Returns:

the RowSet

setAutoCommit

public void setAutoCommit(boolean value)
                   throws SQLException

Tries to override whether or not the RowSet will use auto commit. This works only with RowSet that supports this features (i.e. JdbcRowSet or CachedRowSet). In auto commit mode IlvRowSetTableModel will automatically commit modifications. Otherwise it will wait for a call to commit(). Be careful if you are sharing a Connection among different JdbcRowSet this call may affect several of them and thus it is not recommended to change it.

Parameters:

value - whether or not the RowSet use auto commit.

Throws:

SQLException

See Also:

isAutoCommit()

isAutoCommit

public boolean isAutoCommit()

Returns whether or not the RowSet will use auto commit. In auto commit mode IlvRowSetTableModel will automatically commit modifications. Otherwise it will wait for a call to commit(). The default values is false.

See Also:

setAutoCommit(boolean)

refreshRows

public void refreshRows()
                 throws SQLException

Tries to refresh the rows content from the back end. This might not be possible if the RowSet has not been fully configured with the connection and query parameters. For example RowSet created from createRowSet(ResultSet, int) cannot be refreshed while the ones created from createRowSet(String, String, String, String, boolean, int) or createRowSet(String, String, String, String, Object[], boolean, int) can.

Throws:

SQLException - if the refresh operation is not possible

commit

public void commit()
            throws SQLException

Tries to commit the rows content modifications that occur since last commit to the back end. This method must not be called in auto-commit mode. This does nothing if the RowSet doesn't support commit.

Throws:

SQLException - if commit is not possible

SyncProviderException - if conflicts occur

See Also:

isAutoCommit()

rollback

public void rollback()
              throws SQLException

Tries to rollback the rows to the content they have last time a commit occurred. This method has no impact when the model is in auto-commit mode or if the RowSet doesn't support rollback. When the RowSet is a CachedRowSet in page mode (i.e. CachedRowSet.getPageSize() returns a value different from 0), this method throws an exception as rollback is not possible. When the RowSet has not been fully configured with the connection and query parameters, for example when the RowSet is created from createRowSet(ResultSet, int), this method throws an exception as rollback is not possible.

Throws:

SQLException - if rollback is not possible

See Also:

commit(), isAutoCommit()

getRowCount

public int getRowCount()

Returns the number of row in this table model.

Specified by:

getRowCount in interface TableModel

getColumnCount

public int getColumnCount()

Returns the number of columns in this table model.

Specified by:

getColumnCount in interface TableModel

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.

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Returns the value at the specified indexes.

Specified by:

getValueAt in interface TableModel

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int columnIndex)

Returns whether or not the given cell is editable. If the RowSet is read-only this will always return false .

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractTableModel

setValueAt

public void setValueAt(Object value,
                       int rowIndex,
                       int columnIndex)

Sets the value at the specified indexes.

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractTableModel

addRow

public void addRow(Object[] rowData)

Adds a row. The new row will contain null values unless rowData is specified. Notification of the row being added will be generated.

Specified by:

addRow in interface IlvTableModel

Parameters:

rowData - optional data of the row being added

insertRow

@Deprecated
public void insertRow(int rowIndex,
                                  Object[] rowData)

Deprecated. use addRow(Object[]) instead.

Inserts a row in the model. The new row will contain null values unless rowData is specified. Notification of the row being added will be generated. In IlvRowSetTableModel implementation this method just calls addRow(Object[]).

Specified by:

insertRow in interface IlvTableModel

Parameters:

rowIndex - the row index of the row to be inserted, because of a limitation of most RowSet implementations that row index will be ignored and the insertion my occur any place. In most RowSet implementations, insertion occurs at the end of the model.

rowData - optional data of the row being added

Throws:

ArrayIndexOutOfBoundsException - if the row was invalid

removeRow

public void removeRow(int rowIndex)

Removes the row at row from the model. Notification of the row being removed will be sent to all the listeners.

Specified by:

removeRow in interface IlvTableModel

Parameters:

rowIndex - the row index of the row to be removed

Throws:

ArrayIndexOutOfBoundsException - if the row was invalid

createRowSet

public static RowSet createRowSet(String url,
                                  String username,
                                  String password,
                                  String command,
                                  boolean readonly,
                                  int pageSize)
                           throws SQLException

Creates a RowSet instance with the given parameters that can be used by a IlvRowSetTableModel. Auto commit mode can be set later on using setAutoCommit(boolean).
Warning: This method works with Sun JDK but does not work with all IBM JDKs.

Parameters:

url - the database url to which the RowSet must connect to.

username - the username for the database connection.

password - the password for the database connection.

command - the SQL command that will be executed to retrieve the rows.

readonly - whether or not the RowSet and thus the IlvRowSetTableModel will accept modifications.

pageSize - one of the following values:

• 0 if no caching of the data must be performed
• Integer.MAX_VALUE if full caching of the data must be performed
• another value if paging must be enabled, the value will correspond to the page size, that will allow to save memory but performances will decrease

Returns:

a RowSet

Throws:

SQLException

createRowSet

public static RowSet createRowSet(String url,
                                  String username,
                                  String password,
                                  String command,
                                  Object[] parameters,
                                  boolean readonly,
                                  int pageSize)
                           throws SQLException

Creates a RowSet instance with the given parameters that can be used by a IlvRowSetTableModel. Auto commit mode can be set later on using setAutoCommit(boolean).
Warning: This method works with Sun JDK but does not work with all IBM JDKs.

Parameters:

url - the database url to which the RowSet must connect to.

username - the username for the database connection.

password - the password for the database connection.

command - the SQL command that will be executed to retrieve the rows.

parameters - parameters for the SQL command, or null for none.

readonly - whether or not the RowSet and thus the IlvRowSetTableModel will accept modifications.

pageSize - one of the following values:

• 0 if no caching of the data must be performed
• Integer.MAX_VALUE if full caching of the data must be performed
• another value if paging must be enabled, the value will correspond to the page size, that will allow to save memory but performances will decrease

Returns:

a RowSet

Throws:

SQLException

Since:

JViews 8.8

createRowSet

public static RowSet createRowSet(Connection connection,
                                  String command,
                                  boolean readonly,
                                  int pageSize)
                           throws SQLException

Creates a RowSet instance with the given parameters that can be used by a IlvRowSetTableModel. Auto commit mode can be set later on using setAutoCommit(boolean).

Parameters:

connection - the connection to the database.

command - the SQL command that will be executed to retrieve the rows.

readonly - whether or not the RowSet and thus the IlvRowSetTableModel will accept modifications.

pageSize - one of the following values:

• 0 if no caching of the data must be performed
• Integer.MAX_VALUE if full caching of the data must be performed
• another value if paging must be enabled, the value will correspond to the page size, that will allow to save memory but performances will decrease

Returns:

a RowSet

Throws:

SQLException

createRowSet

public static RowSet createRowSet(Connection connection,
                                  String command,
                                  Object[] parameters,
                                  boolean readonly,
                                  int pageSize)
                           throws SQLException

Creates a RowSet instance with the given parameters that can be used by a IlvRowSetTableModel. Auto commit mode can be set later on using setAutoCommit(boolean).

Parameters:

connection - the connection to the database.

command - the SQL command that will be executed to retrieve the rows.

parameters - parameters for the SQL command, or null for none.

readonly - whether or not the RowSet and thus the IlvRowSetTableModel will accept modifications.

pageSize - one of the following values:

• 0 if no caching of the data must be performed
• Integer.MAX_VALUE if full caching of the data must be performed
• another value if paging must be enabled, the value will correspond to the page size, that will allow to save memory but performances will decrease

Returns:

a RowSet

Throws:

SQLException

Since:

JViews 8.8

createRowSet

public static RowSet createRowSet(ResultSet resultSet,
                                  int pageSize)
                           throws SQLException

Creates a RowSet instance with the given parameters that can be used by a IlvRowSetTableModel. Auto commit mode can be set later on using setAutoCommit(boolean). refreshRows() and rollback() don't work with RowSet created that way. If caching is not used the read-only status will depend on whether or not the ResultSet is updateable. If caching is used such a RowSet can only be read-only.

Parameters:

resultSet - the ResultSet that contains the data. This ResultSet must not be of type ResultSet.TYPE_FORWARD_ONLY.

pageSize - one of the following values:

• 0 if no caching of the data must be performed
• Integer.MAX_VALUE if full caching of the data must be performed
• another value if paging must be enabled, the value will correspond to the page size, that will allow to save memory but performances will decrease

Returns:

a RowSet

Throws:

SQLException - if it is impossible to create the RowSet