Module is.codion.swing.framework.model

Package is.codion.swing.framework.model

Class SwingEntityTableModel

java.lang.Object

is.codion.framework.model.AbstractEntityTableModel<SwingEntityModel,SwingEntityEditModel,SwingEntityTableModel,SwingEntityEditor>

is.codion.swing.framework.model.SwingEntityTableModel

All Implemented Interfaces:

FilterModel<Entity>, EntityTableModel<SwingEntityModel,SwingEntityEditModel,SwingEntityTableModel,SwingEntityEditor>, FilterTableModel<Entity,Attribute<?>>, TableModel

public class SwingEntityTableModel
extends AbstractEntityTableModel<SwingEntityModel,SwingEntityEditModel,SwingEntityTableModel,SwingEntityEditor>
implements FilterTableModel<Entity,Attribute<?>>

A TableModel implementation for displaying and working with entities.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SwingEntityTableModel.SwingEntityTableEditor	A Swing specific EntityTableModel.EntityTableEditor implementation.

Nested classes/interfaces inherited from class is.codion.framework.model.AbstractEntityTableModel

AbstractEntityTableModel.AbstractEntityTableEditor

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

EntityTableModel.EntityTableEditor, EntityTableModel.OnInsert, EntityTableModel.RefreshTask

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

FilterModel.AbstractRefresher<T>, FilterModel.FilteredItems<T>, FilterModel.IncludedItems<T>, FilterModel.IncludePredicate<T>, FilterModel.Items<T>, FilterModel.Refresher<T>, FilterModel.Sort<T>

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

FilterTableModel.Builder<R,C>, FilterTableModel.ColumnValues<C>, FilterTableModel.Editor<R,C>, FilterTableModel.Export<C>, FilterTableModel.TableColumns<R,C>

Field Summary

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

ON_INSERT, ORDER_QUERY

Fields inherited from interface is.codion.common.model.filter.FilterModel

ASYNC

Constructor Summary

Constructors

Constructor	Description
SwingEntityTableModel(EntityType entityType, EntityConnectionProvider connectionProvider)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(EntityType entityType, Collection<Entity> entities, EntityConnectionProvider connectionProvider)	Instantiates a new SwingEntityTableModel containing the given entites.
SwingEntityTableModel(EntityConditionModel conditionModel)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(EntityQueryModel queryModel)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(SwingEntityEditModel editModel)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(SwingEntityEditModel editModel, EntityQueryModel queryModel)	Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(Collection<Entity> entities, EntityConnectionProvider connectionProvider)	Instantiates a new SwingEntityTableModel containing the given entites.

Method Summary

Modifier and Type	Method	Description
final void	addTableModelListener(TableModelListener listener)
final FilterTableModel.TableColumns<Entity,Attribute<?>>	columns()
final SwingEntityTableModel.SwingEntityTableEditor	editor()
final FilterTableModel.Export<Attribute<?>>	export()
protected final FilterTableModel<Entity,Attribute<?>>	filterModel()
final TableConditionModel<Attribute<?>>	filters()
final void	fireTableDataChanged()	Notifies all listeners that all cell values in the table's rows may have changed.
final void	fireTableRowsUpdated(int fromIndex, int toIndex)	Notifies all listeners that the given rows have changed
final Class<?>	getColumnClass(int columnIndex)
final Class<?>	getColumnClass(Attribute<?> attribute)	Returns the class of the column with the given identifier
final int	getColumnCount()
final String	getColumnName(int columnIndex)
final int	getRowCount()
final @Nullable Object	getValueAt(int rowIndex, int columnIndex)
final boolean	isCellEditable(int rowIndex, int modelColumnIndex)	Returns true if the cell at rowIndex and modelColumnIndex is editable.
final FilterModel.Items<Entity>	items()
protected final void	onRowsUpdated(int fromIndex, int toIndex)	Notifies all listeners that the given rows have changed
protected final Optional<OrderBy>	orderBy()
final void	refresh(Collection<Entity.Key> keys)	Refreshes the entities with the given keys by re-selecting them from the underlying database.
final void	removeTableModelListener(TableModelListener listener)
final FilterListSelection<Entity>	selection()
final void	setValueAt(@Nullable Object value, int rowIndex, int modelColumnIndex)	Sets the value in the given cell and updates the underlying Entity.
final FilterTableSort<Entity,Attribute<?>>	sort()
final FilterTableModel.ColumnValues<Attribute<?>>	values()	Provides access to column values

Methods inherited from class is.codion.framework.model.AbstractEntityTableModel

connection, connectionProvider, deleteSelected, editModel, entities, entityDefinition, entityType, onInsert, orderQuery, query, refreshTask, removeDeleted, replace, select, toString, updated

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(Collection<Entity> entities,
 EntityConnectionProvider connectionProvider)

Instantiates a new SwingEntityTableModel containing the given entites.

Parameters:

entities - the entities to populate with model with

connectionProvider - the connection provider

Throws:

IllegalArgumentException - in case entities is empty

SwingEntityTableModel

public SwingEntityTableModel(EntityType entityType,
 Collection<Entity> entities,
 EntityConnectionProvider connectionProvider)

