org.jminor.swing.common.model.table

Class AbstractFilteredTableModel<R,C>

java.lang.Object

javax.swing.table.AbstractTableModel

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

Type Parameters:

R - the type representing the rows in this table model

C - type type used to identify columns in this table model, Integer for simple indexed identification for example

All Implemented Interfaces:

java.io.Serializable, javax.swing.table.TableModel, FilteredModel<R>, Refreshable, FilteredTableModel<R,C,javax.swing.table.TableColumn>

Direct Known Subclasses:

SwingEntityTableModel

public abstract class AbstractFilteredTableModel<R,C>
extends javax.swing.table.AbstractTableModel
implements FilteredTableModel<R,C,javax.swing.table.TableColumn>

A TableModel implementation that supports filtering, searching and sorting.

 AbstractFilteredTableModel tableModel = ...;
 JTable table = new JTable(tableModel, tableModel.getColumnModel(), tableModel.getSelectionModel());
 

User: Björn Darri
Sorting functionality originally based on TableSorter by Philip Milne, Brendon McLean, Dan van Enckevort and Parwinder Sekhon
Date: 18.4.2010
Time: 09:48:07

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractFilteredTableModel.DefaultColumnValueProvider A default ColumnValueProvider implementation

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
AbstractFilteredTableModel(TableSortModel<R,C,javax.swing.table.TableColumn> sortModel, java.util.Collection<? extends ColumnConditionModel<C>> columnFilterModels) Instantiates a new table model.

Method Summary

Modifier and Type	Method and Description
void	addFilteringListener(EventListener listener)
protected void	addItems(java.util.List<R> items, boolean atTop, boolean sortAfterAdding) Adds the given items to this table model, non-filtered items are added at top or bottom.
protected void	addItems(java.util.List<R> items, int index, boolean sortAfterAdding) Adds the given items to this table model, non-filtered items are added at the given index.
void	addRefreshDoneListener(EventListener listener)
void	addRefreshStartedListener(EventListener listener)
void	addRowsDeletedListener(EventDataListener<java.util.List<java.lang.Integer>> listener) Adds a listener that is notified each time rows are deleted from the data model.
void	addSortingListener(EventListener listener)
void	addTableDataChangedListener(EventListener listener)
void	addTableModelClearedListener(EventListener listener)
boolean	allowSelectionChange() A default implementation returning true
void	clear() Clears all data from this refreshable instance
boolean	contains(R item, boolean includeFiltered) Returns true if this model contains the given item, visible or filtered.
protected ColumnSummaryModel.ColumnValueProvider	createColumnValueProvider(C columnIdentifier) Creates a ColumnValueProvider for the given column
protected abstract void	doRefresh() Refreshes the data in this table model.
void	filterContents() Filters the table according to the condition returned by getFilterCondition().
RowColumn	findNextItemCoordinate(int fromIndex, boolean forward, FilterCondition<java.lang.Object> condition) Returns a RowColumn denoting the row and column index of the first value to fulfill the given search condition.
RowColumn	findNextItemCoordinate(int fromIndex, boolean forward, java.lang.String searchText) Returns a RowColumn denoting the row and column index of the first value to fulfill the given search condition.
java.util.List<R>	getAllItems()
java.lang.Class	getColumnClass(int columnIndex)
int	getColumnCount()
SwingFilteredTableColumnModel<C>	getColumnModel()
ColumnSummaryModel	getColumnSummaryModel(C columnIdentifier)
FilterCondition<R>	getFilterCondition() Returns the filter condition defined by this model, null if no filter condition has been set.
int	getFilteredItemCount()
java.util.List<R>	getFilteredItems()
R	getItemAt(int index)
int	getRowCount()
protected FilterCondition<java.lang.Object>	getSearchCondition(java.lang.String searchText)
protected java.lang.String	getSearchValueAt(int rowIndex, javax.swing.table.TableColumn column) Returns the value to use when searching through the table.
SelectionModel<R>	getSelectionModel()
TableSortModel<R,C,javax.swing.table.TableColumn>	getSortModel()
java.util.Collection	getValues(C columnIdentifier, boolean selectedOnly)
int	getVisibleItemCount()
java.util.List<R>	getVisibleItems()
int	indexOf(R item)
boolean	isFiltered(R item) Returns true if the given item is being filtered in this model, that is, is not visible
boolean	isRegularExpressionSearch()
boolean	isVisible(R item) Returns true if the given item is visible, that is, not filtered in this model
void	refresh() Refreshes the data in this table model, respecting the selection, filtering as well as sorting states.
void	removeFilteringListener(EventListener listener)
void	removeItem(R item) Removes the given item from this table model
void	removeItems(java.util.Collection<R> items) Removes the given items from this table model
void	removeItems(int fromIndex, int toIndex) Removes from this table model all visible elements whose index is between fromIndex, inclusive and toIndex, exclusive
void	removeRefreshDoneListener(EventListener listener)
void	removeRefreshStartedListener(EventListener listener)
void	removeRowsDeletedListener(EventDataListener listener)
void	removeSortingListener(EventListener listener)
void	removeTableDataChangedListener(EventListener listener)
void	removeTableModelClearedListener(EventListener listener)
void	setFilterCondition(FilterCondition<R> filterCondition) Sets the filter condition and filters the model
void	setRegularExpressionSearch(boolean value) Specifies whether or not to use regular expressions when searching this table model
void	sortContents() Sorts the visible contents according to the TableSortModel, keeping the selection state intact

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getColumnName, getListeners, getTableModelListeners, isCellEditable, removeTableModelListener, setValueAt

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.table.TableModel

