Module is.codion.swing.framework.model

Package is.codion.swing.framework.model

Class SwingEntityTableModel

java.lang.Object

is.codion.swing.framework.model.SwingEntityTableModel

All Implemented Interfaces:

FilteredModel<Entity>, EntityTableModel<SwingEntityEditModel>, FilteredTableModel<Entity,Attribute<?>>, TableModel

public class SwingEntityTableModel
extends Object
implements EntityTableModel<SwingEntityEditModel>, FilteredTableModel<Entity,Attribute<?>>

A TableModel implementation for displaying and working with entities.

Nested Class Summary

Nested classes/interfaces inherited from interface is.codion.framework.model.EntityTableModel

EntityTableModel.ColumnPreferences, EntityTableModel.OnInsert

Nested classes/interfaces inherited from interface is.codion.common.model.FilteredModel

FilteredModel.AbstractRefresher<T>, FilteredModel.Refresher<T>

Nested classes/interfaces inherited from interface is.codion.swing.common.model.component.table.FilteredTableModel

FilteredTableModel.Builder<R,C>, FilteredTableModel.ColumnFactory<C>, FilteredTableModel.ColumnValueProvider<R,C>

Field Summary

Fields inherited from interface is.codion.framework.model.EntityTableModel

ON_INSERT, ORDER_QUERY_BY_SORT_ORDER, QUERY_HIDDEN_COLUMNS

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

ASYNC_REFRESH

Constructor Summary

Constructors

Constructor	Description
SwingEntityTableModel(EntityType entityType, EntityConnectionProvider connectionProvider)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(EntityType entityType, EntityConnectionProvider connectionProvider, EntityConditionModelFactory conditionModelFactory)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(EntityType entityType, EntityConnectionProvider connectionProvider, FilteredTableModel.ColumnFactory<Attribute<?>> columnFactory)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(EntityType entityType, EntityConnectionProvider connectionProvider, FilteredTableModel.ColumnFactory<Attribute<?>> columnFactory, EntityConditionModelFactory conditionModelFactory)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(SwingEntityEditModel editModel)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(SwingEntityEditModel editModel, EntityConditionModelFactory conditionModelFactory)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(SwingEntityEditModel editModel, FilteredTableModel.ColumnFactory<Attribute<?>> columnFactory)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(SwingEntityEditModel editModel, FilteredTableModel.ColumnFactory<Attribute<?>> columnFactory, EntityConditionModelFactory conditionModelFactory)	Instantiates a new SwingEntityTableModel.

Method Summary

