com.antelmann.util.table
Class SortableTableModel

java.lang.Object
  com.antelmann.util.table.SortableTableModel

All Implemented Interfaces:

EventListener, TableModelListener, TableModel

public class SortableTableModel
extends Object
implements TableModel, TableModelListener

a wrapper around a TableModel allowing to sort the model. Note that this implementation is not synchronized.

Since:

6/2/06

Author:

Holger Antelmann

Field Summary

static int

NO_COLUMN

Constructor Summary

SortableTableModel(TableModel model, Comparator<?>... comp)
constructs a SortableTableModel with an embedded model and Comparator objects for each column.

SortableTableModel(TableModel model, List<Comparator<?>> comp)
constructs a SortableTableModel with an embedded model and Comparator objects for each column.

Method Summary

void	addTableModelListener(TableModelListener listener)
protected void	finalize() allows itself to be garbage collected by removing itself as a listener to the embedded model
Class<?>	getColumnClass(int column)
int	getColumnCount()
String	getColumnName(int column)
Comparator<?>	getComparatorForColumn(int column) return value may be null, in wich case a UniversalComparator would be used for sorting
TableModel	getModel() returns the embedded model
int	getOriginalRow(int sortedRowPosition)
int	getRowCount()
int	getRowPosition(int originalRow)
List<Integer>	getSortingView() returns an unmodifiable view of the current sorting
Object	getValueAt(int row, int column)
boolean	isCellEditable(int row, int column)
int	lastRowSorted()
boolean	lastSortAscending()
void	removeTableModelListener(TableModelListener listener)
Comparator<?>	setComparatorForColumn(Comparator<?> comp, int column) sets the Comparator for the specified column (may be null, in which case a UniversalComparator is used)
void	setValueAt(Object value, int row, int column)
void	sortByColumn(int column) calls sortByColumn(column, true)
void	sortByColumn(int column, boolean ascending) if column is NO_COLUMN, the table will be reset to be in an unsorted state
void	tableChanged(TableModelEvent ev) public as an implementation side effect; resets the table to its updated model (table is unsorted herafter) unless it's only a single row that has been updated Note that - in case of structural changes - the Comparators set may not be adequate anymore.
void	toggleSorting(int column) either sorts by the given solumn or - if that column is already sorted - reverses the current column sorting (from ascending to descending or vice versa).

Methods inherited from class java.lang.Object

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

Field Detail

NO_COLUMN

public static final int NO_COLUMN

See Also:

Constant Field Values

Constructor Detail

SortableTableModel

public SortableTableModel(TableModel model,
                          Comparator<?>... comp)

constructs a SortableTableModel with an embedded model and Comparator objects for each column. If there are less comparators than columns (or an entry in the array is null), the sorting is either done by the column's natural sorting or (if the column class doesn't implement Comparable) a default Comparator (using the toString() value of an object) is used.

See Also:

UniversalComparator

SortableTableModel

public SortableTableModel(TableModel model,
                          List<Comparator<?>> comp)

constructs a SortableTableModel with an embedded model and Comparator objects for each column. If there are less comparators than columns (or an entry in the list is null), the sorting is either done by the column's natural sorting or (if the column class doesn't implement Comparable) a default Comparator (using the toString() value of an object) is used.

See Also:

UniversalComparator

Method Detail

finalize

protected void finalize()

allows itself to be garbage collected by removing itself as a listener to the embedded model

Overrides:

finalize in class Object

getComparatorForColumn

public Comparator<?> getComparatorForColumn(int column)

return value may be null, in wich case a UniversalComparator would be used for sorting

setComparatorForColumn

public Comparator<?> setComparatorForColumn(Comparator<?> comp,
                                            int column)

sets the Comparator for the specified column (may be null, in which case a UniversalComparator is used). ( @see com.antelmann.util.UniversalComparator

Returns:

the Comparator previously set

tableChanged

public void tableChanged(TableModelEvent ev)

public as an implementation side effect; resets the table to its updated model (table is unsorted herafter) unless it's only a single row that has been updated Note that - in case of structural changes - the Comparators set may not be adequate anymore.

Specified by:

tableChanged in interface TableModelListener

toggleSorting

public void toggleSorting(int column)

either sorts by the given solumn or - if that column is already sorted - reverses the current column sorting (from ascending to descending or vice versa).

sortByColumn

public void sortByColumn(int column)

calls sortByColumn(column, true)

sortByColumn

public void sortByColumn(int column,
                         boolean ascending)
                  throws IllegalArgumentException

if column is NO_COLUMN, the table will be reset to be in an unsorted state

Throws:

IllegalArgumentException

getModel

public TableModel getModel()

returns the embedded model

getOriginalRow

public int getOriginalRow(int sortedRowPosition)

getRowPosition

public int getRowPosition(int originalRow)

getSortingView

public List<Integer> getSortingView()

returns an unmodifiable view of the current sorting

lastRowSorted

public int lastRowSorted()

lastSortAscending

public boolean lastSortAscending()

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 column)

Specified by:

getColumnName in interface TableModel

getColumnClass

public Class<?> getColumnClass(int column)

Specified by:

getColumnClass in interface TableModel

isCellEditable

public boolean isCellEditable(int row,
                              int column)

Specified by:

isCellEditable in interface TableModel

getValueAt

public Object getValueAt(int row,
                         int column)

Specified by:

getValueAt in interface TableModel

setValueAt

public void setValueAt(Object value,
                       int row,
                       int column)

Specified by:

setValueAt in interface TableModel

addTableModelListener

public void addTableModelListener(TableModelListener listener)

Specified by:

addTableModelListener in interface TableModel

removeTableModelListener

public void removeTableModelListener(TableModelListener listener)

Specified by:

removeTableModelListener in interface TableModel