getValueAt

Constructor Detail

AbstractFilteredTableModel

public AbstractFilteredTableModel(TableSortModel<R,C,javax.swing.table.TableColumn> sortModel,
                                  java.util.Collection<? extends ColumnConditionModel<C>> columnFilterModels)

Instantiates a new table model.

Parameters:

sortModel - the sort model to use

columnFilterModels - the column filter models

Throws:

java.lang.NullPointerException - in case columnModel is null

Method Detail

getVisibleItems

public final java.util.List<R> getVisibleItems()

Specified by:

getVisibleItems in interface FilteredModel<R>

Returns:

an unmodifiable view of the visible items

getFilteredItems

public final java.util.List<R> getFilteredItems()

Specified by:

getFilteredItems in interface FilteredModel<R>

Returns:

an unmodifiable view of the filtered items

getVisibleItemCount

public final int getVisibleItemCount()

Specified by:

getVisibleItemCount in interface FilteredModel<R>

Returns:

the number of currently visible items

getFilteredItemCount

public final int getFilteredItemCount()

Specified by:

getFilteredItemCount in interface FilteredModel<R>

Returns:

the number of currently filtered items

getColumnCount

public final int getColumnCount()

Specified by:

getColumnCount in interface javax.swing.table.TableModel

getRowCount

public final int getRowCount()

Specified by:

getRowCount in interface javax.swing.table.TableModel

Specified by:

getRowCount in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Returns:

the size of the table model

contains

public final boolean contains(R item,
                              boolean includeFiltered)

Returns true if this model contains the given item, visible or filtered.

Specified by:

contains in interface FilteredModel<R>

Parameters:

item - the item

includeFiltered - if true then the filtered items are included

Returns:

true if this model contains the item

isVisible

public final boolean isVisible(R item)

Returns true if the given item is visible, that is, not filtered in this model

Specified by:

isVisible in interface FilteredModel<R>

Parameters:

item - the item

Returns:

true if the given item is visible

isFiltered

public final boolean isFiltered(R item)

Returns true if the given item is being filtered in this model, that is, is not visible

Specified by:

isFiltered in interface FilteredModel<R>

Parameters:

item - the item

Returns:

true if the given item is filtered

findNextItemCoordinate

public final RowColumn findNextItemCoordinate(int fromIndex,
                                              boolean forward,
                                              java.lang.String searchText)

Returns a RowColumn denoting the row and column index of the first value to fulfill the given search condition.

Specified by:

findNextItemCoordinate in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

fromIndex - the row index to start searching at, if this is larger than the size of the table model or less than 0 the search starts from either 0 or rowCount - 1 depending on search direction.

forward - if true then the search is forward (towards higher row indexes), backwards otherwise

searchText - the text to search by

Returns:

the search result coordinate, null if nothing was found

See Also:

FilteredTableModel.isRegularExpressionSearch(), FilterCondition.include(Object)

findNextItemCoordinate

public final RowColumn findNextItemCoordinate(int fromIndex,
                                              boolean forward,
                                              FilterCondition<java.lang.Object> condition)

Returns a RowColumn denoting the row and column index of the first value to fulfill the given search condition.

Specified by:

findNextItemCoordinate in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