Modifier and Type	Method	Description
final void	addItem(Entity item)	Adds the given item to the bottom of this table model.
final void	addItemAt(int index, Entity item)
final void	addItems(Collection<Entity> items)	Adds the given items to the bottom of this table model.
final void	addItemsAt(int index, Collection<Entity> items)	Adds the given items to this table model, non-filtered items are added at the given index.
final void	addItemsAtSorted(int index, Collection<Entity> items)	Adds the given items to this table model, non-filtered items are added at the given index.
final void	addItemSorted(Entity item)	Adds the given item to the bottom of this table model.
final void	addItemsSorted(Collection<Entity> items)	Adds the given items to the bottom of this table model.
final void	addTableModelListener(TableModelListener listener)
final ValueSet<Attribute<?>>	attributes()	Returns the ValueSet controlling which attributes are included when selecting entities to populate this model.
Color	backgroundColor(int row, Attribute<?> attribute)
final void	clear()	Clears all items from this table model
final EventObserver<?>	clearedEvent()
final FilteredTableColumnModel<Attribute<?>>	columnModel()
final StateObserver	conditionChanged()
protected boolean	conditionEnabled(EntityTableConditionModel<Attribute<?>> conditionModel)	It can be necessary to prevent the user from selecting too much data, when working with a large dataset.
final EntityTableConditionModel<Attribute<?>>	conditionModel()
final State	conditionRequired()	Returns a State controlling whether this table model should display all underlying entities when no query condition has been set.
final EntityConnection	connection()	Do not cache or keep the connection returned by this method in a long living field, since it may become invalid and thereby unusable.
final EntityConnectionProvider	connectionProvider()
final boolean	containsItem(Entity item)	Returns true if this model contains the given item, visible or filtered.
final EventObserver<?>	dataChangedEvent()
final Collection<Entity>	deleteSelected()	Deletes the selected entities
final State	editable()
final State	editEvents()
final <C extends SwingEntityEditModel> C	editModel()
final Entities	entities()
final EntityDefinition	entityDefinition()
final EntityType	entityType()
final boolean	filtered(Entity item)	Returns true if this model contains the given item, and it is filtered, that is, is not visible
final int	filteredCount()
final Collection<Entity>	filteredItems()
final void	filterItems()	Filters this model according to the condition specified by FilteredModel.includeCondition().
final TableConditionModel<Attribute<?>>	filterModel()
final Optional<Entity>	find(Entity.Key primaryKey)	Finds the entity in this table model having the given primary key
final Collection<Entity>	find(Collection<Entity.Key> keys)	Finds entities in this table model according to the values in keys
final void	fireTableDataChanged()	Notifies all listeners that all cell values in the table's rows may have changed.
void	fireTableRowsUpdated(int fromIndex, int toIndex)	Notifies all listeners that the given rows have changed
Color	foregroundColor(int row, Attribute<?> attribute)
final Class<?>	getColumnClass(int columnIndex)
final Class<?>	getColumnClass(Attribute<?> columnIdentifier)	Returns the class of the column with the given identifier
final int	getColumnCount()
final String	getColumnName(int columnIndex)
final int	getRowCount()
final String	getStringAt(int rowIndex, Attribute<?> columnIdentifier)	Returns a String representation of the value for the given row and column.
final Object	getValueAt(int rowIndex, int columnIndex)
final Value<Predicate<Entity>>	includeCondition()
final int	indexOf(Entity item)
final int	indexOf(Entity.Key primaryKey)
boolean	isCellEditable(int rowIndex, int modelColumnIndex)	Returns true if the cell at rowIndex and modelColumnIndex is editable.
final Entity	itemAt(int rowIndex)
final Collection<Entity>	items()
final Value<Integer>	limit()	Returns the Value controlling the maximum number of rows to fetch via the underlying query the next time this table model is refreshed, a null value means all rows should be fetched
final State	mergeOnRefresh()	Note that when merging during refresh, the items are not sorted, since that would cause an empty-selection event, defeating the purpose of merging.
final Value<EntityTableModel.OnInsert>	onInsert()
protected OrderBy	orderBy()	The order by clause to use when selecting the data for this model.
final State	orderQueryBySortOrder()	Specifies whether the current sort order is used as a basis for the query order by clause.
final State	queryHiddenColumns()	Returns whether the values of hidden columns are included when querying data
final void	refresh()	Refreshes the items in this table model, according to the underlying condition
final void	refresh(Collection<Entity.Key> keys)	Refreshes the entities with the given keys by re-selecting them from the underlying database.
final FilteredModel.Refresher<Entity>	refresher()
protected Collection<Entity>	refreshItems()	Queries the data used to populate this EntityTableModel when it is refreshed.
final void	refreshThen(Consumer<Collection<Entity>> afterRefresh)	Refreshes the data in this filtered model using its FilteredModel.Refresher.
final State	removeDeleted()
final void	removeItem(Entity item)	Removes the given item from this table model
final Entity	removeItemAt(int index)	Removes from this table model the visible element whose index is between index
final List<Entity>	removeItems(int fromIndex, int toIndex)	Removes from this table model all visible elements whose index is between fromIndex, inclusive and toIndex, exclusive
final void	removeItems(Collection<Entity> items)	Removes the given items from this table model
final void	removeTableModelListener(TableModelListener listener)
final void	replace(ForeignKey foreignKey, Collection<Entity> foreignKeyValues)	For every entity in this table model, replaces the foreign key instance bearing the primary key with the corresponding entity from foreignKeyValues, useful when attribute values have been changed in the referenced entity that must be reflected in the table model.
final void	replace(Collection<Entity> entities)	Replaces the given entities in this table model
final String	rowsAsDelimitedString(char delimiter)
final void	savePreferences()	Saves any user preferences.
final FilteredTableSearchModel	searchModel()
final void	select(Collection<Entity.Key> keys)	Selects entities according to the primary keys in primaryKeys
final <T> Collection<T>	selectedValues(Attribute<?> columnIdentifier)
final EventObserver<?>	selectionEvent()
final FilteredTableSelectionModel<Entity>	selectionModel()
final void	setItemAt(int index, Entity item)	Sets the item at the given index.
final void	setValueAt(Object value, int rowIndex, int modelColumnIndex)	Sets the value in the given cell and updates the underlying Entity.
final void	setVisibleColumns(Attribute<?>... attributes)	Arranges the column model so that only the given columns are visible and in the given order
final void	setVisibleColumns(List<Attribute<?>> attributes)	Arranges the column model so that only the given columns are visible and in the given order
final void	sortItems()	Sorts the visible items according to the FilteredTableSortModel, keeping the selected items.
final FilteredTableSortModel<Entity,Attribute<?>>	sortModel()
final TableSummaryModel<Attribute<?>>	summaryModel()
static SwingEntityTableModel	tableModel(Collection<Entity> entities, EntityConnectionProvider connectionProvider)
protected Color	toColor(Object color)	Returns a Color instance from the given Object.
final String	toString()
protected String	userPreferencesKey()	Returns the key used to identify user preferences for this table model, that is column positions, widths and such.
final <T> Collection<T>	values(Attribute<?> columnIdentifier)
final boolean	visible(Entity item)	Returns true if this model contains the given item, and it is visible, that is, not filtered
final int	visibleCount()
final List<Entity>	visibleItems()

