net.shredzone.jshred.swing

Class SortableTableModelProxy

java.lang.Object

net.shredzone.jshred.swing.SortableTableModelProxy

All Implemented Interfaces:

Serializable, EventListener, TableModelListener, TableModel, ExtendedSortableTableModel, SortableTableModel

public class SortableTableModelProxy
extends Object
implements ExtendedSortableTableModel, TableModelListener, Serializable

The SortTableModelProxy wraps another TableModel, and allows to sort it by one of its columns. Other TableModel calls are forwarded to it.

The sorting of the rows takes place in this proxy only. The master TableModel is not changed in any way by the sorting procedure. You should keep in mind though, that the rows will be re-sorted after every single manipulation to the master TableModel.

The liaison between the SortableTableModel and its master TableModel is for a lifetime. If you want to change the master TableModel, you will have to generate a new SortTableModel and feed it to the JTable. This TableModel is best suited for the JSortedTable, but not limited to it. You can also use SortableTableModelProxy instances for classic JTable, if you want to keep control of the column sorting.

Note that this is just a proxy, not a TableModel itself. You should not extend this class in order to create a sorted TableModel, but inherit from standard TableModels, and then pass your TableModel to the SortTableModelProxy constructor.

Author:

Richard "Shred" Körber

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SortableTableModelProxy(TableModel master) Creates a new SortableTableModelProxy for a master TableModel.

Method Summary

Modifier and Type	Method and Description
void	addTableModelListener(TableModelListener l) Adds a TableModelListener.
protected void	fireTableDataChanged() Notifies all TableModelListener that the sort order was changed.
Class<?>	getColumnClass(int columnIndex)
int	getColumnCount()
String	getColumnName(int columnIndex)
TableModel	getMasterTable() Gets the master table that is connected to this SortableTableModelProxy.
int	getRowCount()
int	getSortedColumn() Gets the index of the column that is currently sorted.
Object	getValueAt(int rowIndex, int columnIndex)
boolean	isCellEditable(int rowIndex, int columnIndex)
boolean	isColumnSortable(int columnIndex) Returns true if a column is sortable.
boolean	isDescending() Gets the current sort order.
int	mapRow(int row) Maps a row number to the appropriate row number in the master TableModel.
protected void	rebuildIndexMap() Rebuilds the internal index map array.
void	removeTableModelListener(TableModelListener l) Removes a TableModelListener.
protected void	resort() Sorts the entire TableModel again.
void	setValueAt(Object aValue, int rowIndex, int columnIndex)
void	sortByColumn(int columnIndex) Sorts by a certain column, ascending.
void	sortByColumn(int columnIndex, boolean desc) Sorts by a certain column in the given order.
void	sortByColumnDesc(int columnIndex) Sorts by a certain column, descending.
void	tableChanged(TableModelEvent e) Internal TableModelListener implementation, do not use!
int	unmapRow(int row) Maps a row number of the master TableModel to the current row number of the SortableTableModel.

Methods inherited from class java.lang.Object

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

Constructor Detail

SortableTableModelProxy

public SortableTableModelProxy(TableModel master)

Creates a new SortableTableModelProxy for a master TableModel. The object will give a modified view to the master TableModel that allows to sort it by a certain column.

Parameters:

master - Master TableModel

Method Detail

getMasterTable

public TableModel getMasterTable()

Gets the master table that is connected to this SortableTableModelProxy.

Returns:

The master TableModel

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface TableModel

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface TableModel

getColumnName

public String getColumnName(int columnIndex)

Specified by:

getColumnName in interface TableModel

getColumnClass

public Class<?> getColumnClass(int columnIndex)

Specified by:

getColumnClass in interface TableModel

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int columnIndex)

Specified by:

isCellEditable in interface TableModel

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Specified by:

getValueAt in interface TableModel

setValueAt

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

Specified by:

setValueAt in interface TableModel

mapRow

public int mapRow(int row)

Maps a row number to the appropriate row number in the master TableModel.

Parameters:

row - Row number of this model

Returns:

Row number of the row in the master TableModel.

Since:

R3

unmapRow

public int unmapRow(int row)

Maps a row number of the master TableModel to the current row number of the SortableTableModel.

Parameters:

row - Row number of the master TableModel

Returns:

Appropriate current row number of this model.

Since:

R3

sortByColumn

public void sortByColumn(int columnIndex)

Sorts by a certain column, ascending.

Parameters:

columnIndex - Column to sort at.

sortByColumnDesc

public void sortByColumnDesc(int columnIndex)

Sorts by a certain column, descending.

Parameters:

columnIndex - Column to sort at.

sortByColumn

public void sortByColumn(int columnIndex,
                         boolean desc)

Sorts by a certain column in the given order.

Specified by:

sortByColumn in interface SortableTableModel

Parameters:

columnIndex - Column to sort at.

desc - true: descending, false: ascending

getSortedColumn

public int getSortedColumn()

Gets the index of the column that is currently sorted.

Specified by:

getSortedColumn in interface SortableTableModel

Returns:

Currently sorted column.

isDescending

public boolean isDescending()

Gets the current sort order.

Specified by:

isDescending in interface SortableTableModel

Returns:

true: descending, false: ascending

resort

protected void resort()

Sorts the entire TableModel again.

rebuildIndexMap

protected void rebuildIndexMap()

Rebuilds the internal index map array. This is always required when the master TableModel changed its number of rows.

tableChanged

public void tableChanged(TableModelEvent e)

Internal TableModelListener implementation, do not use!

Specified by:

tableChanged in interface TableModelListener

addTableModelListener

public void addTableModelListener(TableModelListener l)

Adds a TableModelListener. It will be added to the master TableModel as well as to this SortTableModelProxy. The listener will be notified whenever the master TableModel, or the column to be sorted, was changed.

Specified by:

addTableModelListener in interface TableModel

Parameters:

l - TableModelListener

removeTableModelListener

public void removeTableModelListener(TableModelListener l)

Removes a TableModelListener. If it was not added, nothing will happen. Make sure that you use the proxy removeTableModelListener(TableModelListener) when you have used the proxy addTableModelListener(TableModelListener).

Specified by:

removeTableModelListener in interface TableModel

Parameters:

l - TableModelListener

fireTableDataChanged

protected void fireTableDataChanged()

Notifies all TableModelListener that the sort order was changed.

isColumnSortable

public boolean isColumnSortable(int columnIndex)

Returns true if a column is sortable. This method always returns true. It can be overridden to avoid sorting of different columns.

Specified by:

isColumnSortable in interface ExtendedSortableTableModel

Parameters:

columnIndex - Column index to check

Returns:

Always true

Since:

R15