Module is.codion.framework.model

Package is.codion.framework.model

Class AbstractEntityTableModel<E extends EntityEditModel>

java.lang.Object

is.codion.framework.model.AbstractEntityTableModel<E>

Type Parameters:

E - the EntityEditModel type

All Implemented Interfaces:

FilterModel<Entity>, EntityTableModel<E>

Direct Known Subclasses:

SwingEntityTableModel

public abstract class AbstractEntityTableModel<E extends EntityEditModel>
extends Object
implements EntityTableModel<E>

An abstract EntityTableModel implementation

Nested Class Summary

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

EntityTableModel.OnInsert

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

FilterModel.AbstractRefresher<T>, FilterModel.FilteredItems<T>, FilterModel.Items<T>, FilterModel.Refresher<T>, FilterModel.Sorter<T>, FilterModel.VisibleItems<T>

Field Summary

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

HANDLE_EDIT_EVENTS, ON_INSERT, ORDER_QUERY_BY_SORT_ORDER

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

ASYNC_REFRESH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityTableModel(E editModel, FilterModel<Entity> filterModel)
protected	AbstractEntityTableModel(E editModel, FilterModel<Entity> filterModel, EntityQueryModel queryModel)

Method Summary

Modifier and Type	Method	Description
final EntityConnection	connection()	Do not cache or keep the connection returned by this method in a long living field, since it may become invalid and thereby unusable.
final EntityConnectionProvider	connectionProvider()
final Collection<Entity>	deleteSelected()	Deletes the selected entities
final State	editable()
final E	editModel()	Returns the EntityEditModel associated with this table model
final Entities	entities()
final EntityDefinition	entityDefinition()
final EntityType	entityType()
protected FilterModel<Entity>	filterModel()
final Value<EntityTableModel.OnInsert>	onInsert()
protected abstract void	onRowsUpdated(int fromIndex, int toIndex)	Notifies all listeners that the given rows have changed
protected abstract Optional<OrderBy>	orderByFromSortModel()
final State	orderQueryBySortOrder()	Specifies whether the current FilterModel.sorter() order is used as a basis for the EntityQueryModel order by clause.
final EntityQueryModel	queryModel()
final void	refresh(Collection<Entity.Key> keys)	Refreshes the entities with the given keys by re-selecting them from the underlying database.
final State	removeDeleted()
final void	replace(Collection<Entity> entities)	Replaces the given entities in this table model
final void	select(Collection<Entity.Key> keys)	Selects entities according to the primary keys in primaryKeys
final String	toString()
protected void	updated(ForeignKey foreignKey, Map<Entity.Key,Entity> entities)	Called when entities of the type referenced by the given foreign key are updated

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

selection

Methods inherited from interface is.codion.common.model.FilterModel

items, sorter

Constructor Details

AbstractEntityTableModel

protected AbstractEntityTableModel(E editModel,
 FilterModel<Entity> filterModel)

Parameters:

editModel - the edit model

filterModel - the filter model

AbstractEntityTableModel

protected AbstractEntityTableModel(E editModel,
 FilterModel<Entity> filterModel,
 EntityQueryModel queryModel)

Parameters:

editModel - the edit model

filterModel - the filter model

queryModel - the table query model

Throws:

IllegalArgumentException - in case the edit and query model entity types do not match

Method Details

entities

public final Entities entities()

Specified by:

entities in interface EntityTableModel<E extends EntityEditModel>

Returns:

the underlying domain entities

entityDefinition

public final EntityDefinition entityDefinition()

Specified by:

entityDefinition in interface EntityTableModel<E extends EntityEditModel>

Returns:

the definition of the underlying entity

toString

public final String toString()

Overrides:

toString in class Object

onInsert

public final Value<EntityTableModel.OnInsert> onInsert()

Specified by:

onInsert in interface EntityTableModel<E extends EntityEditModel>

Returns:

the Value controlling the action to perform when entities are inserted via the associated edit model

See Also:

• EntityTableModel.ON_INSERT

removeDeleted

public final State removeDeleted()

Specified by:

removeDeleted in interface EntityTableModel<E extends EntityEditModel>

Returns:

the State controlling whether 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<E extends EntityEditModel>

Returns:

the type of the entity this table model is based on

editModel

public final E editModel()

Description copied from interface: EntityTableModel

Returns the EntityEditModel associated with this table model

Specified by:

editModel in interface EntityTableModel<E extends EntityEditModel>

Returns:

the edit model associated with this table model

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityTableModel<E extends EntityEditModel>

Returns:

the connection provider used by this table model

connection

public final EntityConnection connection()

Description copied from interface: EntityTableModel

Do not cache or keep the connection returned by this method in a long living field, since it may become invalid and thereby unusable.

Specified by:

connection in interface EntityTableModel<E extends EntityEditModel>

Returns:

the connection used by this table model

orderQueryBySortOrder

public final State orderQueryBySortOrder()

Description copied from interface: EntityTableModel

Specifies whether the current FilterModel.sorter() order is used as a basis for the EntityQueryModel order by clause. Note that this only applies to column attributes.

Specified by:

orderQueryBySortOrder in interface EntityTableModel<E extends EntityEditModel>

Returns:

the State controlling whether the current sort order should be used as a basis for the query order by clause

queryModel

public final EntityQueryModel queryModel()

Specified by:

queryModel in interface EntityTableModel<E extends EntityEditModel>

Returns:

the underlying query model

editable

public final State editable()

Specified by:

editable in interface EntityTableModel<E extends EntityEditModel>

Returns:

the State controlling whether this table model is editable

replace

public final void replace(Collection<Entity> entities)

Description copied from interface: EntityTableModel

Replaces the given entities in this table model

Specified by:

replace in interface EntityTableModel<E extends EntityEditModel>

Parameters:

entities - the entities to replace

refresh

public final void refresh(Collection<Entity.Key> keys)

Description copied from interface: EntityTableModel

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

Specified by:

refresh in interface EntityTableModel<E extends EntityEditModel>

Parameters:

keys - the keys of the entities to refresh

select

public final void select(Collection<Entity.Key> keys)

Description copied from interface: EntityTableModel

Selects entities according to the primary keys in primaryKeys

Specified by:

select in interface EntityTableModel<E extends EntityEditModel>

Parameters:

keys - the primary keys of the entities to select

deleteSelected

public final Collection<Entity> deleteSelected()

Description copied from interface: EntityTableModel

Deletes the selected entities

Specified by:

deleteSelected in interface EntityTableModel<E extends EntityEditModel>

Returns:

the deleted entities

filterModel

protected FilterModel<Entity> filterModel()

Returns:

the underlying filter model

onRowsUpdated

protected abstract void onRowsUpdated(int fromIndex,
 int toIndex)

Notifies all listeners that the given rows have changed

Parameters:

fromIndex - the from index

toIndex - the to index

orderByFromSortModel

protected abstract Optional<OrderBy> orderByFromSortModel()

Returns:

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

updated

protected void updated(ForeignKey foreignKey,
 Map<Entity.Key,Entity> entities)

Called when entities of the type referenced by the given foreign key are updated

Parameters:

foreignKey - the foreign key

entities - the updated entities, mapped to their original primary key