sg.edu.nus.gui.table
Class TableSorter

java.lang.Object
  extended by javax.swing.table.AbstractTableModel
      extended by sg.edu.nus.gui.table.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:

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

Field Summary
static int ASCENDING
          Sorting data objects in an ascending order.
static java.util.Comparator COMPARABLE_COMAPRATOR
          Compare two Comparable object.
static int DESCENDING
          Sorting data objects in a descending order.
static java.util.Comparator LEXICAL_COMPARATOR
          Compare the lexical representation of two objects.
static int NOT_SORTED
          Without sorting data objects.
 
Constructor Summary
TableSorter()
          Construct an empty table sorter.
TableSorter(javax.swing.table.TableModel tableModel)
          Construct a table sorter with specified table model.
TableSorter(javax.swing.table.TableModel tableModel, javax.swing.table.JTableHeader tableHeader)
          Construct a table sorter with specified table mode and table header.
 
Method Summary
 java.lang.Class getColumnClass(int column)
           
 int getColumnCount()
           
 java.lang.String getColumnName(int column)
           
 int getRowCount()
           
 int getSortingStatus(int column)
          Get the sort type of the specified column.
 javax.swing.table.JTableHeader getTableHeader()
          Get the table header.
 javax.swing.table.TableModel getTableModel()
          Get the table model.
 java.lang.Object getValueAt(int row, int column)
           
 boolean isCellEditable(int row, int column)
           
 boolean isSorting()
          Determine if a column is sorting.
 int modelIndex(int viewIndex)
          Determine which column is sorting
 void setColumnComparator(java.lang.Class type, java.util.Comparator comparator)
          Set the type to the column that will be compared in the future.
 void setSortingStatus(int column, int status)
          Set the sort status of the specified column.
 void setTableHeader(javax.swing.table.JTableHeader tableHeader)
          Set the table header.
 void setTableModel(javax.swing.table.TableModel tableModel)
          Set the table model to the table sorter.
 void setValueAt(java.lang.Object aValue, int row, int column)
           
 
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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DESCENDING

public static final int DESCENDING
Sorting data objects in a descending order.

See Also:
Constant Field Values

NOT_SORTED

public static final int NOT_SORTED
Without sorting data objects.

See Also:
Constant Field Values

ASCENDING

public static final int ASCENDING
Sorting data objects in an ascending order.

See Also:
Constant Field Values

COMPARABLE_COMAPRATOR

public static final java.util.Comparator COMPARABLE_COMAPRATOR
Compare two Comparable object.


LEXICAL_COMPARATOR

public static final java.util.Comparator LEXICAL_COMPARATOR
Compare the lexical representation of two objects.

Constructor Detail

TableSorter

public TableSorter()
Construct an empty table sorter.


TableSorter

public TableSorter(javax.swing.table.TableModel tableModel)
Construct a table sorter with specified table model.

Parameters:
tableModel - the table model to be sorted

TableSorter

public TableSorter(javax.swing.table.TableModel tableModel,
                   javax.swing.table.JTableHeader tableHeader)
Construct a table sorter with specified table mode and table header.

Parameters:
tableModel - the table model to be sorted
tableHeader - the table header to be displayed
Method Detail

getTableModel

public javax.swing.table.TableModel getTableModel()
Get the table model.

Returns:
the table model

setTableModel

public void setTableModel(javax.swing.table.TableModel tableModel)
Set the table model to the table sorter.

Parameters:
tableModel - the table model to be assigned to the table sorter

getTableHeader

public javax.swing.table.JTableHeader getTableHeader()
Get the table header.

Returns:
the table header

setTableHeader

public void setTableHeader(javax.swing.table.JTableHeader tableHeader)
Set the table header.

Parameters:
tableHeader - the table header

isSorting

public boolean isSorting()
Determine if a column is sorting.

Returns:
if at least one column is sorting, return true; otherwise, return false

getSortingStatus

public int getSortingStatus(int column)
Get the sort type of the specified column.

Parameters:
column - the column to be checked
Returns:
the sort type

setSortingStatus

public void setSortingStatus(int column,
                             int status)
Set the sort status of the specified column.

Parameters:
column - the column to be sorted
status - the sort status

setColumnComparator

public void setColumnComparator(java.lang.Class type,
                                java.util.Comparator comparator)
Set the type to the column that will be compared in the future.

Parameters:
type - the comparable type
comparator - the comparator

modelIndex

public int modelIndex(int viewIndex)
Determine which column is sorting

Parameters:
viewIndex - the index of the row to be sorted
Returns:
the column index

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