org.jminor.swing.framework.model

Class SwingEntityTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

org.jminor.swing.common.model.table.AbstractFilteredTableModel<Entity,Property>

org.jminor.swing.framework.model.SwingEntityTableModel

All Implemented Interfaces:

java.io.Serializable, javax.swing.table.TableModel, FilteredModel<Entity>, Refreshable, FilteredTableModel<Entity,Property,javax.swing.table.TableColumn>, EntityDataProvider, EntityTableModel<SwingEntityEditModel>

public class SwingEntityTableModel
extends AbstractFilteredTableModel<Entity,Property>
implements EntityTableModel<SwingEntityEditModel>

A TableModel implementation for displaying and working with entities.

 String entityId = "some.entity";
 String clientTypeId = "JavadocDemo";
 User user = new User("scott", "tiger");

 EntityConnectionProvider connectionProvider = EntityConnectionProviders.createConnectionProvider(user, clientTypeId);

 SwingEntityTableModel tableModel = new SwingEntityTableModel(entityId, connectionProvider);

 SwingEntityEditModel editModel = ...;

 tableModel.setEditModel(editModel);

 EntityTablePanel panel = new EntityTablePanel(model);
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SwingEntityTableModel.DefaultEntityTableSortModel A default sort model implementation based on Entity

Nested classes/interfaces inherited from class org.jminor.swing.common.model.table.AbstractFilteredTableModel

AbstractFilteredTableModel.DefaultColumnValueProvider

Nested classes/interfaces inherited from interface org.jminor.framework.model.EntityTableModel

EntityTableModel.InsertAction

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Fields inherited from interface org.jminor.framework.model.EntityTableModel

PREFERENCES_COLUMN_INDEX, PREFERENCES_COLUMN_VISIBLE, PREFERENCES_COLUMN_WIDTH, PREFERENCES_COLUMNS

Constructor Summary

Constructors

Constructor and Description
SwingEntityTableModel(java.lang.String entityId, EntityConnectionProvider connectionProvider) Instantiates a new DefaultEntityTableModel with default column and condition models.
SwingEntityTableModel(java.lang.String entityId, EntityConnectionProvider connectionProvider, TableSortModel<Entity,Property,javax.swing.table.TableColumn> sortModel, EntityTableConditionModel conditionModel) Instantiates a new DefaultEntityTableModel.

Method Summary