Methods inherited from class java.lang.Object

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

Constructor Details

SwingEntityTableModel

public SwingEntityTableModel(EntityType entityType,
 EntityConnectionProvider connectionProvider)

Instantiates a new SwingEntityTableModel.

Parameters:

entityType - the entityType

connectionProvider - the connection provider

SwingEntityTableModel

public SwingEntityTableModel(EntityType entityType,
 EntityConnectionProvider connectionProvider,
 FilteredTableModel.ColumnFactory<Attribute<?>> columnFactory)

Instantiates a new SwingEntityTableModel.

Parameters:

entityType - the entityType

connectionProvider - the connection provider

columnFactory - the table column factory

SwingEntityTableModel

public SwingEntityTableModel(EntityType entityType,
 EntityConnectionProvider connectionProvider,
 EntityConditionModelFactory conditionModelFactory)

Instantiates a new SwingEntityTableModel.

Parameters:

entityType - the entityType

connectionProvider - the connection provider

conditionModelFactory - the table condition model factory

SwingEntityTableModel

public SwingEntityTableModel(EntityType entityType,
 EntityConnectionProvider connectionProvider,
 FilteredTableModel.ColumnFactory<Attribute<?>> columnFactory,
 EntityConditionModelFactory conditionModelFactory)

Instantiates a new SwingEntityTableModel.

Parameters:

entityType - the entityType

connectionProvider - the connection provider

columnFactory - the table column factory

conditionModelFactory - the table condition model factory

SwingEntityTableModel

public SwingEntityTableModel(SwingEntityEditModel editModel)

Instantiates a new SwingEntityTableModel.

Parameters:

editModel - the edit model

SwingEntityTableModel

public SwingEntityTableModel(SwingEntityEditModel editModel,
 FilteredTableModel.ColumnFactory<Attribute<?>> columnFactory)

Instantiates a new SwingEntityTableModel.

Parameters:

editModel - the edit model

columnFactory - the table column factory

SwingEntityTableModel

public SwingEntityTableModel(SwingEntityEditModel editModel,
 EntityConditionModelFactory conditionModelFactory)

Instantiates a new SwingEntityTableModel.

Parameters:

editModel - the edit model

conditionModelFactory - the table condition model factory

SwingEntityTableModel

public SwingEntityTableModel(SwingEntityEditModel editModel,
 FilteredTableModel.ColumnFactory<Attribute<?>> columnFactory,
 EntityConditionModelFactory conditionModelFactory)

Instantiates a new SwingEntityTableModel.

Parameters:

editModel - the edit model

columnFactory - the table column factory

conditionModelFactory - the table condition model factory

Method Details

entities

public final Entities entities()

Specified by:

entities in interface EntityTableModel<SwingEntityEditModel>

Returns:

the underlying domain entities

entityDefinition

public final EntityDefinition entityDefinition()

Specified by:

entityDefinition in interface EntityTableModel<SwingEntityEditModel>

Returns:

the definition of the underlying entity

toString

public final String toString()

Overrides:

toString in class Object

attributes

public final ValueSet<Attribute<?>> attributes()

Description copied from interface: EntityTableModel

Returns the ValueSet controlling which attributes are included when selecting entities to populate this model. Note that an empty ValueSet indicates that the default select attributes should be used.

Specified by:

attributes in interface EntityTableModel<SwingEntityEditModel>

Returns:

the ValueSet controlling the selected attributes

See Also:

• EntityTableModel.queryHiddenColumns()

limit

public final Value<Integer> limit()

Description copied from interface: EntityTableModel

Returns the Value controlling the maximum number of rows to fetch via the underlying query the next time this table model is refreshed, a null value means all rows should be fetched

Specified by:

limit in interface EntityTableModel<SwingEntityEditModel>

Returns:

the value controlling the limit

queryHiddenColumns

public final State queryHiddenColumns()

Description copied from interface: EntityTableModel

Returns whether the values of hidden columns are included when querying data