Instantiates a new SwingEntityTableModel containing the given entites.

Parameters:

entityType - the entity type

entities - the entities to populate with model with

connectionProvider - the connection provider

Throws:

IllegalArgumentException - in case entities is empty

SwingEntityTableModel

public SwingEntityTableModel(EntityConditionModel conditionModel)

Instantiates a new SwingEntityTableModel.

Parameters:

conditionModel - the EntityConditionModel

SwingEntityTableModel

public SwingEntityTableModel(EntityQueryModel queryModel)

Instantiates a new SwingEntityTableModel.

Parameters:

queryModel - the table query model

SwingEntityTableModel

public SwingEntityTableModel(SwingEntityEditModel editModel)

Instantiates a new SwingEntityTableModel.

Parameters:

editModel - the edit model

SwingEntityTableModel

public SwingEntityTableModel(SwingEntityEditModel editModel,
 EntityQueryModel queryModel)

Instantiates a new SwingEntityTableModel.

Parameters:

editModel - the edit model

queryModel - the table query model

Throws:

IllegalArgumentException - in case the edit model and query model entity type is not the same

Method Details

isCellEditable

public final 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

setValueAt

public final void setValueAt(@Nullable 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

getRowCount

public final int getRowCount()

Specified by:

getRowCount in interface TableModel

getValueAt

public final @Nullable Object getValueAt(int rowIndex,
 int columnIndex)

Specified by:

getValueAt in interface TableModel

fireTableDataChanged

public final void fireTableDataChanged()

Description copied from interface: FilterTableModel

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 FilterTableModel<Entity,Attribute<?>>

fireTableRowsUpdated

public final void fireTableRowsUpdated(int fromIndex,
 int toIndex)

Description copied from interface: FilterTableModel

Notifies all listeners that the given rows have changed

Specified by:

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

Parameters:

fromIndex - the from index

toIndex - the to index

items

public final FilterModel.Items<Entity> items()

Specified by:

items in interface FilterModel<Entity>

Returns:

the model items

values

public final FilterTableModel.ColumnValues<Attribute<?>> values()

Description copied from interface: FilterTableModel

Provides access to column values

Specified by:

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

Returns:

the FilterTableModel.ColumnValues

getColumnClass

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

Description copied from interface: FilterTableModel

Returns the class of the column with the given identifier

Specified by:

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

Parameters:

attribute - the column identifier

Returns:

the Class representing the given column

selection

public final FilterListSelection<Entity> selection()

Specified by:

selection in interface EntityTableModel<SwingEntityModel,SwingEntityEditModel,SwingEntityTableModel,SwingEntityEditor>

Specified by:

selection in interface FilterModel<Entity>

Specified by:

selection in interface FilterTableModel<Entity,Attribute<?>>

Returns:

the FilterListSelection instance used by this table model

filters

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

Specified by:

filters in interface FilterTableModel<Entity,Attribute<?>>

Returns:

the TableConditionModel used to filter this table model

sort

public final FilterTableSort<Entity,Attribute<?>> sort()

Specified by:

sort in interface FilterModel<Entity>

Specified by:

sort in interface FilterTableModel<Entity,Attribute<?>>

Returns:

the sort

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

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

columns

public final FilterTableModel.TableColumns<Entity,Attribute<?>> columns()

Specified by:

columns in interface FilterTableModel<Entity,Attribute<?>>

Returns:

the table columns

export

public final FilterTableModel.Export<Attribute<?>> export()

Specified by:

export in interface FilterTableModel<Entity,Attribute<?>>

Returns:

a FilterTableModel.Export instance for exporting the table model data

editor

public final SwingEntityTableModel.SwingEntityTableEditor editor()

Specified by:

editor in interface EntityTableModel<SwingEntityModel,SwingEntityEditModel,SwingEntityTableModel,SwingEntityEditor>

Specified by:

editor in interface FilterTableModel<Entity,Attribute<?>>

Returns:

the FilterTableModel.Editor providing the row editing functionality

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<SwingEntityModel,SwingEntityEditModel,SwingEntityTableModel,SwingEntityEditor>

Parameters:

keys - the keys of the entities to refresh

filterModel

protected final FilterTableModel<Entity,Attribute<?>> filterModel()

Overrides:

filterModel in class AbstractEntityTableModel<SwingEntityModel,SwingEntityEditModel,SwingEntityTableModel,SwingEntityEditor>

Returns:

the underlying model

onRowsUpdated

protected final void onRowsUpdated(int fromIndex,
 int toIndex)

Description copied from class: AbstractEntityTableModel

Notifies all listeners that the given rows have changed

Specified by:

onRowsUpdated in class AbstractEntityTableModel<SwingEntityModel,SwingEntityEditModel,SwingEntityTableModel,SwingEntityEditor>

Parameters:

fromIndex - the from index

toIndex - the to index

orderBy

protected final Optional<OrderBy> orderBy()

Specified by:

orderBy in class AbstractEntityTableModel<SwingEntityModel,SwingEntityEditModel,SwingEntityTableModel,SwingEntityEditor>

Returns:

a OrderBy instance based on the sort order according to the FilterModel.sort() model, an empty Optional if unsorted