us.daveread.basicquery.util

Class TableSorter

java.lang.Object

javax.swing.table.AbstractTableModel

us.daveread.basicquery.util.TableMap

us.daveread.basicquery.util.TableSorter

All Implemented Interfaces:

java.io.Serializable, java.util.EventListener, javax.swing.event.TableModelListener, javax.swing.table.TableModel

public class TableSorter
extends TableMap

A sorter for TableModels. The sorter has a model (conforming to TableModel) and itself implements TableModel. TableSorter does not store or copy the data in the TableModel, instead it maintains an array of integers which it keeps the same size as the number of rows in its model. When the model changes it notifies the sorter that something has changed eg. "rowsAdded" so that its internal array of integers can be reallocated. As requests are made of the sorter (like getValueAt(row, col) it redirects them to its model via the mapping array. That way the TableSorter appears to hold another copy of the table with the rows in a different order. The sorting algorithm used is stable which means that it does not move around rows when its comparison function returns 0 to denote that they are equivalent.

Original version 1.5 12/17/97

Author:

Philip Milne

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	ascending Whether sort is ascending
private int	compares Track the comparison result of two rows
private int[]	indexes Sorted indexes
private static org.apache.log4j.Logger	LOGGER Logger
private java.util.List<java.awt.event.MouseAdapter>	myMouseListeners The listeners registered for mouse events on the table DSR - So I can remove them
private static long	serialVersionUID Serial UID
private java.util.Vector<java.lang.Integer>	sortingColumns Columns used to sort the model

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
TableSorter() Constructs a Table Sorter Creates an integer array for consistency
TableSorter(javax.swing.table.TableModel model) Constructs a Table Sorter

Method Summary

Methods

Modifier and Type	Method and Description
void	addMouseListenerToHeaderInTable(javax.swing.JTable table) Adds a mouse listener to the Table to trigger a table sort when a column heading is clicked in the JTable.
private void	checkModel() Checks if there has been any uninformed change in the model
private int	compare(int row1, int row2) Compares values in row1 and row2
private int	compareRowsByColumn(int row1, int row2, int column) Compares the values of two rows in a column
java.lang.Object	getValueAt(int aRow, int aColumn) Gets the value of the model at indexes[aRow] and aColumn
private void	reallocateIndexes() Set up a new mapping array of indexes with the right number of elements for the new data model
void	removeModel(javax.swing.table.TableModel model) Remove the Model model
void	removeMouseListenerFromHeaderInTable(javax.swing.JTable table) Need ability to remove mouselistener Otherwise creation of new sorter leaks memory
void	setModel(javax.swing.table.TableModel model) Sets the data model for this table to model and registers with it for listener notifications from the new data model.
void	setValueAt(java.lang.Object aValue, int aRow, int aColumn) Sets the value of the model at aRow and aColumn to aValue
private void	shuttlesort(int[] from, int[] to, int low, int high) This is a home-grown implementation which we have not had time to research - it may perform poorly in some circumstances.
private void	sort(java.lang.Object sender) Performs sort operation on the sender
private void	sortByColumn(int column, boolean pAscending) Sorts the column in an ascending order
void	sortByColumns(int[] columns) Calls the method sortByColumns(int,boolean) after setting the sorting option as ascending
void	sortByColumns(int[] columns, boolean pAscending) Sort the data by the selected columns
void	tableChanged(javax.swing.event.TableModelEvent e) The tableChanged Method is called when any change is made to the table

Methods inherited from class us.daveread.basicquery.util.TableMap

getColumnClass, getColumnCount, getColumnName, getModel, getRowCount, isCellEditable

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

serialVersionUID

private static final long serialVersionUID

Serial UID

See Also:

Constant Field Values

LOGGER

private static final org.apache.log4j.Logger LOGGER

Logger

indexes

private int[] indexes

Sorted indexes

sortingColumns

private java.util.Vector<java.lang.Integer> sortingColumns

Columns used to sort the model

ascending

private boolean ascending

Whether sort is ascending

compares

private int compares

Track the comparison result of two rows

myMouseListeners

private java.util.List<java.awt.event.MouseAdapter> myMouseListeners

The listeners registered for mouse events on the table DSR - So I can remove them

Constructor Detail

TableSorter

public TableSorter()

Constructs a Table Sorter Creates an integer array for consistency

TableSorter

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

Constructs a Table Sorter

Parameters:

model - The Table Model Object

Method Detail

setModel

public void setModel(javax.swing.table.TableModel model)

Sets the data model for this table to model and registers with it for listener notifications from the new data model.

Overrides:

setModel in class TableMap

Parameters:

model - The TableModel Object

removeModel

public void removeModel(javax.swing.table.TableModel model)

Remove the Model model

Overrides:

removeModel in class TableMap

Parameters:

model - The Table Model object to be removed

compareRowsByColumn

private int compareRowsByColumn(int row1,
                      int row2,
                      int column)

Compares the values of two rows in a column

Parameters:

row1 - row index

row2 - row index

column - column index

Returns:

int Returns values -1,0,1 depending on the sort results

compare

private int compare(int row1,
          int row2)

Compares values in row1 and row2

Parameters:

row1 - row index

row2 - row index

Returns:

int

reallocateIndexes

private void reallocateIndexes()

Set up a new mapping array of indexes with the right number of elements for the new data model

tableChanged

public void tableChanged(javax.swing.event.TableModelEvent e)

The tableChanged Method is called when any change is made to the table

Specified by:

tableChanged in interface javax.swing.event.TableModelListener

Overrides:

tableChanged in class TableMap

Parameters:

e - The Table ModelEvent

checkModel

private void checkModel()

Checks if there has been any uninformed change in the model

sort

private void sort(java.lang.Object sender)

Performs sort operation on the sender

Parameters:

sender - Object that is to sorted

shuttlesort

private void shuttlesort(int[] from,
               int[] to,
               int low,
               int high)

This is a home-grown implementation which we have not had time to research - it may perform poorly in some circumstances. It requires twice the space of an in-place algorithm and makes NlogN assigments shuttling the values between the two arrays. The number of compares appears to vary between N-1 and NlogN depending on the initial order but the main reason for using it here is that, unlike qsort, it is stable.

Parameters:

from - [] array that has to be sorted

to - [] array that has the sorted result

low - Starting row index 1

high - Maximum number of rows

getValueAt

public java.lang.Object getValueAt(int aRow,
                          int aColumn)

Gets the value of the model at indexes[aRow] and aColumn

Specified by:

getValueAt in interface javax.swing.table.TableModel

Overrides:

getValueAt in class TableMap

Parameters:

aRow - row index

aColumn - column index

Returns:

model The tableModel with its value at indexes[aRow] and aColumn

setValueAt

public void setValueAt(java.lang.Object aValue,
              int aRow,
              int aColumn)

Sets the value of the model at aRow and aColumn to aValue

Specified by:

setValueAt in interface javax.swing.table.TableModel

Overrides:

setValueAt in class TableMap

Parameters:

aValue - The value to assign

aRow - row index

aColumn - column index

sortByColumn

private void sortByColumn(int column,
                boolean pAscending)

Sorts the column in an ascending order

Parameters:

column - column index

pAscending - the column is sorted in an ascending order

sortByColumns

public void sortByColumns(int[] columns)

Calls the method sortByColumns(int,boolean) after setting the sorting option as ascending

Parameters:

columns - The column values

sortByColumns

public void sortByColumns(int[] columns,
                 boolean pAscending)

Sort the data by the selected columns

Parameters:

columns - The columns to sort the data by

pAscending - A boolean value that determines whether the column is sorted in an ascending or descending order

addMouseListenerToHeaderInTable

public void addMouseListenerToHeaderInTable(javax.swing.JTable table)

Adds a mouse listener to the Table to trigger a table sort when a column heading is clicked in the JTable.

Parameters:

table - The JTabel object

removeMouseListenerFromHeaderInTable

public void removeMouseListenerFromHeaderInTable(javax.swing.JTable table)

Need ability to remove mouselistener Otherwise creation of new sorter leaks memory

Parameters:

table - The JTable object