org.jminor.javafx.framework.model

Class FXEntityListModel

java.lang.Object

javafx.beans.binding.ListExpression<E>

javafx.beans.property.ReadOnlyListProperty<E>

javafx.beans.property.ListProperty<E>

javafx.beans.property.ListPropertyBase<E>

javafx.beans.property.SimpleListProperty<Entity>

org.jminor.javafx.framework.model.ObservableEntityList

org.jminor.javafx.framework.model.FXEntityListModel

All Implemented Interfaces:

java.lang.Iterable<Entity>, java.util.Collection<Entity>, java.util.List<Entity>, javafx.beans.Observable, javafx.beans.property.Property<javafx.collections.ObservableList<Entity>>, javafx.beans.property.ReadOnlyProperty<javafx.collections.ObservableList<Entity>>, javafx.beans.value.ObservableListValue<Entity>, javafx.beans.value.ObservableObjectValue<javafx.collections.ObservableList<Entity>>, javafx.beans.value.ObservableValue<javafx.collections.ObservableList<Entity>>, javafx.beans.value.WritableListValue<Entity>, javafx.beans.value.WritableObjectValue<javafx.collections.ObservableList<Entity>>, javafx.beans.value.WritableValue<javafx.collections.ObservableList<Entity>>, javafx.collections.ObservableList<Entity>, FilteredModel<Entity>, Refreshable, EntityDataProvider, EntityTableModel<FXEntityEditModel>

public class FXEntityListModel
extends ObservableEntityList
implements EntityTableModel<FXEntityEditModel>

A JavaFX implementation of EntityTableModel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FXEntityListModel.PropertyTableColumn A TableColumn based on a Property instance

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

EntityTableModel.InsertAction

