org.jminor.swing.common.model.table

Class AbstractTableSortModel<R,C>

java.lang.Object

org.jminor.swing.common.model.table.AbstractTableSortModel<R,C>

Type Parameters:

R - the type representing a row in the table model

C - the type representing the column identifier in the table model

All Implemented Interfaces:

TableSortModel<R,C,javax.swing.table.TableColumn>

Direct Known Subclasses:

SwingEntityTableModel.DefaultEntityTableSortModel

public abstract class AbstractTableSortModel<R,C>
extends java.lang.Object
implements TableSortModel<R,C,javax.swing.table.TableColumn>

A default TableSortModel implementation

Nested Class Summary

Nested classes/interfaces inherited from interface org.jminor.common.model.table.TableSortModel

TableSortModel.SortingState

Constructor Summary

Constructors

Constructor and Description
AbstractTableSortModel(java.util.List<javax.swing.table.TableColumn> columns) Instantiates a new AbstractTableSortModel

Method Summary

Modifier and Type	Method and Description
void	addSortingStateChangedListener(EventListener listener)
java.util.List<javax.swing.table.TableColumn>	getColumns()
protected abstract java.lang.Comparable	getComparable(R rowObject, C columnIdentifier) Returns a Comparable instance for the given rowObject and columnIdentifier, used when sorting
TableSortModel.SortingState	getSortingState(C columnIdentifier)
protected java.util.Comparator	initializeColumnComparator(C columnIdentifier) Initializes a comparator used when sorting by the give column, the comparator receives the column values, but never null.
boolean	isSortingEnabled()
void	setSortingDirective(C columnIdentifier, SortingDirective directive, boolean addColumnToSort)
void	sort(java.util.List<R> items) Sorts the given list according to the sort configuration

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jminor.common.model.table.TableSortModel

getColumnClass

Constructor Detail

AbstractTableSortModel

public AbstractTableSortModel(java.util.List<javax.swing.table.TableColumn> columns)

Instantiates a new AbstractTableSortModel

Parameters:

columns - the table columns

Method Detail

sort

public final void sort(java.util.List<R> items)

Sorts the given list according to the sort configuration

Specified by:

sort in interface TableSortModel<R,C,javax.swing.table.TableColumn>

Parameters:

items - the items to sort

getColumns

public final java.util.List<javax.swing.table.TableColumn> getColumns()

Specified by:

getColumns in interface TableSortModel<R,C,javax.swing.table.TableColumn>

Returns:

a list containing all the columns this sort model is based on

getSortingState

public final TableSortModel.SortingState getSortingState(C columnIdentifier)

Specified by:

getSortingState in interface TableSortModel<R,C,javax.swing.table.TableColumn>

Parameters:

columnIdentifier - the column identifier

Returns:

the TableSortModel.SortingState associated with the given column

setSortingDirective

public final void setSortingDirective(C columnIdentifier,
                                      SortingDirective directive,
                                      boolean addColumnToSort)

Specified by:

setSortingDirective in interface TableSortModel<R,C,javax.swing.table.TableColumn>

Parameters:

columnIdentifier - the identifier of the column to sort by

directive - the sorting directive

addColumnToSort - if false then the sorting state is cleared, otherwise this column is added to the sorted column set according to sorting priority

See Also:

TableSortModel.getSortingState(Object)

isSortingEnabled

public final boolean isSortingEnabled()

Specified by:

isSortingEnabled in interface TableSortModel<R,C,javax.swing.table.TableColumn>

Returns:

true if sorting is enabled for one or more columns

addSortingStateChangedListener

public final void addSortingStateChangedListener(EventListener listener)

Specified by:

addSortingStateChangedListener in interface TableSortModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - a listener notified each time the sorting state changes

getComparable

protected abstract java.lang.Comparable getComparable(R rowObject,
                                                      C columnIdentifier)

Returns a Comparable instance for the given rowObject and columnIdentifier, used when sorting

Parameters:

rowObject - the object representing a given row

columnIdentifier - the column identifier

Returns:

a Comparable for the given row and column

See Also:

sort(java.util.List)

initializeColumnComparator

protected java.util.Comparator initializeColumnComparator(C columnIdentifier)

Initializes a comparator used when sorting by the give column, the comparator receives the column values, but never null.

Parameters:

columnIdentifier - the column identifier

Returns:

the comparator to use when sorting by the given column