Modifier and Type	Method and Description
void	addEntities(java.util.List<Entity> entities, boolean atTop, boolean sortAfterAdding) Adds the given entities to 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.
void	addSelectionChangedListener(EventListener listener)
protected void	bindEditModelEvents() Override to bind events using the edit model, called after the edit model has been set
protected ColumnSummaryModel.ColumnValueProvider	createColumnValueProvider(Property property) Creates a ColumnValueProvider for the given column
void	deleteSelected() Deletes the selected entities
protected void	doRefresh() Refreshes the data in this table model.
ColumnSummaryModel	getColumnSummaryModel(java.lang.String propertyId) Returns the ColumnSummaryModel associated with the property identified by propertyId
EntityTableConditionModel	getConditionModel()
EntityConnectionProvider	getConnectionProvider()
Domain	getDomain()
SwingEntityEditModel	getEditModel() Returns the EntityEditModel associated with this table model
java.util.Collection<Entity>	getEntitiesByKey(java.util.Collection<Entity.Key> keys) Finds entities according to the values in keys
Entity	getEntityByKey(Entity.Key primaryKey)
Entity.Definition	getEntityDefinition()
java.lang.String	getEntityId()
int	getFetchCount() 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
EntityTableModel.InsertAction	getInsertAction()
protected Entity.OrderBy	getOrderBy() The order by clause to use when selecting the data for this model, by default the order by clause defined for the underlying entity
java.awt.Color	getPropertyBackgroundColor(int row, Property property)
int	getPropertyColumnIndex(java.lang.String propertyId)
State	getQueryConditionRequiredState() Returns a State controlling whether this table model should display all underlying entities when no query condition has been set.
protected java.lang.String	getSearchValueAt(int rowIndex, javax.swing.table.TableColumn column) Returns the value to use when searching through the table.
java.util.Iterator<Entity>	getSelectedEntitiesIterator() Returns an Iterator which iterates through the selected entities
java.lang.String	getStatusMessage()
java.lang.String	getTableDataAsDelimitedString(char delimiter)
protected java.lang.String	getUserPreferencesKey() Returns the key used to identify user preferences for this table model, that is column positions, widths and such.
protected java.lang.Object	getValue(Entity entity, Property property) Return the value to display in a table cell for the given property of the given entity.
java.lang.Object	getValueAt(int rowIndex, int modelColumnIndex) Returns the value for the cell at modelColumnIndex and rowIndex.
protected void	handleDelete(EntityEditModel.DeleteEvent event)
boolean	hasEditModel()
int	indexOf(Entity.Key primaryKey)
boolean	isBatchUpdateAllowed()
boolean	isCellEditable(int rowIndex, int modelColumnIndex) Returns true if the cell at rowIndex and modelColumnIndex is editable.
boolean	isDeleteAllowed()
boolean	isReadOnly()
boolean	isRefreshOnForeignKeyConditionValuesSet()
boolean	isRemoveEntitiesOnDelete()
boolean	isUpdateAllowed()
protected java.util.List<Entity>	performQuery() Queries for the data used to populate this EntityTableModel when it is refreshed, using the order by clause returned by getOrderBy()
void	refreshEntities(java.util.List<Entity.Key> keys) Refreshes the entities with the given keys by re-selecting them from the underlying database.
void	replaceEntities(java.util.Collection<Entity> entities) Replaces the given entities in this table model
void	replaceForeignKeyValues(java.lang.String foreignKeyEntityId, java.util.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
SwingEntityTableModel	setBatchUpdateAllowed(boolean batchUpdateAllowed)
void	setColumns(java.lang.String... propertyIds) Arranges the column model so that only the given columns are visible and in the given order
void	setEditModel(SwingEntityEditModel editModel) Associates the given EntityEditModel with this EntityTableModel, this enables delete/update functionality via this table model as well as enabling it to react to delete events in the edit model.
SwingEntityTableModel	setFetchCount(int fetchCount) 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	setForeignKeyConditionValues(ForeignKeyProperty foreignKeyProperty, java.util.Collection<Entity> foreignKeyValues) Sets foreignKeyValues as the search condition values for the given foreignKeyProperty and refreshes this table model.
SwingEntityTableModel	setInsertAction(EntityTableModel.InsertAction insertAction)
SwingEntityTableModel	setRefreshOnForeignKeyConditionValuesSet(boolean value)
SwingEntityTableModel	setRemoveEntitiesOnDelete(boolean value)
void	setSelectedByKey(java.util.Collection<Entity.Key> keys) Sets the selected entities according to the primary keys in primaryKeys
void	setSortingDirective(java.lang.String propertyId, SortingDirective directive, boolean addColumnToSort) A convenience method for setting the sorting directive for the given property
void	setValueAt(java.lang.Object value, int rowIndex, int modelColumnIndex) Sets the value in the cell at columnIndex and rowIndex to aValue.
java.lang.String	toString()
void	update(java.util.List<Entity> entities) Updates the given entities.

Methods inherited from class org.jminor.swing.common.model.table.AbstractFilteredTableModel

addFilteringListener, addItems, addItems, addRefreshDoneListener, addRefreshStartedListener, addRowsDeletedListener, addSortingListener, addTableDataChangedListener, addTableModelClearedListener, allowSelectionChange, clear, contains, filterContents, findNextItemCoordinate, findNextItemCoordinate, getAllItems, getColumnClass, getColumnCount, getColumnModel, getColumnSummaryModel, getFilterCondition, getFilteredItemCount, getFilteredItems, getItemAt, getRowCount, getSearchCondition, getSelectionModel, getSortModel, getValues, getVisibleItemCount, getVisibleItems, indexOf, isFiltered, isRegularExpressionSearch, isVisible, refresh, removeFilteringListener, removeItem, removeItems, removeItems, removeRefreshDoneListener, removeRefreshStartedListener, removeRowsDeletedListener, removeSortingListener, removeTableDataChangedListener, removeTableModelClearedListener, setFilterCondition, setRegularExpressionSearch, sortContents

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 org.jminor.framework.model.EntityTableModel

getAllItems, getRowCount, getSelectionModel

Methods inherited from interface org.jminor.common.model.FilteredModel

addFilteringListener, contains, filterContents, getFilterCondition, getFilteredItemCount, getFilteredItems, getVisibleItemCount, getVisibleItems, isFiltered, isVisible, removeFilteringListener, setFilterCondition

Methods inherited from interface org.jminor.common.model.Refreshable

clear, refresh

Constructor Detail

SwingEntityTableModel

public SwingEntityTableModel(java.lang.String entityId,
                             EntityConnectionProvider connectionProvider)

Instantiates a new DefaultEntityTableModel with default column and condition models.

Parameters:

entityId - the entity ID

connectionProvider - the db provider

SwingEntityTableModel

public SwingEntityTableModel(java.lang.String entityId,
                             EntityConnectionProvider connectionProvider,
                             TableSortModel<Entity,Property,javax.swing.table.TableColumn> sortModel,
                             EntityTableConditionModel conditionModel)

Instantiates a new DefaultEntityTableModel.

Parameters:

entityId - the entity ID

connectionProvider - the db provider

conditionModel - the condition model

sortModel - the sort model

Throws:

java.lang.NullPointerException - in case conditionModel is null

java.lang.IllegalArgumentException - if conditionModel entityId does not match the one supplied as parameter

Method Detail

getDomain

public final Domain getDomain()

Specified by:

getDomain in interface EntityTableModel<SwingEntityEditModel>

Returns:

the underlying domain model

getEntityDefinition

public final Entity.Definition getEntityDefinition()

Specified by:

getEntityDefinition in interface EntityTableModel<SwingEntityEditModel>

Returns:

the definition of the underlying entity

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

setEditModel

public final void setEditModel(SwingEntityEditModel editModel)

Associates the given EntityEditModel with this EntityTableModel, this enables delete/update functionality via this table model as well as enabling it to react to delete events in the edit model. Throws a RuntimeException in case the edit model has been previously set

Specified by:

setEditModel in interface EntityTableModel<SwingEntityEditModel>

Parameters:

editModel - the edit model to associate with this table model

See Also:

EntityTableModel.deleteSelected(), EntityTableModel.update(java.util.List)

hasEditModel

public final boolean hasEditModel()

Specified by:

hasEditModel in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if this EntityTableModel contains a EntityEditModel

getFetchCount

public final int getFetchCount()

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:

getFetchCount in interface EntityTableModel<SwingEntityEditModel>

Returns:

the fetch count

setFetchCount

public final SwingEntityTableModel setFetchCount(int fetchCount)

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:

setFetchCount in interface EntityTableModel<SwingEntityEditModel>

Parameters:

fetchCount - the fetch count

Returns:

this table model

getQueryConditionRequiredState

public final State getQueryConditionRequiredState()

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:

getQueryConditionRequiredState 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 SwingEntityTableModel 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

Returns:

this EntityTableModel instance

isRemoveEntitiesOnDelete

public final boolean isRemoveEntitiesOnDelete()

Specified by:

isRemoveEntitiesOnDelete in interface EntityTableModel<SwingEntityEditModel>

Returns:

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

setRemoveEntitiesOnDelete

public final SwingEntityTableModel setRemoveEntitiesOnDelete(boolean value)

Specified by:

setRemoveEntitiesOnDelete in interface EntityTableModel<SwingEntityEditModel>

Parameters:

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

Returns:

this EntityTableModel instance

getEntityId

public final java.lang.String getEntityId()

Specified by:

getEntityId in interface EntityDataProvider

Returns:

the ID of the entity this data provider is based on

getConditionModel

public final EntityTableConditionModel getConditionModel()

Specified by:

getConditionModel in interface EntityTableModel<SwingEntityEditModel>

Returns:

the EntityTableConditionModel instance used by this table model

getEditModel

public final SwingEntityEditModel getEditModel()

Returns the EntityEditModel associated with this table model

Specified by:

getEditModel in interface EntityTableModel<SwingEntityEditModel>

Returns:

the edit model associated with this table model

See Also:

EntityTableModel.setEditModel(EntityEditModel)

getConnectionProvider

public final EntityConnectionProvider getConnectionProvider()

Specified by:

getConnectionProvider in interface EntityDataProvider

Returns:

the connection provider used by this data provider

isBatchUpdateAllowed

public final boolean isBatchUpdateAllowed()

Specified by:

isBatchUpdateAllowed in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if this model allows multiple entities to be updated at a time

setBatchUpdateAllowed

public final SwingEntityTableModel setBatchUpdateAllowed(boolean batchUpdateAllowed)

Specified by:

setBatchUpdateAllowed in interface EntityTableModel<SwingEntityEditModel>

Parameters:

batchUpdateAllowed - true if this model should allow multiple entities to be updated at a time

Returns:

this EntityTableModel instance

setRefreshOnForeignKeyConditionValuesSet

public final SwingEntityTableModel setRefreshOnForeignKeyConditionValuesSet(boolean value)

Specified by:

setRefreshOnForeignKeyConditionValuesSet in interface EntityTableModel<SwingEntityEditModel>

Parameters:

value - true if this table model should automatically refresh when foreign key condition values are set

Returns:

this EntityTableModel instance

See Also:

EntityTableModel.setForeignKeyConditionValues(ForeignKeyProperty, Collection)

isRefreshOnForeignKeyConditionValuesSet

public final boolean isRefreshOnForeignKeyConditionValuesSet()

Specified by:

isRefreshOnForeignKeyConditionValuesSet in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if this table model automatically refreshes when foreign key condition values are set

See Also:

EntityTableModel.setForeignKeyConditionValues(ForeignKeyProperty, Collection)

isDeleteAllowed

public final boolean isDeleteAllowed()

Specified by:

isDeleteAllowed in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if this model has an edit model and that edit model allows deletion of records

See Also:

EntityTableModel.hasEditModel(), EntityTableModel.setEditModel(EntityEditModel)

isUpdateAllowed

public final boolean isUpdateAllowed()

Specified by:

isUpdateAllowed in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if this model has an edit model and that edit model allows updating of records

See Also:

EntityTableModel.hasEditModel(), EntityTableModel.setEditModel(EntityEditModel)

isReadOnly

public final boolean isReadOnly()

Specified by:

isReadOnly in interface EntityTableModel<SwingEntityEditModel>

Returns:

true if this model has no EntityEditModel or if that edit model is read only

See Also:

EntityTableModel.hasEditModel(), EntityTableModel.setEditModel(EntityEditModel)

getPropertyColumnIndex

public final int getPropertyColumnIndex(java.lang.String propertyId)

Specified by:

getPropertyColumnIndex in interface EntityTableModel<SwingEntityEditModel>

Parameters:

propertyId - the propertyId

Returns:

the index of the column representing the given property

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int modelColumnIndex)

