org.bibalex.daf.commongui.datamodels
Class TableSorter

java.lang.Object
  javax.swing.table.AbstractTableModel
      org.bibalex.daf.commongui.datamodels.TableSorter

All Implemented Interfaces:

java.io.Serializable, javax.swing.table.TableModel

public class TableSorter
extends javax.swing.table.AbstractTableModel

TableSorter is a decorator for TableModels; adding sorting functionality to a supplied TableModel. TableSorter does not store or copy the data in its TableModel; instead it maintains a map from the row indexes of the view to the row indexes of the model. As requests are made of the sorter (like getValueAt(row, col)) they are passed to the underlying model after the row numbers have been translated via the internal mapping array. This way, the TableSorter appears to hold another copy of the table with the rows in a different order.

TableSorter registers itself as a listener to the underlying model, just as the JTable itself would. Events recieved from the model are examined, sometimes manipulated (typically widened), and then passed on to the TableSorter's listeners (typically the JTable). If a change to the model has invalidated the order of TableSorter's rows, a note of this is made and the sorter will resort the rows the next time a value is requested.

When the tableHeader property is set, either by using the setTableHeader() method or the two argument constructor, the table header may be used as a complete UI for TableSorter. The default renderer of the tableHeader is decorated with a renderer that indicates the sorting status of each column. In addition, a mouse listener is installed with the following behavior:

• Mouse-click: Clears the sorting status of all other columns and advances the sorting status of that column through three values: {NOT_SORTED, ASCENDING, DESCENDING} (then back to NOT_SORTED again).
• SHIFT-mouse-click: Clears the sorting status of all other columns and cycles the sorting status of the column through the same three values, in the opposite order: {NOT_SORTED, DESCENDING, ASCENDING}.
• CONTROL-mouse-click and CONTROL-SHIFT-mouse-click: as above except that the changes to the column do not cancel the statuses of columns that are already sorting - giving a way to initiate a compound sort.

This is a long overdue rewrite of a class of the same name that first appeared in the swing table demos in 1997.

Version:

2.0 02/27/04

Author:

Philip Milne, Brendon McLean, Dan van Enckevort, Parwinder Sekhon

See Also:

Serialized Form

Nested Class Summary

private static class	TableSorter.Arrow
private static class	TableSorter.Directive
private class	TableSorter.MouseHandler
private class	TableSorter.Row
private class	TableSorter.SortableHeaderRenderer
private class	TableSorter.TableModelHandler

Field Summary

static int	ASCENDING Constant indicating that the sorting is ascending.
private java.util.Map<java.lang.Class,java.util.Comparator>	columnComparators
static java.util.Comparator	COMPARABLE_COMAPRATOR A comparator, used in the sorting algorithm to compare successive rows.
static int	DESCENDING Constant indicating that the sorting is descending.
private static TableSorter.Directive	EMPTY_DIRECTIVE
static java.util.Comparator	LEXICAL_COMPARATOR A comparator, used in the sorting algorithm to compare successive rows.
private int[]	modelToView
private java.awt.event.MouseListener	mouseListener
static int	NOT_SORTED Constant indicating that the table is not sorted.
private java.util.List<TableSorter.Directive>	sortingColumns
private javax.swing.table.JTableHeader	tableHeader
protected javax.swing.table.TableModel	tableModel
private javax.swing.event.TableModelListener	tableModelListener
private TableSorter.Row[]	viewToModel

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

TableSorter()
Constructor.

TableSorter(javax.swing.table.TableModel tableModel)
Constructor, initialized by a TableModel

TableSorter(javax.swing.table.TableModel tableModel, javax.swing.table.JTableHeader tableHeader)
Constructor

Method Summary

private void	cancelSorting()
private void	clearSortingState()
java.lang.Class	getColumnClass(int column)
int	getColumnCount()
java.lang.String	getColumnName(int column)
protected java.util.Comparator	getComparator(int column)
private TableSorter.Directive	getDirective(int column)
protected javax.swing.Icon	getHeaderRendererIcon(int column, int size)
private int[]	getModelToView()
int	getRowCount()
int	getSortingStatus(int column)
javax.swing.table.JTableHeader	getTableHeader()
javax.swing.table.TableModel	getTableModel() Returns the Table Model.
java.lang.Object	getValueAt(int row, int column)
private TableSorter.Row[]	getViewToModel()
boolean	isCellEditable(int row, int column)
boolean	isSorting()
int	modelIndex(int viewIndex)
void	setColumnComparator(java.lang.Class type, java.util.Comparator comparator)
void	setSortingStatus(int column, int status)
void	setTableHeader(javax.swing.table.JTableHeader tableHeader) Sets the Table Header.
void	setTableModel(javax.swing.table.TableModel tableModel) Sets the Table Model.
void	setValueAt(java.lang.Object aValue, int row, int column)
private void	sortingStatusChanged()

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

