is.codion.swing.framework.model

Class SwingEntityTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

is.codion.swing.common.model.component.table.DefaultFilteredTableModel<Entity,Attribute<?>>

is.codion.swing.framework.model.SwingEntityTableModel

All Implemented Interfaces:

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

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

A TableModel implementation for displaying and working with entities.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class is.codion.swing.common.model.component.table.DefaultFilteredTableModel

DefaultFilteredTableModel.DefaultSummaryValueProvider<T extends Number,C>

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

EntityTableModel.ColumnPreferences, EntityTableModel.InsertAction

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

FilteredTableModel.ColumnValueProvider<R,C>, FilteredTableModel.RowsRemoved

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

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

ORDER_QUERY_BY_SORT_ORDER, QUERY_HIDDEN_COLUMNS

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

ASYNC_REFRESH

Constructor Summary

Constructors

Constructor and Description
SwingEntityTableModel(EntityType entityType, EntityConnectionProvider connectionProvider) Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(EntityType entityType, EntityConnectionProvider connectionProvider, EntityTableConditionModel tableConditionModel) Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(SwingEntityEditModel editModel) Instantiates a new SwingEntityTableModel.
SwingEntityTableModel(SwingEntityEditModel editModel, EntityTableConditionModel tableConditionModel) Instantiates a new SwingEntityTableModel.

Method Summary

