is.codion.swing.common.model.component.table

Interface FilteredTableModel<R,C>

Type Parameters:

R - the type representing the rows in this table model

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

All Superinterfaces:

FilteredModel<R>, TableModel

All Known Implementing Classes:

DefaultFilteredTableModel, SwingEntityTableModel

public interface FilteredTableModel<R,C>
extends TableModel, FilteredModel<R>

Specifies a table model supporting selection as well as filtering

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FilteredTableModel.ColumnValueProvider<R,C> Provides the column value for a row and column
static interface	FilteredTableModel.RowsRemoved Specifies the from and to rows of a row removal operation.

Field Summary

Fields inherited from interface is.codion.common.model.FilteredModel

ASYNC_REFRESH

Method Summary

Modifier and Type	Method and Description
void	addClearListener(EventListener listener)
void	addDataChangedListener(EventListener listener)
void	addRowsRemovedListener(EventDataListener<FilteredTableModel.RowsRemoved> listener) Adds a listener that is notified each time rows are removed from this model.
void	addSortListener(EventListener listener)
boolean	allowSelectionChange()
void	clear() Clears all items from this table model
<T> ColumnConditionModel<C,T>	columnFilterModel(C columnIdentifier) Returns the ColumnConditionModel for the column with the given identifier.
Map<C,ColumnConditionModel<? extends C,?>>	columnFilterModels()
FilteredTableColumnModel<C>	columnModel()
Optional<ColumnSummaryModel>	columnSummaryModel(C columnIdentifier) Returns the ColumnSummaryModel associated with columnIdentifier
Class<?>	getColumnClass(C columnIdentifier) Returns the class of the column with the given identifier
String	getStringValueAt(int rowIndex, C columnIdentifier) Returns a String representation of the value for the given row and column.
int	indexOf(R item)
boolean	isMergeOnRefresh()
R	itemAt(int rowIndex)
void	refresh() Refreshes the items in this table model, respecting the selection, filtering as well as sorting states.
void	removeClearListener(EventListener listener)
void	removeDataChangedListener(EventListener listener)
void	removeItem(R item) Removes the given item from this table model
void	removeItemAt(int index) Removes from this table model the visible element whose index is between index
void	removeItems(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	removeRowsRemovedListener(EventDataListener<FilteredTableModel.RowsRemoved> listener)
void	removeSortListener(EventListener listener)
FilteredTableSearchModel	searchModel()
<T> Collection<T>	selectedValues(C columnIdentifier)
FilteredTableSelectionModel<R>	selectionModel()
void	setMergeOnRefresh(boolean mergeOnRefresh)
void	sortItems() Sorts the visible items according to the FilteredTableSortModel, keeping the selected items.
FilteredTableSortModel<R,C>	sortModel()
<T> Collection<T>	values(C columnIdentifier)

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, getColumnClass, getColumnCount, getColumnName, getRowCount, getValueAt, isCellEditable, removeTableModelListener, setValueAt

Methods inherited from interface is.codion.common.model.FilteredModel

addFilterListener, addRefreshFailedListener, addRefreshListener, containsItem, filteredItemCount, filteredItems, filterItems, getIncludeCondition, isAsyncRefresh, isFiltered, isVisible, items, refreshingObserver, refreshThen, removeFilterListener, removeRefreshFailedListener, removeRefreshListener, setAsyncRefresh, setIncludeCondition, visibleItemCount, visibleItems

Method Detail

addSortListener

void addSortListener(EventListener listener)

Parameters:

listener - a listener to be notified each time the model has been sorted

removeSortListener

void removeSortListener(EventListener listener)

Parameters:

listener - the listener to remove

addDataChangedListener

void addDataChangedListener(EventListener listener)

Parameters:

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

removeDataChangedListener

void removeDataChangedListener(EventListener listener)

Parameters:

listener - the listener to remove

addClearListener

void addClearListener(EventListener listener)

Parameters:

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

removeClearListener

void removeClearListener(EventListener listener)

Parameters:

listener - the listener to remove

addRowsRemovedListener

void addRowsRemovedListener(EventDataListener<FilteredTableModel.RowsRemoved> listener)

Adds a listener that is notified each time rows are removed from this model.

Parameters:

listener - the listener

removeRowsRemovedListener

void removeRowsRemovedListener(EventDataListener<FilteredTableModel.RowsRemoved> listener)

Parameters:

listener - the listener to remove

allowSelectionChange

boolean allowSelectionChange()

Returns:

true if an impending selection change should be allowed

indexOf

int indexOf(R item)

Parameters:

item - the item

Returns:

the index of the item in the table model

itemAt

R itemAt(int rowIndex)

Parameters:

rowIndex - the row index

Returns:

the item at the given row index in the table model

getStringValueAt

String getStringValueAt(int rowIndex,
                        C columnIdentifier)

Returns a String representation of the value for the given row and column.

Parameters:

rowIndex - the row index

columnIdentifier - the column identifier

Returns:

the string value

removeItems

void removeItems(Collection<R> items)

Removes the given items from this table model

Parameters:

items - the items to remove from the model

removeItem

void removeItem(R item)

Removes the given item from this table model

Parameters:

item - the item to remove from the model

removeItemAt

void removeItemAt(int index)

Removes from this table model the visible element whose index is between index

Parameters:

index - the index of the row to be removed

Throws:

IndexOutOfBoundsException - in case the indexe is out of bounds

removeItems

void removeItems(int fromIndex,
                 int toIndex)

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

Parameters:

fromIndex - index of first row to be removed

toIndex - index after last row to be removed

Throws:

IndexOutOfBoundsException - in case the indexes are out of bounds

columnModel

FilteredTableColumnModel<C> columnModel()

Returns:

the FilteredTableColumnModel used by this TableModel

columnSummaryModel

Optional<ColumnSummaryModel> columnSummaryModel(C columnIdentifier)

Returns the ColumnSummaryModel associated with columnIdentifier

Parameters:

columnIdentifier - the column identifier

Returns:

the ColumnSummaryModel for the column identified by the given identifier, an empty Optional if none is available

columnFilterModels

Map<C,ColumnConditionModel<? extends C,?>> columnFilterModels()

Returns:

the column filter models, mapped to their respective column identifier

columnFilterModel

<T> ColumnConditionModel<C,T> columnFilterModel(C columnIdentifier)

Returns the ColumnConditionModel for the column with the given identifier.

Type Parameters:

T - the column value type

Parameters:

columnIdentifier - the column identifier

Returns:

the ColumnConditionModel for the column with the given identifier.

Throws:

IllegalArgumentException - in case no filter model exists for the given column

values

<T> Collection<T> values(C columnIdentifier)

Type Parameters:

T - the value type

Parameters:

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

Returns:

the values (including nulls) of the column identified by the given identifier from the visible rows in the table model

getColumnClass

Class<?> getColumnClass(C columnIdentifier)

Returns the class of the column with the given identifier

Parameters:

columnIdentifier - the column identifier

Returns:

the Class representing the given column

selectedValues

<T> Collection<T> selectedValues(C columnIdentifier)

Type Parameters:

T - the value type

Parameters:

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

Returns:

the values (including nulls) of the column identified by the given identifier from the selected rows in the table model

isMergeOnRefresh

boolean isMergeOnRefresh()

Returns:

true if merge on refresh is enabled

setMergeOnRefresh

void setMergeOnRefresh(boolean mergeOnRefresh)

Parameters:

mergeOnRefresh - true if merge on refresh should be enabled

sortItems

void sortItems()

Sorts the visible items according to the FilteredTableSortModel, keeping the selected items. Calling this method with the sort model disabled has no effect.

See Also:

sortModel(), addSortListener(EventListener), FilteredTableSortModel.isSortingEnabled()

selectionModel

FilteredTableSelectionModel<R> selectionModel()

Returns:

the selection model used by this table model

sortModel

FilteredTableSortModel<R,C> sortModel()

Returns:

the sorting model

searchModel

FilteredTableSearchModel searchModel()

Returns:

the search model

refresh

void refresh()

Refreshes the items in this table model, respecting the selection, filtering as well as sorting states. If run on the Event Dispatch Thread the refresh happens asynchronously, unless async refresh has been disabled via FilteredModel.setAsyncRefresh(boolean). Note that an empty selection event will be triggered during a normal refresh, since the model is cleared before it is repopulated, during which the selection is cleared as well. Using merge on insert (setMergeOnRefresh(boolean)) will prevent that at a considerable performance cost.

Specified by:

refresh in interface FilteredModel<R>

Throws:

RuntimeException - in case of an exception when refresh is run synchronously

See Also:

FilteredModel.addRefreshFailedListener(EventDataListener), FilteredModel.setAsyncRefresh(boolean)

clear

void clear()

Clears all items from this table model