Specified by:

queryHiddenColumns in interface EntityTableModel<SwingEntityEditModel>

Returns:

the State controlling whether the values of hidden columns are included when querying data

orderQueryBySortOrder

public final State orderQueryBySortOrder()

Description copied from interface: EntityTableModel

Specifies whether the current sort order is used as a basis for the query order by clause. Note that this only applies to column attributes.

Specified by:

orderQueryBySortOrder in interface EntityTableModel<SwingEntityEditModel>

Returns:

the State controlling whether the current sort order should be used as a basis for the query order by clause

conditionRequired

public final State conditionRequired()

Description copied from interface: EntityTableModel

Returns a State controlling whether this table model should display all underlying entities when no query condition has been set. Setting this value to 'true' prevents all rows from being fetched by accident, when no condition has been set, which is recommended for tables with a large underlying dataset.

Specified by:

conditionRequired in interface EntityTableModel<SwingEntityEditModel>

Returns:

a State specifying whether this table model requires a query condition

onInsert

public final Value<EntityTableModel.OnInsert> onInsert()

Specified by:

onInsert in interface EntityTableModel<SwingEntityEditModel>

Returns:

the Value controlling the action to perform when entities are inserted via the associated edit model

See Also:

• EntityTableModel.ON_INSERT

removeDeleted

public final State removeDeleted()

Specified by:

removeDeleted in interface EntityTableModel<SwingEntityEditModel>

Returns:

the State controlling whether entities that are deleted via the associated edit model should be automatically removed from this table model

editEvents

public final State editEvents()

Specified by:

editEvents in interface EntityTableModel<SwingEntityEditModel>

Returns:

the state controlling whether this table model handles entity edit events, by replacing foreign key values

See Also:

• EntityEditEvents

entityType

public final EntityType entityType()

Specified by:

entityType in interface EntityTableModel<SwingEntityEditModel>

Returns:

the type of the entity this table model is based on

conditionModel

public final EntityTableConditionModel<Attribute<?>> conditionModel()

Specified by:

conditionModel in interface EntityTableModel<SwingEntityEditModel>

Returns:

the EntityTableConditionModel instance used by this table model

editModel

public final <C extends SwingEntityEditModel> C editModel()

Specified by:

editModel in interface EntityTableModel<SwingEntityEditModel>

Type Parameters:

C - the edit model type Returns the EntityEditModel associated with this table model

Returns:

the edit model associated with this table model

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityTableModel<SwingEntityEditModel>

Returns:

the connection provider used by this table model

connection

public final EntityConnection connection()

Description copied from interface: EntityTableModel

Do not cache or keep the connection returned by this method in a long living field, since it may become invalid and thereby unusable.

Specified by:

connection in interface EntityTableModel<SwingEntityEditModel>

Returns:

the connection used by this table model

editable

public final State editable()

Specified by:

editable in interface EntityTableModel<SwingEntityEditModel>

Returns:

the State controlling whether this table model is editable

isCellEditable

public boolean isCellEditable(int rowIndex,
 int modelColumnIndex)

Returns true if the cell at rowIndex and modelColumnIndex is editable.

Specified by:

isCellEditable in interface TableModel

Parameters:

rowIndex - the row to edit

modelColumnIndex - the model index of the column to edit

Returns:

true if the cell is editable

See Also:

• setValueAt(Object, int, int)

setValueAt

public final void setValueAt(Object value,
 int rowIndex,
 int modelColumnIndex)

Sets the value in the given cell and updates the underlying Entity.

Specified by:

setValueAt in interface TableModel

Parameters:

value - the new value

rowIndex - the row whose value is to be changed

modelColumnIndex - the model index of the column to be changed

backgroundColor

public Color backgroundColor(int row,
 Attribute<?> attribute)

Specified by:

backgroundColor in interface EntityTableModel<SwingEntityEditModel>

Parameters:

row - the row for which to retrieve the background color

attribute - the attribute for which to retrieve the background color

Returns:

an Object representing the background color for this row and attribute, specified by the row entity

See Also:

• EntityDefinition.Builder.backgroundColorProvider(ColorProvider)

foregroundColor

public Color foregroundColor(int row,
 Attribute<?> attribute)

Specified by:

foregroundColor in interface EntityTableModel<SwingEntityEditModel>

Parameters:

row - the row for which to retrieve the foreground color

attribute - the attribute for which to retrieve the foreground color

Returns:

an Object representing the foreground color for this row and attribute, specified by the row entity

See Also:

• EntityDefinition.Builder.foregroundColorProvider(ColorProvider)

find