Returns true if the cell at rowIndex and modelColumnIndex is editable. Otherwise, setValueAt on the cell will not change the value of that cell.

Specified by:

isCellEditable in interface javax.swing.table.TableModel

Overrides:

isCellEditable in class javax.swing.table.AbstractTableModel

Parameters:

rowIndex - the row whose value to be queried

modelColumnIndex - the column whose value to be queried

Returns:

true if the cell is editable

See Also:

setValueAt(java.lang.Object, int, int)

getValueAt

public final java.lang.Object getValueAt(int rowIndex,
                                         int modelColumnIndex)

Returns the value for the cell at modelColumnIndex and rowIndex. *

Specified by:

getValueAt in interface javax.swing.table.TableModel

Parameters:

rowIndex - the row whose value is to be queried

modelColumnIndex - the column whose value is to be queried

Returns:

the value Object at the specified cell

setValueAt

public void setValueAt(java.lang.Object value,
                       int rowIndex,
                       int modelColumnIndex)

Sets the value in the cell at columnIndex and rowIndex to aValue.

Specified by:

setValueAt in interface javax.swing.table.TableModel

Overrides:

setValueAt in class javax.swing.table.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

setSortingDirective

public final void setSortingDirective(java.lang.String propertyId,
                                      SortingDirective directive,
                                      boolean addColumnToSort)