Field Detail

tableModel

protected javax.swing.table.TableModel tableModel

DESCENDING

public static final int DESCENDING

Constant indicating that the sorting is descending.

See Also:

Constant Field Values

NOT_SORTED

public static final int NOT_SORTED

Constant indicating that the table is not sorted.

See Also:

Constant Field Values

ASCENDING

public static final int ASCENDING

Constant indicating that the sorting is ascending.

See Also:

Constant Field Values

EMPTY_DIRECTIVE

private static TableSorter.Directive EMPTY_DIRECTIVE

COMPARABLE_COMAPRATOR

public static final java.util.Comparator COMPARABLE_COMAPRATOR

A comparator, used in the sorting algorithm to compare successive rows. Used for Objects.

LEXICAL_COMPARATOR

public static final java.util.Comparator LEXICAL_COMPARATOR

A comparator, used in the sorting algorithm to compare successive rows. Used for Strings.

viewToModel

private TableSorter.Row[] viewToModel

modelToView

private int[] modelToView

tableHeader

private javax.swing.table.JTableHeader tableHeader

mouseListener

private java.awt.event.MouseListener mouseListener

tableModelListener

private javax.swing.event.TableModelListener tableModelListener

columnComparators

private java.util.Map<java.lang.Class,java.util.Comparator> columnComparators

sortingColumns

private java.util.List<TableSorter.Directive> sortingColumns

Constructor Detail

TableSorter

public TableSorter()

Constructor.

TableSorter

public TableSorter(javax.swing.table.TableModel tableModel)

Constructor, initialized by a TableModel

Parameters:

tableModel - the TableModel used to initialize the TableSorter

See Also:

TableModel

TableSorter

public TableSorter(javax.swing.table.TableModel tableModel,
                   javax.swing.table.JTableHeader tableHeader)

Constructor

Parameters:

tableModel -

tableHeader -

Method Detail

clearSortingState

private void clearSortingState()

getTableModel

public javax.swing.table.TableModel getTableModel()

Returns the Table Model.

Returns:

the Table Model.

setTableModel

public void setTableModel(javax.swing.table.TableModel tableModel)

Sets the Table Model.

Parameters:

tableModel - The Table Model to be used.

getTableHeader

public javax.swing.table.JTableHeader getTableHeader()

Returns:

the Table Header.

setTableHeader

public void setTableHeader(javax.swing.table.JTableHeader tableHeader)

Sets the Table Header.

Parameters:

tableHeader - The Table Header to be set.

isSorting

public boolean isSorting()

getDirective

private TableSorter.Directive getDirective(int column)

getSortingStatus

public int getSortingStatus(int column)

sortingStatusChanged

private void sortingStatusChanged()

setSortingStatus

public void setSortingStatus(int column,
                             int status)

getHeaderRendererIcon

protected javax.swing.Icon getHeaderRendererIcon(int column,
                                                 int size)

cancelSorting

private void cancelSorting()

setColumnComparator

public void setColumnComparator(java.lang.Class type,
                                java.util.Comparator comparator)

getComparator

protected java.util.Comparator getComparator(int column)

getViewToModel

private TableSorter.Row[] getViewToModel()

modelIndex

public int modelIndex(int viewIndex)

getModelToView

private int[] getModelToView()

getRowCount

public int getRowCount()

getColumnCount

public int getColumnCount()

getColumnName

public java.lang.String getColumnName(int column)

Specified by:

getColumnName in interface javax.swing.table.TableModel

Overrides:

getColumnName in class javax.swing.table.AbstractTableModel

getColumnClass

public java.lang.Class getColumnClass(int column)

Specified by:

getColumnClass in interface javax.swing.table.TableModel

Overrides:

getColumnClass in class javax.swing.table.AbstractTableModel

isCellEditable

public boolean isCellEditable(int row,
                              int column)

Specified by:

isCellEditable in interface javax.swing.table.TableModel

Overrides:

isCellEditable in class javax.swing.table.AbstractTableModel

getValueAt

public java.lang.Object getValueAt(int row,
                                   int column)

setValueAt

public void setValueAt(java.lang.Object aValue,
                       int row,
                       int column)

Specified by:

setValueAt in interface javax.swing.table.TableModel

Overrides:

setValueAt in class javax.swing.table.AbstractTableModel