public final Optional<Entity> find(Entity.Key primaryKey)

Description copied from interface: EntityTableModel

Finds the entity in this table model having the given primary key

Specified by:

find in interface EntityTableModel<SwingEntityEditModel>

Parameters:

primaryKey - the primary key to search by

Returns:

the entity with the given primary key from the table model, an empty Optional if not found

indexOf

public final int indexOf(Entity.Key primaryKey)

Specified by:

indexOf in interface EntityTableModel<SwingEntityEditModel>

Parameters:

primaryKey - the primary key

Returns:

the row index of the entity with the given primary key, -1 if not found

replace

public final void replace(Collection<Entity> entities)

Description copied from interface: EntityTableModel

Replaces the given entities in this table model

Specified by:

replace in interface EntityTableModel<SwingEntityEditModel>

Parameters:

entities - the entities to replace

refresh

public final void refresh(Collection<Entity.Key> keys)

Description copied from interface: EntityTableModel

Refreshes the entities with the given keys by re-selecting them from the underlying database.

Specified by:

refresh in interface EntityTableModel<SwingEntityEditModel>

Parameters:

keys - the keys of the entities to refresh

replace

public final void replace(ForeignKey foreignKey,
 Collection<Entity> foreignKeyValues)

Description copied from interface: EntityTableModel

For every entity in this table model, replaces the foreign key instance bearing the primary key with the corresponding entity from foreignKeyValues, useful when attribute values have been changed in the referenced entity that must be reflected in the table model.

Specified by:

replace in interface EntityTableModel<SwingEntityEditModel>

Parameters:

foreignKey - the foreign key

foreignKeyValues - the foreign key entities

select

public final void select(Collection<Entity.Key> keys)

Description copied from interface: EntityTableModel

Selects entities according to the primary keys in primaryKeys

Specified by:

select in interface EntityTableModel<SwingEntityEditModel>

Parameters:

keys - the primary keys of the entities to select

find

public final Collection<Entity> find(Collection<Entity.Key> keys)

Description copied from interface: EntityTableModel

Finds entities in this table model according to the values in keys

Specified by:

find in interface EntityTableModel<SwingEntityEditModel>

Parameters:

keys - the primary key values to use as condition

Returns:

the entities from this table model having the primary key values as in keys

deleteSelected

public final Collection<Entity> deleteSelected()
                                        throws DatabaseException

Description copied from interface: EntityTableModel

Deletes the selected entities

Specified by:

deleteSelected in interface EntityTableModel<SwingEntityEditModel>

Returns:

the deleted entities

Throws:

DatabaseException - in case of a database exception

setVisibleColumns

public final void setVisibleColumns(Attribute<?>... attributes)

Description copied from interface: EntityTableModel

Arranges the column model so that only the given columns are visible and in the given order

Specified by:

setVisibleColumns in interface EntityTableModel<SwingEntityEditModel>

Parameters:

attributes - the column attributes

setVisibleColumns

public final void setVisibleColumns(List<Attribute<?>> attributes)

Description copied from interface: EntityTableModel

Arranges the column model so that only the given columns are visible and in the given order

Specified by:

setVisibleColumns in interface EntityTableModel<SwingEntityEditModel>

Parameters:

attributes - the column attributes

savePreferences

public final void savePreferences()

Description copied from interface: EntityTableModel

Saves any user preferences. Note that if EntityModel.USE_CLIENT_PREFERENCES is set to 'false', calling this method has no effect.

Specified by:

savePreferences in interface EntityTableModel<SwingEntityEditModel>

conditionChanged

public final StateObserver conditionChanged()

Specified by:

conditionChanged in interface EntityTableModel<SwingEntityEditModel>

Returns:

a StateObserver indicating if the search condition has changed since last refresh

selectionEvent

public final EventObserver<?> selectionEvent()

Specified by:

selectionEvent in interface EntityTableModel<SwingEntityEditModel>

Returns:

an observer notified when the selection changes in the underlying selection model

filterItems

public final void filterItems()

Description copied from interface: FilteredModel

Filters this model according to the condition specified by FilteredModel.includeCondition(). If no include condition is specified this method does nothing. This method does not interfere with the internal ordering of the visible items.

Specified by:

filterItems in interface FilteredModel<Entity>

See Also:

• FilteredModel.includeCondition()

includeCondition

public final Value<Predicate<Entity>> includeCondition()

Specified by:

includeCondition in interface FilteredModel<Entity>

Returns:

the include condition value

items

public final Collection<Entity> items()

Specified by:

items in interface FilteredModel<Entity>

Returns:

an unmodifiable view of all visible and filtered items in this model