Modifier and Type	Method and Description
void	addEntities(Collection<Entity> entities) Adds the given entities to the bottom of this table model.
void	addEntitiesAt(int index, Collection<Entity> entities) Adds the given entities to the top of this table model.
void	addEntitiesAtSorted(int index, Collection<Entity> entities) Adds the given entities to the top of this table model and then, if sorting is enabled, sorts this table model.
void	addEntitiesSorted(Collection<Entity> entities) Adds the given entities to the bottom of this table model and then, if sorting is enabled, sorts this table model.
void	addSelectionListener(EventListener listener)
Color	backgroundColor(int row, Attribute<?> attribute)
StateObserver	conditionChangedObserver()
EntityConnectionProvider	connectionProvider()
static List<FilteredTableColumn<Attribute<?>>>	createColumns(EntityDefinition definition) Initializes default TableColumns for all visible properties in the given entity type.
static List<FilteredTableColumn<Attribute<?>>>	createColumns(List<Property<?>> properties) Initializes default TableColumns from the given properties.
protected <T extends Number> Optional<ColumnSummaryModel.SummaryValueProvider<T>>	createColumnValueProvider(Attribute<?> attribute) Creates a ColumnValueProvider for the given column
void	deleteSelected() Deletes the selected entities
SwingEntityEditModel	editModel() Returns the EntityEditModel associated with this table model
Entities	entities()
Collection<Entity>	entitiesByKey(Collection<Key> keys) Finds entities according to the values in keys
Entity	entityByKey(Key primaryKey)
EntityDefinition	entityDefinition()
EntityType	entityType()
Color	foregroundColor(int row, Attribute<?> attribute)
protected Color	getColor(Object color) Returns a Color instance from the given Object.
EntityTableModel.InsertAction	getInsertAction()
int	getLimit() Returns the maximum number of records to fetch via the underlying query the next time this table model is refreshed, a value of -1 means all records should be fetched
int	indexOf(Key primaryKey)
boolean	isBatchUpdateEnabled()
boolean	isCellEditable(int rowIndex, int modelColumnIndex) Returns true if the cell at rowIndex and modelColumnIndex is editable.
boolean	isDeleteEnabled()
boolean	isEditable()
boolean	isOrderQueryBySortOrder() Specifies whether the current sort order is used as a basis for the query order by clause.
boolean	isQueryHiddenColumns() Returns whether the values of hidden columns are included when querying data
boolean	isReadOnly()
boolean	isRemoveDeletedEntities()
boolean	isUpdateEnabled()
protected OrderBy	orderBy() The order by clause to use when selecting the data for this model.
State	queryConditionRequiredState() Returns a State controlling whether this table model should display all underlying entities when no query condition has been set.
void	refreshEntities(List<Key> keys) Refreshes the entities with the given keys by re-selecting them from the underlying database.
protected Collection<Entity>	refreshItems() Queries for the data used to populate this EntityTableModel when it is refreshed, using the order by clause returned by orderBy()
void	replaceEntities(Collection<Entity> entities) Replaces the given entities in this table model
void	replaceForeignKeyValues(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 property values have been changed in the referenced entity that must be reflected in the table model.
void	savePreferences() Saves any user preferences.
protected Collection<Attribute<?>>	selectAttributes() Specifies the attributes to select when querying data.
void	selectByKey(Collection<Key> keys) Sets the selected entities according to the primary keys in primaryKeys
void	setBatchUpdateEnabled(boolean batchUpdateEnabled)
void	setEditable(boolean editable)
boolean	setForeignKeyConditionValues(ForeignKey foreignKey, Collection<Entity> foreignKeyValues) Sets foreignKeyValues as the search condition values for the given foreign key and refreshes this table model.
void	setInsertAction(EntityTableModel.InsertAction insertAction)
void	setLimit(int limit) Sets the maximum number of records to fetch via the underlying query the next time this table model is refreshed, a value of -1 means all records should be fetched
void	setOrderQueryBySortOrder(boolean orderQueryBySortOrder) Specifies whether the current sort order is used as a basis for the query order by clause.
void	setQueryHiddenColumns(boolean queryHiddenColumns)
void	setRemoveDeletedEntities(boolean removeDeletedEntities)
void	setValueAt(Object value, int rowIndex, int modelColumnIndex) Sets the value in the given cell and updates the underlying Entity.
void	setVisibleColumns(Attribute<?>... attributes) Arranges the column model so that only the given columns are visible and in the given order
void	setVisibleColumns(List<Attribute<?>> attributes) Arranges the column model so that only the given columns are visible and in the given order
ValueObserver<String>	statusMessageObserver()
EntityTableConditionModel	tableConditionModel()
String	tableDataAsDelimitedString(char delimiter)
String	toString()
void	update(List<Entity> entities) Updates the given entities.
protected String	userPreferencesKey() Returns the key used to identify user preferences for this table model, that is column positions, widths and such.

Methods inherited from class is.codion.swing.common.model.component.table.DefaultFilteredTableModel

addClearListener, addDataChangedListener, addFilterListener, addItem, addItems, addItemsAt, addItemsAtSorted, addItemSorted, addItemsSorted, addRefreshFailedListener, addRefreshListener, addRowsRemovedListener, addSortListener, allowSelectionChange, clear, columnFilterModel, columnFilterModels, columnModel, columnSummaryModel, containsItem, filteredItemCount, filteredItems, filterItems, getColumnClass, getColumnClass, getColumnCount, getIncludeCondition, getRowCount, getStringValueAt, getValueAt, indexOf, isAsyncRefresh, isFiltered, isMergeOnRefresh, isVisible, itemAt, items, refresh, refreshingObserver, refreshThen, removeClearListener, removeDataChangedListener, removeFilterListener, removeItem, removeItemAt, removeItems, removeItems, removeRefreshFailedListener, removeRefreshListener, removeRowsRemovedListener, removeSortListener, searchModel, selectedValues, selectionModel, setAsyncRefresh, setIncludeCondition, setItemAt, setMergeOnRefresh, sortItems, sortModel, values, visibleItemCount, visibleItems

Methods inherited from class javax.swing.table.AbstractTableModel

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

Methods inherited from class java.lang.Object

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

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

clear, columnPreferences, getRowCount, refresh, selectionModel

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

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, getColumnName, removeTableModelListener

Constructor Detail

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,
                             EntityTableConditionModel tableConditionModel)

Instantiates a new SwingEntityTableModel.

Parameters:

entityType - the entityType

connectionProvider - the connection provider

tableConditionModel - the table condition model

SwingEntityTableModel

public SwingEntityTableModel(SwingEntityEditModel editModel)

Instantiates a new SwingEntityTableModel.

Parameters:

editModel - the edit model

SwingEntityTableModel

public SwingEntityTableModel(SwingEntityEditModel editModel,
                             EntityTableConditionModel tableConditionModel)

Instantiates a new SwingEntityTableModel.

Parameters:

editModel - the edit model

tableConditionModel - the table condition model

Method Detail

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

getLimit

public final int getLimit()