Field Summary

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
FXEntityListModel(java.lang.String entityId, EntityConnectionProvider connectionProvider) Instantiates a new FXEntityListModel based on the given entityId
FXEntityListModel(java.lang.String entityId, EntityConnectionProvider connectionProvider, EntityTableConditionModel conditionModel) Instantiates a new FXEntityListModel based on the given entityId

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.
protected void	bindSelectionModelEvents() Binds model events to the selection model
void	deleteSelected() Deletes the selected entities
ColumnSummaryModel	getColumnSummaryModel(java.lang.String propertyId) Returns the ColumnSummaryModel associated with the property identified by propertyId
EntityTableConditionModel	getConditionModel()
Domain	getDomain()
FXEntityEditModel	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)
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
javafx.scene.paint.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.
int	getRowCount()
java.util.Iterator<Entity>	getSelectedEntitiesIterator() Returns an Iterator which iterates through the selected entities
java.lang.String	getStatusMessage()
EntityTableColumn	getTableColumn(java.lang.String propertyId) Returns the table column for property with the given id
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.
boolean	hasEditModel()
int	indexOf(Entity.Key primaryKey)
boolean	isBatchUpdateAllowed()
boolean	isDeleteAllowed()
boolean	isQueryConfigurationAllowed()
boolean	isReadOnly()
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
FXEntityListModel	setBatchUpdateAllowed(boolean batchUpdateAllowed)
void	setColumns(javafx.collections.ObservableList<? extends javafx.scene.control.TableColumn<Entity,?>> columns) Sets the columns for this FXEntityListModel.
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(FXEntityEditModel 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.
FXEntityListModel	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(Property.ForeignKeyProperty foreignKeyProperty, java.util.Collection<Entity> entities) Sets foreignKeyValues as the search condition values for the given foreignKeyProperty and refreshes this table model.
FXEntityListModel	setInsertAction(EntityTableModel.InsertAction insertAction)
FXEntityListModel	setQueryConfigurationAllowed(boolean queryConfigurationAllowed) Specifies whether or not the underlying query should be configurable
FXEntityListModel	setRemoveEntitiesOnDelete(boolean removeEntitiesOnDelete)
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 class org.jminor.javafx.framework.model.ObservableEntityList

addFilteringListener, addRefreshListener, addSelectionChangedListener, contains, filterContents, getAllItems, getConnectionProvider, getEntityId, getFilterCondition, getFilteredItemCount, getFilteredItems, getFilteredList, getMultipleSelectionObserver, getSelectionEmptyObserver, getSelectionModel, getSingleSelectionObserver, getSortedList, getVisibleItemCount, getVisibleItems, isFiltered, isVisible, refresh, removeFilteringListener, selectionModelHasBeenSet, setFilterCondition, setSelectCondition, setSelectionModel

Methods inherited from class javafx.beans.property.SimpleListProperty

getBean, getName

Methods inherited from class javafx.beans.property.ListPropertyBase

addListener, addListener, addListener, bind, emptyProperty, fireValueChangedEvent, fireValueChangedEvent, get, invalidated, isBound, removeListener, removeListener, removeListener, set, sizeProperty, toString, unbind

Methods inherited from class javafx.beans.property.ListProperty

bindBidirectional, setValue, unbindBidirectional

Methods inherited from class javafx.beans.property.ReadOnlyListProperty

bindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectional

Methods inherited from class javafx.beans.binding.ListExpression

add, add, addAll, addAll, addAll, asString, clear, contains, containsAll, get, getSize, getValue, indexOf, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, iterator, lastIndexOf, listExpression, listIterator, listIterator, remove, remove, remove, removeAll, removeAll, retainAll, retainAll, set, setAll, setAll, size, subList, toArray, toArray, valueAt, valueAt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

addSelectionChangedListener, getAllItems, getSelectionModel

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

Methods inherited from interface javafx.collections.ObservableList

addAll, addListener, filtered, remove, removeAll, removeListener, retainAll, setAll, setAll, sorted, sorted

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Methods inherited from interface javafx.beans.value.ObservableValue

getValue

Methods inherited from interface javafx.beans.value.WritableValue

getValue

Constructor Detail

FXEntityListModel

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

Instantiates a new FXEntityListModel based on the given entityId

Parameters:

entityId - the entityId

connectionProvider - the connection provider

FXEntityListModel

public FXEntityListModel(java.lang.String entityId,
                         EntityConnectionProvider connectionProvider,
                         EntityTableConditionModel conditionModel)

Instantiates a new FXEntityListModel based on the given entityId

Parameters:

entityId - the entityId

connectionProvider - the connection provider

conditionModel - the EntityTableConditionModel to use

Throws:

java.lang.IllegalArgumentException - in case the condition model is based on a different entity

Method Detail

getDomain

public final Domain getDomain()

Specified by:

getDomain in interface EntityTableModel<FXEntityEditModel>

Returns:

the underlying domain model

setEditModel

public final void setEditModel(FXEntityEditModel 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<FXEntityEditModel>

Parameters:

editModel - the edit model to associate with this table model

See Also:

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

getEditModel

public final FXEntityEditModel getEditModel()

Returns the EntityEditModel associated with this table model

Specified by:

getEditModel in interface EntityTableModel<FXEntityEditModel>

Returns:

the edit model associated with this table model

See Also:

EntityTableModel.setEditModel(EntityEditModel)

setColumns

public final void setColumns(javafx.collections.ObservableList<? extends javafx.scene.control.TableColumn<Entity,?>> columns)

Sets the columns for this FXEntityListModel.

Parameters:

columns - the columns

Throws:

java.lang.IllegalStateException - if the columns have already been set

getTableColumn

public final EntityTableColumn getTableColumn(java.lang.String propertyId)

Returns the table column for property with the given id

Parameters:

propertyId - the propertyId

Returns:

the column

Throws:

java.lang.IllegalArgumentException - in case the column was not found

getConditionModel

public final EntityTableConditionModel getConditionModel()

Specified by:

getConditionModel in interface EntityTableModel<FXEntityEditModel>

Returns:

the EntityTableConditionModel instance used by 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<FXEntityEditModel>

Returns:

a State specifying whether this table model requires a query condition

setForeignKeyConditionValues

public final void setForeignKeyConditionValues(Property.ForeignKeyProperty foreignKeyProperty,
                                               java.util.Collection<Entity> entities)

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

Specified by:

setForeignKeyConditionValues in interface EntityTableModel<FXEntityEditModel>

Parameters:

foreignKeyProperty - the ID of the foreign key property

entities - the entities to use as condition values

deleteSelected

public final void deleteSelected()
                          throws DatabaseException

Deletes the selected entities

Specified by:

deleteSelected in interface EntityTableModel<FXEntityEditModel>

Throws:

DatabaseException - in case of a database exception

getRowCount

public final int getRowCount()

Specified by:

getRowCount in interface EntityTableModel<FXEntityEditModel>

Returns:

the number of visible rows in this table model

hasEditModel

public final boolean hasEditModel()

Specified by:

hasEditModel in interface EntityTableModel<FXEntityEditModel>

Returns:

true if this EntityTableModel contains a EntityEditModel

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<FXEntityEditModel>

Parameters:

foreignKeyEntityId - the entity ID of the foreign key values

foreignKeyValues - the foreign key entities

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<FXEntityEditModel>

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<FXEntityEditModel>

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<FXEntityEditModel>

Parameters:

keys - the keys of the entities to refresh

isQueryConfigurationAllowed

public final boolean isQueryConfigurationAllowed()

Specified by:

isQueryConfigurationAllowed in interface EntityTableModel<FXEntityEditModel>

Returns:

true if the underlying query should be configurable

setQueryConfigurationAllowed

public final FXEntityListModel setQueryConfigurationAllowed(boolean queryConfigurationAllowed)

Specifies whether or not the underlying query should be configurable

Specified by:

setQueryConfigurationAllowed in interface EntityTableModel<FXEntityEditModel>

Parameters:

queryConfigurationAllowed - the value

Returns:

this EntityTableModel instance

isDeleteAllowed

public final boolean isDeleteAllowed()

Specified by:

isDeleteAllowed in interface EntityTableModel<FXEntityEditModel>

Returns:

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

See Also:

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

isReadOnly

public final boolean isReadOnly()

Specified by:

isReadOnly in interface EntityTableModel<FXEntityEditModel>

Returns:

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

See Also:

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

isUpdateAllowed

public final boolean isUpdateAllowed()

Specified by:

isUpdateAllowed in interface EntityTableModel<FXEntityEditModel>

Returns:

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

See Also:

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

isBatchUpdateAllowed

public final boolean isBatchUpdateAllowed()

Specified by:

isBatchUpdateAllowed in interface EntityTableModel<FXEntityEditModel>

Returns:

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

setBatchUpdateAllowed

public final FXEntityListModel setBatchUpdateAllowed(boolean batchUpdateAllowed)

Specified by:

setBatchUpdateAllowed in interface EntityTableModel<FXEntityEditModel>

Parameters:

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

Returns:

this EntityTableModel instance

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<FXEntityEditModel>

Parameters:

propertyId - the ID of the property

Returns:

the ColumnSummaryModel for the given property ID

getPropertyBackgroundColor

public final javafx.scene.paint.Color getPropertyBackgroundColor(int row,
                                                                 Property property)

Specified by:

getPropertyBackgroundColor in interface EntityTableModel<FXEntityEditModel>

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.setBackgroundColorProvider(org.jminor.framework.domain.Entity.BackgroundColorProvider)

getPropertyColumnIndex

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

Specified by:

getPropertyColumnIndex in interface EntityTableModel<FXEntityEditModel>

Parameters:

propertyId - the propertyId

Returns:

the index of the column representing the given property

getStatusMessage

public final java.lang.String getStatusMessage()

Specified by:

getStatusMessage in interface EntityTableModel<FXEntityEditModel>

Returns:

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

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<FXEntityEditModel>

Returns:

the fetch count

setFetchCount

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

Parameters:

fetchCount - the fetch count

Returns:

this table model

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<FXEntityEditModel>

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)

isRemoveEntitiesOnDelete

public final boolean isRemoveEntitiesOnDelete()

Specified by:

isRemoveEntitiesOnDelete in interface EntityTableModel<FXEntityEditModel>

Returns:

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

setRemoveEntitiesOnDelete

public final FXEntityListModel setRemoveEntitiesOnDelete(boolean removeEntitiesOnDelete)

Specified by:

setRemoveEntitiesOnDelete in interface EntityTableModel<FXEntityEditModel>

Parameters:

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

Returns:

this EntityTableModel instance

getInsertAction

public final EntityTableModel.InsertAction getInsertAction()

Specified by:

getInsertAction in interface EntityTableModel<FXEntityEditModel>

Returns:

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

setInsertAction

public final FXEntityListModel setInsertAction(EntityTableModel.InsertAction insertAction)

Specified by:

setInsertAction in interface EntityTableModel<FXEntityEditModel>

Parameters:

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

Returns:

this EntityTableModel instance

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<FXEntityEditModel>

Parameters:

keys - the primary key values to use as condition

Returns:

the entities having the primary key values as in keys

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<FXEntityEditModel>

Parameters:

keys - the primary keys of the entities to select

getEntityByKey

public final Entity getEntityByKey(Entity.Key primaryKey)

Specified by:

getEntityByKey in interface EntityTableModel<FXEntityEditModel>

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

getSelectedEntitiesIterator

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

Returns an Iterator which iterates through the selected entities

Specified by:

getSelectedEntitiesIterator in interface EntityTableModel<FXEntityEditModel>

Returns:

the iterator used when generating reports

indexOf

public final int indexOf(Entity.Key primaryKey)

Specified by:

indexOf in interface EntityTableModel<FXEntityEditModel>

Parameters:

primaryKey - the primary key

Returns:

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

savePreferences

public final void savePreferences()

Saves any user preferences

Specified by:

savePreferences in interface EntityTableModel<FXEntityEditModel>

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<FXEntityEditModel>

Parameters:

propertyIds - the column identifiers

getTableDataAsDelimitedString

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

Specified by:

getTableDataAsDelimitedString in interface EntityTableModel<FXEntityEditModel>

Parameters:

delimiter - the delimiter

Returns:

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

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

Overrides:

performQuery in class ObservableEntityList

Returns:

entities selected from the database according the the query condition.

See Also:

getQueryConditionRequiredState(), EntityTableConditionModel.getCondition()

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:

Domain.getOrderBy(String)

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

bindSelectionModelEvents

protected final void bindSelectionModelEvents()

Binds model events to the selection model

Overrides:

bindSelectionModelEvents in class ObservableEntityList