See Also:

• FilteredModel.visibleItems()
• FilteredModel.filteredItems()

visibleItems

public final List<Entity> visibleItems()

Specified by:

visibleItems in interface FilteredModel<Entity>

Returns:

an unmodifiable view of the visible items, in the order they appear in the model

filteredItems

public final Collection<Entity> filteredItems()

Specified by:

filteredItems in interface FilteredModel<Entity>

Returns:

an unmodifiable view of the filtered items

visibleCount

public final int visibleCount()

Specified by:

visibleCount in interface FilteredModel<Entity>

Returns:

the number of currently visible items

filteredCount

public final int filteredCount()

Specified by:

filteredCount in interface FilteredModel<Entity>

Returns:

the number of currently filtered items

containsItem

public final boolean containsItem(Entity item)

Description copied from interface: FilteredModel

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

Specified by:

containsItem in interface FilteredModel<Entity>

Parameters:

item - the item

Returns:

true if this model contains the item

visible

public final boolean visible(Entity item)

Description copied from interface: FilteredModel

Returns true if this model contains the given item, and it is visible, that is, not filtered

Specified by:

visible in interface FilteredModel<Entity>

Parameters:

item - the item

Returns:

true if the given item is visible

filtered

public final boolean filtered(Entity item)

Description copied from interface: FilteredModel

Returns true if this model contains the given item, and it is filtered, that is, is not visible

Specified by:

filtered in interface FilteredModel<Entity>

Parameters:

item - the item

Returns:

true if the given item is filtered

refresher

public final FilteredModel.Refresher<Entity> refresher()

Specified by:

refresher in interface FilteredModel<Entity>

Returns:

this models Refresher instance

refresh

public final void refresh()

Description copied from interface: EntityTableModel

Refreshes the items in this table model, according to the underlying condition

Specified by:

refresh in interface EntityTableModel<SwingEntityEditModel>

Specified by:

refresh in interface FilteredModel<Entity>

Specified by:

refresh in interface FilteredTableModel<Entity,Attribute<?>>

See Also:

• EntityTableModel.conditionModel()

refreshThen

public final void refreshThen(Consumer<Collection<Entity>> afterRefresh)

Description copied from interface: FilteredModel

Refreshes the data in this filtered model using its FilteredModel.Refresher. Note that this method only throws exceptions when run synchronously off the user interface thread. Use FilteredModel.Refresher.refreshFailedEvent() to listen for exceptions that happen during asynchronous refresh.

Specified by:

refreshThen in interface FilteredModel<Entity>

Specified by:

refreshThen in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

afterRefresh - called after a successful refresh, may be null

See Also:

• FilteredModel.Refresher.observer()
• FilteredModel.Refresher.refreshEvent()
• FilteredModel.Refresher.refreshFailedEvent()
• FilteredModel.Refresher.async()

clear

public final void clear()

Description copied from interface: EntityTableModel

Clears all items from this table model

Specified by:

clear in interface EntityTableModel<SwingEntityEditModel>

Specified by:

clear in interface FilteredTableModel<Entity,Attribute<?>>

getRowCount

public final int getRowCount()

Specified by:

getRowCount in interface EntityTableModel<SwingEntityEditModel>

Specified by:

getRowCount in interface TableModel

Returns:

the number of visible rows in this table model

indexOf

public final int indexOf(Entity item)

Specified by:

indexOf in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

item - the item

Returns:

the index of the item in the table model

itemAt

public final Entity itemAt(int rowIndex)

Specified by:

itemAt in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

rowIndex - the row index

Returns:

the item at the given row index in the table model

getValueAt

public final Object getValueAt(int rowIndex,
 int columnIndex)

Specified by:

getValueAt in interface TableModel

getStringAt

public final String getStringAt(int rowIndex,
 Attribute<?> columnIdentifier)

Description copied from interface: FilteredTableModel

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

Specified by:

getStringAt in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

rowIndex - the row index

columnIdentifier - the column identifier

Returns:

the string value

addItems

public final void addItems(Collection<Entity> items)

Description copied from interface: FilteredTableModel

Adds the given items to the bottom of this table model.

Specified by:

addItems in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

items - the items to add

addItemsSorted

public final void addItemsSorted(Collection<Entity> items)

Description copied from interface: FilteredTableModel

Adds the given items to the bottom of this table model. If sorting is enabled this model is sorted after the items have been added.

Specified by:

addItemsSorted in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

items - the items to add

addItemsAt

public final void addItemsAt(int index,
 Collection<Entity> items)

Description copied from interface: FilteredTableModel

Adds the given items to this table model, non-filtered items are added at the given index.