Description copied from interface: EntityTableModel

Returns the maximum number of records to fetch via the underlying query the next time this table model is refreshed, a value of -1 means all records should be fetched

Specified by:

getLimit in interface EntityTableModel<SwingEntityEditModel>

Returns:

the fetch count

setLimit

public final void setLimit(int limit)

Description copied from interface: EntityTableModel

Sets the maximum number of records to fetch via the underlying query the next time this table model is refreshed, a value of -1 means all records should be fetched

Specified by:

setLimit in interface EntityTableModel<SwingEntityEditModel>

Parameters:

limit - the fetch count

isQueryHiddenColumns

public final boolean isQueryHiddenColumns()

Description copied from interface: EntityTableModel

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

Specified by:

isQueryHiddenColumns in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if the values of hidden columns are included when querying data

setQueryHiddenColumns

public final void setQueryHiddenColumns(boolean queryHiddenColumns)

Specified by:

setQueryHiddenColumns in interface EntityTableModel<SwingEntityEditModel>

Parameters:

queryHiddenColumns - true if the values of hidden columns should be included when querying data

See Also:

EntityTableModel.QUERY_HIDDEN_COLUMNS

isOrderQueryBySortOrder

public final boolean isOrderQueryBySortOrder()

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 properties.

Specified by:

isOrderQueryBySortOrder in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if the current sort order should be used as a basis for the query order by clause

setOrderQueryBySortOrder

public final void setOrderQueryBySortOrder(boolean 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 properties.

Specified by:

setOrderQueryBySortOrder in interface EntityTableModel<SwingEntityEditModel>

Parameters:

orderQueryBySortOrder - true if the current sort order should be used as a basis for the query order by clause

queryConditionRequiredState

public final State queryConditionRequiredState()

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 records from being fetched by accident, when no condition has been set, which is recommended for tables with a large underlying dataset.

Specified by:

queryConditionRequiredState in interface EntityTableModel<SwingEntityEditModel>

Returns:

a State specifying whether this table model requires a query condition

getInsertAction

public final EntityTableModel.InsertAction getInsertAction()

Specified by:

getInsertAction in interface EntityTableModel<SwingEntityEditModel>

Returns:

the action performed when entities are inserted via the associated edit model

setInsertAction

public final void setInsertAction(EntityTableModel.InsertAction insertAction)

Specified by:

setInsertAction in interface EntityTableModel<SwingEntityEditModel>

Parameters:

insertAction - the action to perform when entities are inserted via the associated edit model

isRemoveDeletedEntities

public final boolean isRemoveDeletedEntities()

Specified by:

isRemoveDeletedEntities in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if entities that are deleted via the associated edit model should be automatically removed from this table model

setRemoveDeletedEntities

public final void setRemoveDeletedEntities(boolean removeDeletedEntities)

Specified by:

setRemoveDeletedEntities in interface EntityTableModel<SwingEntityEditModel>

Parameters:

removeDeletedEntities - true if entities that are deleted via the associated edit model should be automatically removed from this table model

entityType

public final EntityType entityType()

Specified by:

entityType in interface EntityTableModel<SwingEntityEditModel>

Returns:

the type of the entity this table model is based on

tableConditionModel

public final EntityTableConditionModel tableConditionModel()

Specified by:

tableConditionModel in interface EntityTableModel<SwingEntityEditModel>

Returns:

the EntityTableConditionModel instance used by this table model

editModel

public final SwingEntityEditModel editModel()

Description copied from interface: EntityTableModel

Returns the EntityEditModel associated with this table model

Specified by:

editModel in interface EntityTableModel<SwingEntityEditModel>

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

isEditable

public final boolean isEditable()

Specified by:

isEditable in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if this table model is editable

setEditable

public final void setEditable(boolean editable)

Specified by:

setEditable in interface EntityTableModel<SwingEntityEditModel>

Parameters:

editable - true if this table model should be editable

isBatchUpdateEnabled

public final boolean isBatchUpdateEnabled()

Specified by:

isBatchUpdateEnabled in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if multiple entities can be updated at a time

setBatchUpdateEnabled

public final void setBatchUpdateEnabled(boolean batchUpdateEnabled)

Specified by:

setBatchUpdateEnabled in interface EntityTableModel<SwingEntityEditModel>

Parameters:

batchUpdateEnabled - true if this model should enable multiple entities to be updated at a time

isDeleteEnabled

public final boolean isDeleteEnabled()

Specified by:

isDeleteEnabled in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if the underlying edit model allows deletion of records

isUpdateEnabled

public final boolean isUpdateEnabled()

Specified by:

isUpdateEnabled in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if the underlying edit model allows updating of records

isReadOnly

public final boolean isReadOnly()

Specified by:

isReadOnly in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if the underlying edit model is read only

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

Overrides:

isCellEditable in class AbstractTableModel

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

Overrides:

setValueAt in class AbstractTableModel

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)