fromIndex - the row index to start searching at, if this is larger than the size of the table model or less than 0 the search starts from either 0 or rowCount - 1 depending on search direction.

forward - if true then the search is forward (towards higher row indexes), backwards otherwise

condition - the search condition

Returns:

the search result coordinate, null if nothing was found

See Also:

FilterCondition.include(Object)

refresh

public final void refresh()

Refreshes the data in this table model, respecting the selection, filtering as well as sorting states.

Specified by:

refresh in interface Refreshable

clear

public final void clear()

Clears all data from this refreshable instance

Specified by:

clear in interface Refreshable

getSelectionModel

public final SelectionModel<R> getSelectionModel()

Specified by:

getSelectionModel in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Returns:

the selection model used by this table model

getSortModel

public final TableSortModel<R,C,javax.swing.table.TableColumn> getSortModel()

Specified by:

getSortModel in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Returns:

the sorting model

getColumnSummaryModel

public final ColumnSummaryModel getColumnSummaryModel(C columnIdentifier)

Specified by:

getColumnSummaryModel in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

columnIdentifier - the column identifier

Returns:

the ColumnSummaryModel for the column identified by the given

getValues

public final java.util.Collection getValues(C columnIdentifier,
                                            boolean selectedOnly)

Specified by:

getValues in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

columnIdentifier - the identifier of the column for which to retrieve the values

selectedOnly - if true only values from the selected rows are returned

Returns:

the values (including nulls) of the column identified by columnIdentifier from the rows in the table model

isRegularExpressionSearch

public final boolean isRegularExpressionSearch()

Specified by:

isRegularExpressionSearch in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Returns:

true if regular expressions should be used when searching this table model

setRegularExpressionSearch

public final void setRegularExpressionSearch(boolean value)

Specifies whether or not to use regular expressions when searching this table model

Specified by:

setRegularExpressionSearch in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

value - the value

getItemAt

public final R getItemAt(int index)

Specified by:

getItemAt in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

index - the index

Returns:

the item at the given index in the table model

indexOf

public final int indexOf(R item)

Specified by:

indexOf in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

item - the item

Returns:

the index of the item in the table model

sortContents

public final void sortContents()

Sorts the visible contents according to the TableSortModel, keeping the selection state intact

Specified by:

sortContents in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

See Also:

FilteredTableModel.getSortModel()

filterContents

public final void filterContents()

Filters the table according to the condition returned by getFilterCondition(). If no filter condition is specified this method does nothing. This method does not interfere with the internal ordering of the visible items.

Specified by:

filterContents in interface FilteredModel<R>

See Also:

FilteredModel.getFilterCondition(), FilteredModel.setFilterCondition(FilterCondition), FilteredModel.addFilteringListener(EventListener)

getFilterCondition

public final FilterCondition<R> getFilterCondition()

Returns the filter condition defined by this model, null if no filter condition has been set.

Specified by:

getFilterCondition in interface FilteredModel<R>

Returns:

the filter condition

setFilterCondition

public final void setFilterCondition(FilterCondition<R> filterCondition)

Sets the filter condition and filters the model

Specified by:

setFilterCondition in interface FilteredModel<R>

Parameters:

filterCondition - the FilterCondition to use, null if no filtering should be performed

getAllItems

public final java.util.List<R> getAllItems()

Specified by:

getAllItems in interface FilteredModel<R>

Returns:

all visible and filtered items in this table model

removeItem

public final void removeItem(R item)

Removes the given item from this table model

Specified by:

removeItem in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

item - the item to remove from the model

removeItems

public final void removeItems(java.util.Collection<R> items)

Removes the given items from this table model

Specified by:

removeItems in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

items - the items to remove from the model

removeItems

public final void removeItems(int fromIndex,
                              int toIndex)

Removes from this table model all visible elements whose index is between fromIndex, inclusive and toIndex, exclusive

Specified by:

removeItems in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

fromIndex - index of first row to be removed

toIndex - index after last row to be removed

allowSelectionChange

public boolean allowSelectionChange()

A default implementation returning true

Specified by:

allowSelectionChange in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Returns:

true

addRowsDeletedListener

public final void addRowsDeletedListener(EventDataListener<java.util.List<java.lang.Integer>> listener)

Adds a listener that is notified each time rows are deleted from the data model.

Specified by:

addRowsDeletedListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - the listener, the data list contains the fromIndex and toIndex as items at index 0 and 1

removeRowsDeletedListener

public final void removeRowsDeletedListener(EventDataListener listener)