Specified by:

addItemsAt in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

index - the index at which to add the items

items - the items to add

addItemsAtSorted

public final void addItemsAtSorted(int index,
 Collection<Entity> items)

Description copied from interface: FilteredTableModel

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

Specified by:

addItemsAtSorted in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

index - the index at which to add the items

items - the items to add

See Also:

• FilteredTableSortModel.sorted()

addItem

public final void addItem(Entity item)

Description copied from interface: FilteredTableModel

Adds the given item to the bottom of this table model.

Specified by:

addItem in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

item - the item to add

addItemAt

public final void addItemAt(int index,
 Entity item)

Specified by:

addItemAt in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

index - the index

item - the item to add

addItemSorted

public final void addItemSorted(Entity item)

Description copied from interface: FilteredTableModel

Adds the given item to the bottom of this table model. If sorting is enabled this model is sorted after the item has been added.

Specified by:

addItemSorted in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

item - the item to add

setItemAt

public final void setItemAt(int index,
 Entity item)

Description copied from interface: FilteredTableModel

Sets the item at the given index. If the item should be filtered calling this method has no effect.

Specified by:

setItemAt in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

index - the index

item - the item

See Also:

• FilteredModel.includeCondition()

removeItems

public final void removeItems(Collection<Entity> items)

Description copied from interface: FilteredTableModel

Removes the given items from this table model

Specified by:

removeItems in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

items - the items to remove from the model

removeItem

public final void removeItem(Entity item)

Description copied from interface: FilteredTableModel

Removes the given item from this table model

Specified by:

removeItem in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

item - the item to remove from the model

removeItemAt

public final Entity removeItemAt(int index)

Description copied from interface: FilteredTableModel

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

Specified by:

removeItemAt in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

index - the index of the row to be removed

Returns:

the removed item

removeItems

public final List<Entity> removeItems(int fromIndex,
 int toIndex)

Description copied from interface: FilteredTableModel

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

Specified by:

removeItems in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

fromIndex - index of first row to be removed

toIndex - index after last row to be removed

Returns:

the removed items

fireTableDataChanged

public final void fireTableDataChanged()

Description copied from interface: FilteredTableModel

Notifies all listeners that all cell values in the table's rows may have changed. The number of rows may also have changed and the JTable should redraw the table from scratch. The structure of the table (as in the order of the columns) is assumed to be the same.

Specified by:

fireTableDataChanged in interface FilteredTableModel<Entity,Attribute<?>>

fireTableRowsUpdated

public void fireTableRowsUpdated(int fromIndex,
 int toIndex)

Description copied from interface: FilteredTableModel

Notifies all listeners that the given rows have changed

Specified by:

fireTableRowsUpdated in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

fromIndex - the from index

toIndex - the to index

columnModel

public final FilteredTableColumnModel<Attribute<?>> columnModel()

Specified by:

columnModel in interface FilteredTableModel<Entity,Attribute<?>>

Returns:

the FilteredTableColumnModel used by this TableModel

values

public final <T> Collection<T> values(Attribute<?> columnIdentifier)

Specified by:

values in interface FilteredTableModel<Entity,Attribute<?>>

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

public final Class<?> getColumnClass(Attribute<?> columnIdentifier)

Description copied from interface: FilteredTableModel

Returns the class of the column with the given identifier

Specified by:

getColumnClass in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

columnIdentifier - the column identifier

Returns:

the Class representing the given column

selectedValues

public final <T> Collection<T> selectedValues(Attribute<?> columnIdentifier)

Specified by:

selectedValues in interface FilteredTableModel<Entity,Attribute<?>>

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

rowsAsDelimitedString

public final String rowsAsDelimitedString(char delimiter)

Specified by:

rowsAsDelimitedString in interface FilteredTableModel<Entity,Attribute<?>>

Parameters:

delimiter - the delimiter

Returns:

the table rows as a tab delimited string, with column names as a header

mergeOnRefresh

public final State mergeOnRefresh()

Description copied from interface: FilteredTableModel

Note that when merging during refresh, the items are not sorted, since that would cause an empty-selection event, defeating the purpose of merging.

Specified by:

mergeOnRefresh in interface FilteredTableModel<Entity,Attribute<?>>

Returns:

the State controlling whether merge on refresh should be enabled

sortItems

public final void sortItems()

Description copied from interface: FilteredTableModel

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

Specified by:

sortItems in interface FilteredTableModel<Entity,Attribute<?>>

See Also:

• FilteredTableModel.sortModel()
• FilteredTableSortModel.sorted()

selectionModel

