org.jminor.framework.model

Interface EntityTableModel<E extends EntityEditModel>

Type Parameters:

E - the type of EntityEditModel used by this EntityTableModel

All Superinterfaces:

EntityDataProvider, FilteredModel<Entity>, Refreshable

All Known Implementing Classes:

FXEntityListModel, SwingEntityTableModel

public interface EntityTableModel<E extends EntityEditModel>
extends EntityDataProvider, FilteredModel<Entity>, Refreshable

Specifies a table model containing Entity objects

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EntityTableModel.InsertAction Defines the actions a table model can perform when entities are inserted via the associated edit model

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFERENCES_COLUMN_INDEX
static java.lang.String	PREFERENCES_COLUMN_VISIBLE
static java.lang.String	PREFERENCES_COLUMN_WIDTH
static java.lang.String	PREFERENCES_COLUMNS

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)
void	deleteSelected() Deletes the selected entities
java.util.List<Entity>	getAllItems()
ColumnSummaryModel	getColumnSummaryModel(java.lang.String propertyId) Returns the ColumnSummaryModel associated with the property identified by propertyId
EntityTableConditionModel	getConditionModel()
Domain	getDomain()
E	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()
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()
java.lang.Object	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.
int	getRowCount()
java.util.Iterator<Entity>	getSelectedEntitiesIterator() Returns an Iterator which iterates through the selected entities
SelectionModel<Entity>	getSelectionModel()
java.lang.String	getStatusMessage()
java.lang.String	getTableDataAsDelimitedString(char delimiter)
boolean	hasEditModel()
int	indexOf(Entity.Key primaryKey)
boolean	isBatchUpdateAllowed()
boolean	isDeleteAllowed()
boolean	isReadOnly()
boolean	isRefreshOnForeignKeyConditionValuesSet()
boolean	isRemoveEntitiesOnDelete()
boolean	isUpdateAllowed()
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
EntityTableModel<E>	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(E 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.
EntityTableModel<E>	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.
EntityTableModel<E>	setInsertAction(EntityTableModel.InsertAction insertAction)
EntityTableModel	setRefreshOnForeignKeyConditionValuesSet(boolean value)
EntityTableModel<E>	setRemoveEntitiesOnDelete(boolean value)
void	setSelectedByKey(java.util.Collection<Entity.Key> keys) Sets the selected entities according to the primary keys in primaryKeys
void	update(java.util.List<Entity> entities) Updates the given entities.

Methods inherited from interface org.jminor.framework.model.EntityDataProvider

getConnectionProvider, getEntityId

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

Field Detail

PREFERENCES_COLUMNS

static final java.lang.String PREFERENCES_COLUMNS

See Also:

Constant Field Values

PREFERENCES_COLUMN_WIDTH

static final java.lang.String PREFERENCES_COLUMN_WIDTH

See Also:

Constant Field Values

PREFERENCES_COLUMN_VISIBLE

static final java.lang.String PREFERENCES_COLUMN_VISIBLE

See Also:

Constant Field Values

PREFERENCES_COLUMN_INDEX

static final java.lang.String PREFERENCES_COLUMN_INDEX

See Also:

Constant Field Values

Method Detail

getDomain

Domain getDomain()

Returns:

the underlying domain model

getEntityDefinition

Entity.Definition getEntityDefinition()

Returns:

the definition of the underlying entity

getEditModel

E getEditModel()

Returns the EntityEditModel associated with this table model

Returns:

the edit model associated with this table model

Throws:

java.lang.IllegalStateException - in case no edit model has been associated with this table model

See Also:

setEditModel(EntityEditModel)

hasEditModel

boolean hasEditModel()

Returns:

true if this EntityTableModel contains a EntityEditModel

setEditModel

void setEditModel(E 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

Parameters:

editModel - the edit model to associate with this table model

Throws:

java.lang.IllegalStateException - in case an EntityEditModel has already been associated with this EntityTableModel

java.lang.IllegalArgumentException - in case the given EntityEditModel is not based on the same entityId as this EntityTableModel

See Also:

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

setForeignKeyConditionValues

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.

Parameters:

foreignKeyProperty - the ID of the foreign key property

foreignKeyValues - the entities to use as condition values

replaceForeignKeyValues

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.

Parameters:

foreignKeyEntityId - the entity ID of the foreign key values

foreignKeyValues - the foreign key entities

addEntities

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.

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

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

Replaces the given entities in this table model

Parameters:

entities - the entities to replace

refreshEntities

void refreshEntities(java.util.List<Entity.Key> keys)

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

Parameters:

keys - the keys of the entities to refresh

getConditionModel

EntityTableConditionModel getConditionModel()

Returns:

the EntityTableConditionModel instance used by this table model

isDeleteAllowed

boolean isDeleteAllowed()

Returns:

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

See Also:

hasEditModel(), setEditModel(EntityEditModel)

isReadOnly

boolean isReadOnly()

Returns:

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

See Also:

hasEditModel(), setEditModel(EntityEditModel)

isUpdateAllowed

boolean isUpdateAllowed()

Returns:

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

See Also:

hasEditModel(), setEditModel(EntityEditModel)

isBatchUpdateAllowed

boolean isBatchUpdateAllowed()

Returns:

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

setBatchUpdateAllowed

EntityTableModel<E> setBatchUpdateAllowed(boolean batchUpdateAllowed)

Parameters:

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

Returns:

this EntityTableModel instance

getColumnSummaryModel

ColumnSummaryModel getColumnSummaryModel(java.lang.String propertyId)

Returns the ColumnSummaryModel associated with the property identified by propertyId

Parameters:

propertyId - the ID of the property

Returns:

the ColumnSummaryModel for the given property ID

getPropertyBackgroundColor

java.lang.Object getPropertyBackgroundColor(int row,
                                            Property property)

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)

getPropertyColumnIndex

int getPropertyColumnIndex(java.lang.String propertyId)

Parameters:

propertyId - the propertyId

Returns:

the index of the column representing the given property

getStatusMessage

java.lang.String getStatusMessage()

Returns:

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

getFetchCount

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

Returns:

the fetch count

setFetchCount

EntityTableModel<E> 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

Parameters:

fetchCount - the fetch count

Returns:

this table model

update

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.

Parameters:

entities - the entities to update

Throws:

DatabaseException - in case of a database exception

CancelException - in case the user cancels the operation

RecordModifiedException - in case an entity was modified by another user

ValidationException - in case validation fails

java.lang.IllegalStateException - in case this table model has no edit model or if the edit model does not allow updating

See Also:

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

deleteSelected

void deleteSelected()
             throws DatabaseException

Deletes the selected entities

Throws:

DatabaseException - in case of a database exception

CancelException - in case the user cancels the operation

java.lang.IllegalStateException - in case this table model has no edit model or if the edit model does not allow deleting

getQueryConditionRequiredState

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.

Returns:

a State specifying whether this table model requires a query condition

isRemoveEntitiesOnDelete

boolean isRemoveEntitiesOnDelete()

Returns:

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

setRemoveEntitiesOnDelete

EntityTableModel<E> setRemoveEntitiesOnDelete(boolean value)

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

getInsertAction

EntityTableModel.InsertAction getInsertAction()

Returns:

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

setInsertAction

EntityTableModel<E> setInsertAction(EntityTableModel.InsertAction insertAction)

Parameters:

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

Returns:

this EntityTableModel instance

getEntitiesByKey

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

Finds entities according to the values in keys

Parameters:

keys - the primary key values to use as condition

Returns:

the entities having the primary key values as in keys

setSelectedByKey

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

Sets the selected entities according to the primary keys in primaryKeys

Parameters:

keys - the primary keys of the entities to select

getSelectedEntitiesIterator

java.util.Iterator<Entity> getSelectedEntitiesIterator()

Returns an Iterator which iterates through the selected entities

Returns:

the iterator used when generating reports

getEntityByKey

Entity getEntityByKey(Entity.Key primaryKey)

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

int indexOf(Entity.Key primaryKey)

Parameters:

primaryKey - the primary key

Returns:

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

savePreferences

void savePreferences()

Saves any user preferences

setColumns

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

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

Parameters:

propertyIds - the column identifiers

getTableDataAsDelimitedString

java.lang.String getTableDataAsDelimitedString(char delimiter)

Parameters:

delimiter - the delimiter

Returns:

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

getAllItems

java.util.List<Entity> getAllItems()

Specified by:

getAllItems in interface FilteredModel<Entity>

Returns:

the items in this table model, visible and filtered

getRowCount

int getRowCount()

Returns:

the number of visible rows in this table model

getSelectionModel

SelectionModel<Entity> getSelectionModel()

Returns:

the SelectionModel

addSelectionChangedListener

void addSelectionChangedListener(EventListener listener)

Parameters:

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

setRefreshOnForeignKeyConditionValuesSet

EntityTableModel setRefreshOnForeignKeyConditionValuesSet(boolean value)

Parameters:

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

Returns:

this EntityTableModel instance

See Also:

setForeignKeyConditionValues(ForeignKeyProperty, Collection)

isRefreshOnForeignKeyConditionValuesSet

boolean isRefreshOnForeignKeyConditionValuesSet()

Returns:

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

See Also:

setForeignKeyConditionValues(ForeignKeyProperty, Collection)