Specified by:

removeRowsDeletedListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - the listener to remove

getColumnModel

public final SwingFilteredTableColumnModel<C> getColumnModel()

Specified by:

getColumnModel in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Returns:

the TableColumnModel used by this TableModel

getColumnClass

public final java.lang.Class getColumnClass(int columnIndex)

Specified by:

getColumnClass in interface javax.swing.table.TableModel

Overrides:

getColumnClass in class javax.swing.table.AbstractTableModel

addRefreshStartedListener

public final void addRefreshStartedListener(EventListener listener)

Specified by:

addRefreshStartedListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - a listener to be notified each time a refresh is about to start

removeRefreshStartedListener

public final void removeRefreshStartedListener(EventListener listener)

Specified by:

removeRefreshStartedListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - the listener to remove

addRefreshDoneListener

public final void addRefreshDoneListener(EventListener listener)

Specified by:

addRefreshDoneListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - a listener to be notified each time a refresh has ended

removeRefreshDoneListener

public final void removeRefreshDoneListener(EventListener listener)

Specified by:

removeRefreshDoneListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - the listener to remove

addFilteringListener

public final void addFilteringListener(EventListener listener)

Specified by:

addFilteringListener in interface FilteredModel<R>

Parameters:

listener - a listener notified each time this model is filtered

removeFilteringListener

public final void removeFilteringListener(EventListener listener)

Specified by:

removeFilteringListener in interface FilteredModel<R>

Parameters:

listener - the listener to remove

addSortingListener

public final void addSortingListener(EventListener listener)

Specified by:

addSortingListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - a listener to be notified each time the model has been sorted or the sorting state has been cleared

removeSortingListener

public final void removeSortingListener(EventListener listener)

Specified by:

removeSortingListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - the listener to remove

addTableDataChangedListener

public final void addTableDataChangedListener(EventListener listener)

Specified by:

addTableDataChangedListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - a listener to be notified each time the table data changes

removeTableDataChangedListener

public final void removeTableDataChangedListener(EventListener listener)

Specified by:

removeTableDataChangedListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - the listener to remove

addTableModelClearedListener

public final void addTableModelClearedListener(EventListener listener)

Specified by:

addTableModelClearedListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - a listener to be notified each time the table model is cleared

removeTableModelClearedListener

public final void removeTableModelClearedListener(EventListener listener)

Specified by:

removeTableModelClearedListener in interface FilteredTableModel<R,C,javax.swing.table.TableColumn>

Parameters:

listener - the listener to remove

doRefresh

protected abstract void doRefresh()

Refreshes the data in this table model.

See Also:

clear(), addItems(List, boolean, boolean), addItems(List, int, boolean)

createColumnValueProvider

protected ColumnSummaryModel.ColumnValueProvider createColumnValueProvider(C columnIdentifier)

Creates a ColumnValueProvider for the given column

Parameters:

columnIdentifier - the column identifier

Returns:

a ColumnValueProvider for the column identified by columnIdentifier

addItems

protected final void addItems(java.util.List<R> items,
                              boolean atTop,
                              boolean sortAfterAdding)

Adds the given items to this table model, non-filtered items are added at top or bottom. If sortAfterAdding is true and sorting is enabled this model is sorted after the items have been added

Parameters:

items - the items to add

atTop - if true then items are added at the top of the table model, else at the bottom

sortAfterAdding - if true and sorting is enabled the model contents are sorted after adding

See Also:

TableSortModel.isSortingEnabled()

addItems

protected final void addItems(java.util.List<R> items,
                              int index,
                              boolean sortAfterAdding)

Adds the given items to this table model, non-filtered items are added at the given index. If sortAfterAdding is true and sorting is enabled this model is sorted after the items have been added

Parameters:

items - the items to add

index - the index at which to add the items

sortAfterAdding - if true and sorting is enabled then the model is sorted after adding

See Also:

TableSortModel.isSortingEnabled()

getSearchValueAt

protected java.lang.String getSearchValueAt(int rowIndex,
                                            javax.swing.table.TableColumn column)

Returns the value to use when searching through the table.

Parameters:

rowIndex - the row index

column - the column

Returns:

the search value

See Also:

findNextItemCoordinate(int, boolean, String)

getSearchCondition

protected final FilterCondition<java.lang.Object> getSearchCondition(java.lang.String searchText)

Parameters:

searchText - the search text

Returns:

a FilterCondition based on the given search text