entityByKey

public final Entity entityByKey(Key primaryKey)

Specified by:

entityByKey in interface EntityTableModel<SwingEntityEditModel>

Parameters:

primaryKey - the primary key to search by

Returns:

the entity with the given primary key from the table model, null if it's not found

indexOf

public final int indexOf(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

addEntities

public final void addEntities(Collection<Entity> entities)

Description copied from interface: EntityTableModel

Adds the given entities to the bottom of this table model. It is recommended to only manually add entities directly to this table model after they have been inserted into the underlying table since otherwise they will disappear during the next table model refresh.

Specified by:

addEntities in interface EntityTableModel<SwingEntityEditModel>

Parameters:

entities - the entities to add

addEntitiesSorted

public final void addEntitiesSorted(Collection<Entity> entities)

Description copied from interface: EntityTableModel

Adds the given entities to the bottom of this table model and then, if sorting is enabled, sorts this table model. It is recommended to only manually add entities directly to this table model after they have been inserted into the underlying table since otherwise they will disappear during the next table model refresh.

Specified by:

addEntitiesSorted in interface EntityTableModel<SwingEntityEditModel>

Parameters:

entities - the entities to add

addEntitiesAt

public final void addEntitiesAt(int index,
                                Collection<Entity> entities)

Description copied from interface: EntityTableModel

Adds the given entities to the top of this table model. It is recommended to only manually add entities directly to this table model after they have been inserted into the underlying table since otherwise they will disappear during the next table model refresh.

Specified by:

addEntitiesAt in interface EntityTableModel<SwingEntityEditModel>

Parameters:

index - the index at which to add

entities - the entities to add

addEntitiesAtSorted

public final void addEntitiesAtSorted(int index,
                                      Collection<Entity> entities)

Description copied from interface: EntityTableModel

Adds the given entities to the top of this table model and then, if sorting is enabled, sorts this table model. It is recommended to only manually add entities directly to this table model after they have been inserted into the underlying table since otherwise they will disappear during the next table model refresh.

Specified by:

addEntitiesAtSorted in interface EntityTableModel<SwingEntityEditModel>

Parameters:

index - the index at which to add

entities - the entities to add

replaceEntities

public final void replaceEntities(Collection<Entity> entities)

Description copied from interface: EntityTableModel

Replaces the given entities in this table model

Specified by:

replaceEntities in interface EntityTableModel<SwingEntityEditModel>

Parameters:

entities - the entities to replace

refreshEntities

public final void refreshEntities(List<Key> keys)

Description copied from interface: EntityTableModel

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

Specified by:

refreshEntities in interface EntityTableModel<SwingEntityEditModel>

Parameters:

keys - the keys of the entities to refresh

setForeignKeyConditionValues

public boolean setForeignKeyConditionValues(ForeignKey foreignKey,
                                            Collection<Entity> foreignKeyValues)

Description copied from interface: EntityTableModel

Sets foreignKeyValues as the search condition values for the given foreign key and refreshes this table model.

Specified by:

setForeignKeyConditionValues in interface EntityTableModel<SwingEntityEditModel>

Parameters:

foreignKey - the foreign key

foreignKeyValues - the entities to use as condition values

Returns:

true if the table search condition changed due to this call and a refresh is in order, false otherwise

replaceForeignKeyValues

public final void replaceForeignKeyValues(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 property values have been changed in the referenced entity that must be reflected in the table model.

Specified by:

replaceForeignKeyValues in interface EntityTableModel<SwingEntityEditModel>

Parameters:

foreignKey - the foreign key

foreignKeyValues - the foreign key entities

selectByKey

public final void selectByKey(Collection<Key> keys)

Description copied from interface: EntityTableModel

Sets the selected entities according to the primary keys in primaryKeys

Specified by:

selectByKey in interface EntityTableModel<SwingEntityEditModel>

Parameters:

keys - the primary keys of the entities to select

entitiesByKey

public final Collection<Entity> entitiesByKey(Collection<Key> keys)

Description copied from interface: EntityTableModel

Finds entities according to the values in keys

Specified by:

entitiesByKey in interface EntityTableModel<SwingEntityEditModel>

Parameters:

keys - the primary key values to use as condition

Returns:

the entities having the primary key values as in keys

deleteSelected

public final void deleteSelected()
                          throws DatabaseException

Description copied from interface: EntityTableModel

Deletes the selected entities

Specified by:

deleteSelected in interface EntityTableModel<SwingEntityEditModel>

Throws:

DatabaseException - in case of a database exception

update

public final void update(List<Entity> entities)
                  throws ValidationException,
                         DatabaseException

Description copied from interface: EntityTableModel

Updates the given entities. If the entities are unmodified or the list is empty this method returns silently.

Specified by:

update in interface EntityTableModel<SwingEntityEditModel>

Parameters:

entities - the entities to update

Throws:

ValidationException - in case validation fails

DatabaseException - in case of a database exception

RecordModifiedException - in case an entity was modified by another user

See Also:

EntityValidator.validate(Entity)

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>

tableDataAsDelimitedString

public final String tableDataAsDelimitedString(char delimiter)

Specified by:

tableDataAsDelimitedString in interface EntityTableModel<SwingEntityEditModel>

Parameters:

delimiter - the delimiter

Returns:

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

conditionChangedObserver

public final StateObserver conditionChangedObserver()

Specified by:

conditionChangedObserver in interface EntityTableModel<SwingEntityEditModel>

Returns:

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

addSelectionListener

public final void addSelectionListener(EventListener listener)

Specified by:

addSelectionListener in interface EntityTableModel<SwingEntityEditModel>

Parameters:

listener - notified when the selection changes in the underlying selection model

statusMessageObserver

public final ValueObserver<String> statusMessageObserver()

Returns:

an Observer for the table model status message, that is, the number of rows, number of selected rows etc

createColumns

public static List<FilteredTableColumn<Attribute<?>>> createColumns(EntityDefinition definition)

Initializes default TableColumns for all visible properties in the given entity type.

Parameters:

definition - the entity definition

Returns:

a list of TableColumns based on the given entity

createColumns

public static List<FilteredTableColumn<Attribute<?>>> createColumns(List<Property<?>> properties)

Initializes default TableColumns from the given properties.

Parameters:

properties - the properties

Returns:

a list of TableColumns based on the given properties

createColumnValueProvider

protected final <T extends Number> Optional<ColumnSummaryModel.SummaryValueProvider<T>> createColumnValueProvider(Attribute<?> attribute)

Description copied from class: DefaultFilteredTableModel

Creates a ColumnValueProvider for the given column

Overrides:

createColumnValueProvider in class DefaultFilteredTableModel<Entity,Attribute<?>>

Type Parameters:

T - the value type

Parameters:

attribute - the column identifier

Returns:

a ColumnValueProvider for the column identified by the given identifier, an empty Optional if not applicable

refreshItems

protected Collection<Entity> refreshItems()

Queries for the data used to populate this EntityTableModel when it is refreshed, using the order by clause returned by orderBy()

Overrides:

refreshItems in class DefaultFilteredTableModel<Entity,Attribute<?>>

Returns:

entities selected from the database according the query condition.

See Also:

queryConditionRequiredState(), EntityTableConditionModel.condition()

getColor

protected Color getColor(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:

setOrderQueryBySortOrder(boolean), EntityDefinition.orderBy()

selectAttributes

protected Collection<Attribute<?>> selectAttributes()

Specifies the attributes to select when querying data. Return an empty list if all should be included. This method should take the isQueryHiddenColumns() setting into account.

Returns:

the attributes to select when querying data, an empty Collection if all should be selected.

See Also:

isQueryHiddenColumns()

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