A convenience method for setting the sorting directive for the given property

Parameters:

propertyId - the property ID

directive - the directive

addColumnToSort - if true then the column is added to the sorting state

See Also:

TableSortModel.setSortingDirective(Object, SortingDirective, boolean)

getPropertyBackgroundColor

public java.awt.Color getPropertyBackgroundColor(int row,
                                                 Property property)

Specified by:

getPropertyBackgroundColor in interface EntityTableModel<SwingEntityEditModel>

Parameters:

row - the row for which to retrieve the background color

property - the property for which to retrieve the background color

Returns:

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

See Also:

Entity.Definition.Builder#setColorProvider(Entity.ColorProvider)

getEntityByKey

public final Entity getEntityByKey(Entity.Key primaryKey)

Specified by:

getEntityByKey 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(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

getStatusMessage

public final java.lang.String getStatusMessage()

Specified by:

getStatusMessage in interface EntityTableModel<SwingEntityEditModel>

Returns:

a String describing the selected/filtered state of this table model

addEntities

public final void addEntities(java.util.List<Entity> entities,
                              boolean atTop,
                              boolean sortAfterAdding)

Adds the given entities to 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

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

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

See Also:

TableSortModel.isSortingEnabled()

replaceEntities

public final void replaceEntities(java.util.Collection<Entity> entities)

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(java.util.List<Entity.Key> keys)

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 void setForeignKeyConditionValues(ForeignKeyProperty foreignKeyProperty,
                                         java.util.Collection<Entity> foreignKeyValues)

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

Specified by:

setForeignKeyConditionValues in interface EntityTableModel<SwingEntityEditModel>

Parameters:

foreignKeyProperty - the ID of the foreign key property

foreignKeyValues - the entities to use as condition values

replaceForeignKeyValues

public final void replaceForeignKeyValues(java.lang.String foreignKeyEntityId,
                                          java.util.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.

Specified by:

replaceForeignKeyValues in interface EntityTableModel<SwingEntityEditModel>

Parameters:

foreignKeyEntityId - the entity ID of the foreign key values

foreignKeyValues - the foreign key entities

setSelectedByKey

public final void setSelectedByKey(java.util.Collection<Entity.Key> keys)

Sets the selected entities according to the primary keys in primaryKeys

Specified by:

setSelectedByKey in interface EntityTableModel<SwingEntityEditModel>

Parameters:

keys - the primary keys of the entities to select

getEntitiesByKey

public final java.util.Collection<Entity> getEntitiesByKey(java.util.Collection<Entity.Key> keys)

Finds entities according to the values in keys

Specified by:

getEntitiesByKey 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

Deletes the selected entities

Specified by:

deleteSelected in interface EntityTableModel<SwingEntityEditModel>

Throws:

DatabaseException - in case of a database exception

update

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

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:

Entity.Validator.validate(java.util.Collection)

getColumnSummaryModel

public final ColumnSummaryModel getColumnSummaryModel(java.lang.String propertyId)

Returns the ColumnSummaryModel associated with the property identified by propertyId

Specified by:

getColumnSummaryModel in interface EntityTableModel<SwingEntityEditModel>

Parameters:

propertyId - the ID of the property

Returns:

the ColumnSummaryModel for the given property ID

getSelectedEntitiesIterator

public final java.util.Iterator<Entity> getSelectedEntitiesIterator()

Returns an Iterator which iterates through the selected entities

Specified by:

getSelectedEntitiesIterator in interface EntityTableModel<SwingEntityEditModel>

Returns:

the iterator used when generating reports

setColumns

public final void setColumns(java.lang.String... propertyIds)

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

Specified by:

setColumns in interface EntityTableModel<SwingEntityEditModel>

Parameters:

propertyIds - the column identifiers

savePreferences

public final void savePreferences()

Saves any user preferences

Specified by:

savePreferences in interface EntityTableModel<SwingEntityEditModel>

getTableDataAsDelimitedString

public final java.lang.String getTableDataAsDelimitedString(char delimiter)

Specified by:

getTableDataAsDelimitedString in interface EntityTableModel<SwingEntityEditModel>

Parameters:

delimiter - the delimiter

Returns:

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

addSelectionChangedListener

public final void addSelectionChangedListener(EventListener listener)

Specified by:

addSelectionChangedListener in interface EntityTableModel<SwingEntityEditModel>

Parameters:

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

createColumnValueProvider

protected final ColumnSummaryModel.ColumnValueProvider createColumnValueProvider(Property property)

Creates a ColumnValueProvider for the given column

Overrides:

createColumnValueProvider in class AbstractFilteredTableModel<Entity,Property>

Parameters:

property - the column identifier

Returns:

a ColumnValueProvider for the column identified by columnIdentifier

doRefresh

protected final void doRefresh()

Refreshes the data in this table model.

Specified by:

doRefresh in class AbstractFilteredTableModel<Entity,Property>

See Also:

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

performQuery

protected java.util.List<Entity> performQuery()

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

Returns:

entities selected from the database according the the query condition.

See Also:

getQueryConditionRequiredState(), EntityTableConditionModel.getCondition()

getValue

protected java.lang.Object getValue(Entity entity,
                                    Property property)

Return the value to display in a table cell for the given property of the given entity. Note that this method is responsible for providing a "human readable" version of the value, such as the caption for value list properties and string versions of foreign key values.

Parameters:

entity - the entity

property - the property

Returns:

the value of the given property for the given entity for display

Throws:

java.lang.NullPointerException - in case entity or property is null

getSearchValueAt

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

Returns the value to use when searching through the table.

Overrides:

getSearchValueAt in class AbstractFilteredTableModel<Entity,Property>

Parameters:

rowIndex - the row index

column - the column

Returns:

the search value

See Also:

AbstractFilteredTableModel.findNextItemCoordinate(int, boolean, String)

getOrderBy

protected Entity.OrderBy getOrderBy()

The order by clause to use when selecting the data for this model, by default the order by clause defined for the underlying entity

Returns:

the order by clause

See Also:

Entity.Definition#getOrderBy()

handleDelete

protected void handleDelete(EntityEditModel.DeleteEvent event)

bindEditModelEvents

protected void bindEditModelEvents()

Override to bind events using the edit model, called after the edit model has been set

getUserPreferencesKey

protected java.lang.String getUserPreferencesKey()

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() + "-" + getEntityId();
 
 

Override in case this key is not unique.

Returns:

the key used to identify user preferences for this table model