public final FilteredTableSelectionModel<Entity> selectionModel()

Specified by:

selectionModel in interface EntityTableModel<SwingEntityEditModel>

Specified by:

selectionModel in interface FilteredTableModel<Entity,Attribute<?>>

Returns:

the TableSelectionModel

sortModel

public final FilteredTableSortModel<Entity,Attribute<?>> sortModel()

Specified by:

sortModel in interface FilteredTableModel<Entity,Attribute<?>>

Returns:

the sorting model

searchModel

public final FilteredTableSearchModel searchModel()

Specified by:

searchModel in interface FilteredTableModel<Entity,Attribute<?>>

Returns:

the search model

filterModel

public final TableConditionModel<Attribute<?>> filterModel()

Specified by:

filterModel in interface FilteredTableModel<Entity,Attribute<?>>

Returns:

the filter model used by this table model

summaryModel

public final TableSummaryModel<Attribute<?>> summaryModel()

Specified by:

summaryModel in interface FilteredTableModel<Entity,Attribute<?>>

Returns:

the summary model

getColumnCount

public final int getColumnCount()

Specified by:

getColumnCount in interface TableModel

getColumnName

public final String getColumnName(int columnIndex)

Specified by:

getColumnName in interface TableModel

getColumnClass

public final Class<?> getColumnClass(int columnIndex)

Specified by:

getColumnClass in interface TableModel

dataChangedEvent

public final EventObserver<?> dataChangedEvent()

Specified by:

dataChangedEvent in interface FilteredTableModel<Entity,Attribute<?>>

Returns:

an observer notified each time the table data changes

clearedEvent

public final EventObserver<?> clearedEvent()

Specified by:

clearedEvent in interface FilteredTableModel<Entity,Attribute<?>>

Returns:

an observer notified each time the table model is cleared

addTableModelListener

public final void addTableModelListener(TableModelListener listener)

Specified by:

addTableModelListener in interface TableModel

removeTableModelListener

public final void removeTableModelListener(TableModelListener listener)

Specified by:

removeTableModelListener in interface TableModel

tableModel

public static SwingEntityTableModel tableModel(Collection<Entity> entities,
 EntityConnectionProvider connectionProvider)

Parameters:

entities - the entities to display

connectionProvider - the connection provider

Returns:

a static SwingEntityTableModel instance containing the given entities

Throws:

IllegalArgumentException - in case entities is empty

refreshItems

protected Collection<Entity> refreshItems()

Queries the data used to populate this EntityTableModel when it is refreshed. This method should take into account the where and having conditions (EntityTableConditionModel.where(Conjunction), EntityTableConditionModel.having(Conjunction)), order by clause (orderBy()), the limit (limit()) and select attributes (attributes()) when querying.

Returns:

entities selected from the database according to the query condition.

See Also:

• conditionRequired()
• conditionEnabled(EntityTableConditionModel)
• EntityTableConditionModel.where(Conjunction)
• EntityTableConditionModel.having(Conjunction)

conditionEnabled

protected boolean conditionEnabled(EntityTableConditionModel<Attribute<?>> conditionModel)

It can be necessary to prevent the user from selecting too much data, when working with a large dataset. This can be done by enabling the conditionRequired(), which prevents a refresh as long as this method returns false. This default implementation simply returns TableConditionModel.enabled(). Override for a more fine grained control, such as requiring a specific column condition to be enabled.

Parameters:

conditionModel - the table condition model

Returns:

true if enough conditions are enabled for a safe refresh

See Also:

• conditionRequired()

toColor

protected Color toColor(Object color)

Returns a Color instance from the given Object. Color instances are returned as-is, but instances of String are assumed to be in HEX format (f.ex: #ffff00" or #00ff00) and are parsed with Color.decode(String). Colors parsed from Strings are cached. Override to support other representations.

Parameters:

color - the object representing the color.

Returns:

a Color instance based on the given Object

Throws:

IllegalArgumentException - in case the representation is not supported

NullPointerException - in case color is null

orderBy

protected OrderBy orderBy()

The order by clause to use when selecting the data for this model. If ordering by sort order is enabled a OrderBy clause is constructed according to the sort order of column based attributes, otherwise the order by clause defined for the underlying entity is returned.

Returns:

the order by clause

See Also:

• orderQueryBySortOrder()
• EntityDefinition.orderBy()

userPreferencesKey

protected String userPreferencesKey()

Returns the key used to identify user preferences for this table model, that is column positions, widths and such. The default implementation is:

 
 return getClass().getSimpleName() + "-" + entityType();
 
 

Override in case this key is not unique.

Returns:

the key used to identify user preferences for this table model