net.sf.cuf.ui.table

Class TableSorter

java.lang.Object

javax.swing.table.AbstractTableModel

net.sf.cuf.ui.table.TableMap

net.sf.cuf.ui.table.TableSorter

All Implemented Interfaces:

Serializable, EventListener, TableModelListener, 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 algorthm used is stable which means that it does not move around rows when its comparison function returns 0 to denote that they are equivalent.
Taken originally from "The Java Tutorial" by Sun Microsystems. Original Source was version 1.5 12/17/97 author Philip Milne.

Author:

Jörg Eichhorn, sd&m AG

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.cuf.ui.table.TableMap

mModel

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
TableSorter(TableModel pModel) Create new TableSorter for given table model.

Method Summary

Methods

Modifier and Type	Method and Description
protected int	compare(int pRow1, int pRow2) Compare two rows of tablemodel holding data.
protected int	compareRowsByColumn(int pRow1, int pRow2, int pColumn) Compare two rows of tablemodel holding data with respect to given column.
void	dropSorting() Drop the sorting criteria for this table model but keep the current row order.
int	getModelRow(int pRow) Map view-index of table row to model-index.
TableSortInfo	getSortInfo() Get current sorting info.
Object	getValueAt(int pRow, int pColumn) Returns an attribute value for the cell at aRow and aColumn.
int	getViewRow(int pRow) Map model-index of table row to view-index.
boolean	isSorted(int pColumn) Check if given column is a sorted column.
void	resetColumns() Reset all previous set sorting info.
void	setModel(TableModel pModel) Set a new TableModel.
void	setValueAt(Object pValue, int pRow, int pColumn) Sets an attribute value for the record in the cell at aRow and aColumn.
protected void	sort() Sort data in tablemodel according to columns set up via sortByColumn.
void	sortByColumn(int pColumn) Sort data according to specified column.
void	sortByColumn(int pColumn, boolean pAscending) Sort data according to specified column.
void	tableChanged(TableModelEvent pEvent) Callback from TableModel.

Methods inherited from class net.sf.cuf.ui.table.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

Constructor Detail

TableSorter

public TableSorter(TableModel pModel)

Create new TableSorter for given table model.

Parameters:

pModel - table model holding data to be displayed

Method Detail

setModel

public void setModel(TableModel pModel)

Set a new TableModel.

Overrides:

setModel in class TableMap

Parameters:

pModel - the new TableModel

getModelRow

public int getModelRow(int pRow)

Map view-index of table row to model-index.

Parameters:

pRow - row-index from view

Returns:

row-index for model

getViewRow

public int getViewRow(int pRow)

Map model-index of table row to view-index.

Parameters:

pRow - row-index from model

Returns:

row-index for view

isSorted

public boolean isSorted(int pColumn)

Check if given column is a sorted column.

Parameters:

pColumn - index of the column to check

Returns:

given column is a sorted column

tableChanged

public void tableChanged(TableModelEvent pEvent)

Callback from TableModel. Our superclass is a TableModelListener, so we are too. This method overrides the implementation of our superclass.

Specified by:

tableChanged in interface TableModelListener

Overrides:

tableChanged in class TableMap

Parameters:

pEvent - tableModelEvent from tableModel

getValueAt

public Object getValueAt(int pRow,
                int pColumn)

Returns an attribute value for the cell at aRow and aColumn.

Specified by:

getValueAt in interface TableModel

Overrides:

getValueAt in class TableMap

Parameters:

pRow - the row whose value is to be looked up

pColumn - the column whose value is to be looked up

Returns:

the value Object at the specified cell

setValueAt

public void setValueAt(Object pValue,
              int pRow,
              int pColumn)

Sets an attribute value for the record in the cell at aRow and aColumn. aValue is the new value.

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class TableMap

Parameters:

pValue - the new value

pRow - the row whose value is to be changed

pColumn - the column whose value is to be changed

sortByColumn

public void sortByColumn(int pColumn)

Sort data according to specified column. The sorting will be done ascending.

Parameters:

pColumn - the modelindex of the column

sortByColumn

public void sortByColumn(int pColumn,
                boolean pAscending)

Sort data according to specified column. Sort will be performed immediately with respect to all columns previously added. Adding an already set sorting anew will move its criteria downwards in priority.

To start a fresh sort call resetColumns() first.

Parameters:

pColumn - the modelindex of the column

pAscending - the sorting direction

dropSorting

public void dropSorting()

Drop the sorting criteria for this table model but keep the current row order.

resetColumns

public void resetColumns()

Reset all previous set sorting info. Will also reset result of last sorting.

getSortInfo

public TableSortInfo getSortInfo()

Get current sorting info.

Returns:

unmodifiable TableSortInfo object

sort

protected void sort()

Sort data in tablemodel according to columns set up via sortByColumn.

This method is made protected as a hook for different sorting implementations.

compareRowsByColumn

protected int compareRowsByColumn(int pRow1,
                      int pRow2,
                      int pColumn)

Compare two rows of tablemodel holding data with respect to given column.

This method is made protected as a hook for different sorting implementations.

Parameters:

pRow1 - first row of compare

pRow2 - second row of compare

pColumn - column to use for compare

Returns:

negative value, if row1 < row2. positive value, if row1 > row2. zero, if row1 == row2.

compare

protected int compare(int pRow1,
          int pRow2)

Compare two rows of tablemodel holding data. Compares rows with respect to information in sortingColumns.

This method is made protected as a hook for different sorting implementations.

Parameters:

pRow1 - first row of compare

pRow2 - second row of compare

Returns:

negative value, if row1 < row2. positive value, if row1 > row2. zero, if row1 == row2.