Module is.codion.framework.model

Package is.codion.framework.model

Class AbstractEntityEditModel

java.lang.Object

is.codion.framework.model.AbstractEntityEditModel

All Implemented Interfaces:

EntityEditModel

Direct Known Subclasses:

SwingEntityEditModel

public abstract class AbstractEntityEditModel
extends Object
implements EntityEditModel

A default EntityEditModel implementation

Nested Class Summary

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

EntityEditModel.EditEvents, EntityEditModel.EditorValue<T>, EntityEditModel.EditTask, EntityEditModel.EntityEditor, EntityEditModel.Settings

Field Summary

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

EDIT_EVENTS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityEditModel(EntityType entityType, EntityConnectionProvider connectionProvider)	Instantiates a new AbstractEntityEditModel based on the given entity type.

Method Summary

Modifier and Type	Method	Description
final Observer<Collection<Entity>>	afterDelete()
final Observer<Collection<Entity>>	afterInsert()
final Observer<Collection<Entity>>	afterInsertUpdateOrDelete()
final Observer<Map<Entity,Entity>>	afterUpdate()
<T> void	applyEdit(Collection<Entity> entities, Attribute<T> attribute, @Nullable T value)	Applies the given value to the given entities.
final Observer<Collection<Entity>>	beforeDelete()
final Observer<Collection<Entity>>	beforeInsert()
final Observer<Collection<Entity>>	beforeUpdate()
protected void	configure(ForeignKey foreignKey, EntitySearchModel entitySearchModel)	Called when a EntitySearchModel is created in searchModel(ForeignKey).
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()
EntitySearchModel	createSearchModel(ForeignKey foreignKey)	Creates a EntitySearchModel for looking up entities of the type referenced by the given foreign key, using the search attributes defined for that entity type.
final Entity	delete()	Note: This method must be called on the UI thread in case a panel has been based on this model.
final Collection<Entity>	delete(Collection<Entity> entities)	Note: This method must be called on the UI thread in case a panel has been based on this model.
protected void	delete(Collection<Entity> entities, EntityConnection connection)	Deletes the given entities from the database using the given connection
protected void	deleted(ForeignKey foreignKey, Collection<Entity> entities)	Called when entities of the type referenced by the given foreign key are deleted.
final EntityEditModel.EditTask	deleteTask()	Creates a new EntityEditModel.EditTask instance for deleting the active entity.
final EntityEditModel.EditTask	deleteTask(Collection<Entity> entities)	Creates a new EntityEditModel.EditTask instance for deleting the given entities.
final EntityEditModel.EntityEditor	editor()	Returns a EntityEditModel.EntityEditor wrapping the entity being edited.
final Entities	entities()
final EntityDefinition	entityDefinition()
final EntityType	entityType()
final Entity	insert()	Note: This method must be called on the UI thread in case a panel has been based on this model.
final Collection<Entity>	insert(Collection<Entity> entities)	Note: This method must be called on the UI thread in case a panel has been based on this model.
protected Collection<Entity>	insert(Collection<Entity> entities, EntityConnection connection)	Inserts the given entities into the database using the given connection
protected void	inserted(ForeignKey foreignKey, Collection<Entity> entities)	Called when entities of the type referenced by the given foreign key are inserted.
final EntityEditModel.EditTask	insertTask()	Creates a new EntityEditModel.EditTask instance for inserting the active entity.
final EntityEditModel.EditTask	insertTask(Collection<Entity> entities)	Creates a new EntityEditModel.EditTask instance for inserting the given entities.
protected final void	notifyAfterDelete(Collection<Entity> deletedEntities)	Notifies that delete has been performed
protected final void	notifyAfterInsert(Collection<Entity> insertedEntities)	Notifies that insert has been performed
protected final void	notifyAfterUpdate(Map<Entity,Entity> updatedEntities)	Notifies that update has been performed
protected final void	notifyBeforeDelete(Collection<Entity> entitiesToDelete)	Notifies that delete is about to be performed
protected final void	notifyBeforeInsert(Collection<Entity> entitiesToInsert)	Notifies that insert is about to be performed
protected final void	notifyBeforeUpdate(Collection<Entity> entitiesToUpdate)	Notifies that update is about to be performed
final void	refresh()	Refreshes the active Entity from the database, discarding all changes.
final EntitySearchModel	searchModel(ForeignKey foreignKey)	Returns the EntitySearchModel associated with the given foreign key.
final EntityEditModel.Settings	settings()
final String	toString()
final Entity	update()	Note: This method must be called on the UI thread in case a panel has been based on this model.
final Collection<Entity>	update(Collection<Entity> entities)	Note: This method must be called on the UI thread in case a panel has been based on this model.
protected Collection<Entity>	update(Collection<Entity> entities, EntityConnection connection)	Updates the given entities in the database using the given connection
protected void	updated(ForeignKey foreignKey, Map<Entity.Key,Entity> entities)	Called when entities of the type referenced by the given foreign key have been updated.
final EntityEditModel.EditTask	updateTask()	Creates a new EntityEditModel.EditTask instance for updating the active entity.
final EntityEditModel.EditTask	updateTask(Collection<Entity> entities)	Creates a new EntityEditModel.EditTask instance for updating the given entities.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractEntityEditModel

protected AbstractEntityEditModel(EntityType entityType,
 EntityConnectionProvider connectionProvider)

Instantiates a new AbstractEntityEditModel based on the given entity type.

Parameters:

entityType - the type of the entity to base this AbstractEntityEditModel on

connectionProvider - the EntityConnectionProvider instance

Method Details

entities

public final Entities entities()

Specified by:

entities in interface EntityEditModel

Returns:

the underlying domain entities

entityDefinition

public final EntityDefinition entityDefinition()

Specified by:

entityDefinition in interface EntityEditModel

Returns:

the definition of the underlying entity

toString

public final String toString()

Overrides:

toString in class Object

settings

public final EntityEditModel.Settings settings()

Specified by:

settings in interface EntityEditModel

Returns:

the edit model settings

entityType

public final EntityType entityType()

Specified by:

entityType in interface EntityEditModel

Returns:

the type of the entity this edit model is based on

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityEditModel

Returns:

the connection provider used by this edit model

connection

public final EntityConnection connection()

Description copied from interface: EntityEditModel

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 EntityEditModel

Returns:

the connection used by this edit model

editor

public final EntityEditModel.EntityEditor editor()

Description copied from interface: EntityEditModel

Returns a EntityEditModel.EntityEditor wrapping the entity being edited. EntityEditModel.EntityEditor.get() returns an immutable copy of the Entity instance being edited, while EntityEditModel.EntityEditor.set(Entity) copies the values from the given Entity into the underlying Entity. Note that value changes must go through the EntityEditModel.EditorValue accessible via EntityEditModel.EntityEditor.value(Attribute).

Specified by:

editor in interface EntityEditModel

Returns:

the EntityEditModel.EntityEditor wrapping the Entity instance being edited

See Also:

• Entity.immutable()

refresh

public final void refresh()

Description copied from interface: EntityEditModel

Refreshes the active Entity from the database, discarding all changes. If the active Entity is new then calling this method has no effect.

Specified by:

refresh in interface EntityEditModel

insert

public final Entity insert()

Description copied from interface: EntityEditModel

Note: This method must be called on the UI thread in case a panel has been based on this model. Performs an insert on the active entity, sets the primary key values of the active entity according to the primary key of the inserted entity

Specified by:

insert in interface EntityEditModel

Returns:

the inserted entity

See Also:

• EntityEditModel.beforeInsert()
• EntityEditModel.afterInsert()
• EntityEditModel.Settings.insertEnabled()
• EntityEditModel.EntityEditor.validate(Entity)

insert

public final Collection<Entity> insert(Collection<Entity> entities)

Description copied from interface: EntityEditModel

Note: This method must be called on the UI thread in case a panel has been based on this model. Performs an insert on the given entities.

Specified by:

insert in interface EntityEditModel

Parameters:

entities - the entities to insert

Returns:

a list containing the inserted entities

See Also:

• EntityEditModel.beforeInsert()
• EntityEditModel.afterInsert()
• EntityEditModel.Settings.insertEnabled()
• EntityEditModel.EntityEditor.validate(Entity)

update

public final Entity update()

Description copied from interface: EntityEditModel

Note: This method must be called on the UI thread in case a panel has been based on this model. Performs an update on the active entity

Specified by:

update in interface EntityEditModel

Returns:

the updated entity

See Also:

• EntityEditModel.beforeUpdate()
• EntityEditModel.afterUpdate()
• EntityEditModel.Settings.updateEnabled()
• EntityEditModel.EntityEditor.validate(Entity)

update

public final Collection<Entity> update(Collection<Entity> entities)

Description copied from interface: EntityEditModel

Note: This method must be called on the UI thread in case a panel has been based on this model. Updates the given entities.

Specified by:

update in interface EntityEditModel

Parameters:

entities - the entities to update

Returns:

the updated entities

See Also:

• EntityEditModel.beforeUpdate()
• EntityEditModel.afterUpdate()
• EntityEditModel.Settings.updateEnabled()
• EntityEditModel.EntityEditor.validate(Entity)

delete

public final Entity delete()

Description copied from interface: EntityEditModel

Note: This method must be called on the UI thread in case a panel has been based on this model.

Specified by:

delete in interface EntityEditModel

Returns:

the deleted entity

See Also:

• EntityEditModel.beforeDelete()
• EntityEditModel.afterDelete()
• EntityEditModel.Settings.deleteEnabled()

delete

public final Collection<Entity> delete(Collection<Entity> entities)

Description copied from interface: EntityEditModel

Note: This method must be called on the UI thread in case a panel has been based on this model.

Specified by:

delete in interface EntityEditModel

Parameters:

entities - the entities to delete

Returns:

the deleted entities

See Also:

• EntityEditModel.beforeDelete()
• EntityEditModel.afterDelete()
• EntityEditModel.Settings.deleteEnabled()

insertTask

public final EntityEditModel.EditTask insertTask()

Description copied from interface: EntityEditModel

Creates a new EntityEditModel.EditTask instance for inserting the active entity.

Specified by:

insertTask in interface EntityEditModel

Returns:

a new EntityEditModel.EditTask instance

See Also:

• EntityEditModel.Settings.insertEnabled()

insertTask

public final EntityEditModel.EditTask insertTask(Collection<Entity> entities)

Description copied from interface: EntityEditModel

Creates a new EntityEditModel.EditTask instance for inserting the given entities.

Specified by:

insertTask in interface EntityEditModel

Parameters:

entities - the entities to insert

Returns:

a new EntityEditModel.EditTask instance

See Also:

• EntityEditModel.Settings.insertEnabled()

updateTask

public final EntityEditModel.EditTask updateTask()

Description copied from interface: EntityEditModel

Creates a new EntityEditModel.EditTask instance for updating the active entity.

Specified by:

updateTask in interface EntityEditModel

Returns:

a new EntityEditModel.EditTask instance

See Also:

• EntityEditModel.Settings.updateEnabled()

updateTask

public final EntityEditModel.EditTask updateTask(Collection<Entity> entities)

Description copied from interface: EntityEditModel

Creates a new EntityEditModel.EditTask instance for updating the given entities.

Specified by:

updateTask in interface EntityEditModel

Parameters:

entities - the entities to update

Returns:

a new EntityEditModel.EditTask instance

See Also:

• EntityEditModel.Settings.updateEnabled()

deleteTask

public final EntityEditModel.EditTask deleteTask()

Description copied from interface: EntityEditModel

Creates a new EntityEditModel.EditTask instance for deleting the active entity.

Specified by:

deleteTask in interface EntityEditModel

Returns:

a new EntityEditModel.EditTask instance

See Also:

• EntityEditModel.Settings.deleteEnabled()

deleteTask

public final EntityEditModel.EditTask deleteTask(Collection<Entity> entities)

Description copied from interface: EntityEditModel

Creates a new EntityEditModel.EditTask instance for deleting the given entities.

Specified by:

deleteTask in interface EntityEditModel

Parameters:

entities - the entities to delete

Returns:

a new EntityEditModel.EditTask instance

See Also:

• EntityEditModel.Settings.deleteEnabled()

createSearchModel

public EntitySearchModel createSearchModel(ForeignKey foreignKey)

Description copied from interface: EntityEditModel

Creates a EntitySearchModel for looking up entities of the type referenced by the given foreign key, using the search attributes defined for that entity type.

Specified by:

createSearchModel in interface EntityEditModel

Parameters:

foreignKey - the foreign key for which to create a EntitySearchModel

Returns:

a new EntitySearchModel for looking up entities of the type referenced by the given foreign key attribute,

searchModel

public final EntitySearchModel searchModel(ForeignKey foreignKey)

Description copied from interface: EntityEditModel

Returns the EntitySearchModel associated with the given foreign key. If no such search model exists, one is created by calling EntityEditModel.createSearchModel(ForeignKey).

This method always returns the same EntitySearchModel instance, once one has been created.

Specified by:

searchModel in interface EntityEditModel

Parameters:

foreignKey - the foreign key for which to retrieve the EntitySearchModel

Returns:

the EntitySearchModel associated with the given foreign key

beforeInsert

public final Observer<Collection<Entity>> beforeInsert()

Specified by:

beforeInsert in interface EntityEditModel

Returns:

an observer notified before insert is performed, after validation

afterInsert

public final Observer<Collection<Entity>> afterInsert()

Specified by:

afterInsert in interface EntityEditModel

Returns:

an observer notified after insert is performed

beforeUpdate

public final Observer<Collection<Entity>> beforeUpdate()

Specified by:

beforeUpdate in interface EntityEditModel

Returns:

an observer notified before update is performed, after validation

afterUpdate

public final Observer<Map<Entity,Entity>> afterUpdate()

Specified by:

afterUpdate in interface EntityEditModel

Returns:

an observer notified after update is performed, with the updated entities, mapped to their state before the update

beforeDelete

public final Observer<Collection<Entity>> beforeDelete()

Specified by:

beforeDelete in interface EntityEditModel

Returns:

an observer notified before delete is performed

afterDelete

public final Observer<Collection<Entity>> afterDelete()

Specified by:

afterDelete in interface EntityEditModel

Returns:

an observer notified after delete is performed

afterInsertUpdateOrDelete

public final Observer<Collection<Entity>> afterInsertUpdateOrDelete()

Specified by:

afterInsertUpdateOrDelete in interface EntityEditModel

Returns:

an observer notified each time one or more entities have been inserted, updated or deleted via this model

applyEdit

public <T> void applyEdit(Collection<Entity> entities,
 Attribute<T> attribute,
 @Nullable T value)

Description copied from interface: EntityEditModel

Applies the given value to the given entities. This method can be used by components providing edit functionality, such as editable tables, in order to apply the edited value, ensuring that any associated values are updated as well.

Note that that value may be null.

By default, this sets the given attribute value in the entities via Entity.set(Attribute, Object).

Override to customize, f.ex. when associated values must be changed accordingly.

  @Override
 	public <T> void applyEdit(Collection<Entity> entities, Attribute<T> attribute, T value) {
 	  super.applyEdit(entities, attribute, value);
 	  if (attribute.equals(Invoice.CUSTOMER_FK)) {
 	    Entity customer = (Entity) value;
 	    // Set the billing address when the customer is changed
 	    entities.forEach(entity ->
            entity.set(Invoice.BILLINGADDRESS, customer == null ? null : customer.get(Customer.ADDRESS)));
 	  }
 	}

Specified by:

applyEdit in interface EntityEditModel

Parameters:

entities - the entities to apply the value to

attribute - the attribute being edited

value - the value to apply

See Also:

• Entity.set(Attribute, Object)

configure

protected void configure(ForeignKey foreignKey,
 EntitySearchModel entitySearchModel)

Called when a EntitySearchModel is created in searchModel(ForeignKey).

Parameters:

foreignKey - the foreign key

entitySearchModel - the search model

insert

protected Collection<Entity> insert(Collection<Entity> entities,
 EntityConnection connection)

Inserts the given entities into the database using the given connection

Parameters:

entities - the entities to insert

connection - the connection to use

Returns:

the inserted entities

Throws:

DatabaseException - in case of a database exception

update

protected Collection<Entity> update(Collection<Entity> entities,
 EntityConnection connection)

Updates the given entities in the database using the given connection

Parameters:

entities - the entities to update

connection - the connection to use

Returns:

the updated entities

Throws:

DatabaseException - in case of a database exception

delete

protected void delete(Collection<Entity> entities,
 EntityConnection connection)

Deletes the given entities from the database using the given connection

Parameters:

entities - the entities to delete

connection - the connection to use

Throws:

DatabaseException - in case of a database exception

inserted

protected void inserted(ForeignKey foreignKey,
 Collection<Entity> entities)

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

Parameters:

foreignKey - the foreign key

entities - the inserted entities

See Also:

• EntityEditModel.EditEvents.inserted()

updated

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

Called when entities of the type referenced by the given foreign key have been updated.

For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding value from entities

Parameters:

foreignKey - the foreign key

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

See Also:

• EntityEditModel.EditEvents.updated()

deleted

protected void deleted(ForeignKey foreignKey,
 Collection<Entity> entities)

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

Clears any foreign key values referencing the deleted entities.

Parameters:

foreignKey - the foreign key

entities - the deleted entities

See Also:

• EntityEditModel.EditEvents.deleted()

notifyBeforeInsert

protected final void notifyBeforeInsert(Collection<Entity> entitiesToInsert)

Notifies that insert is about to be performed

Parameters:

entitiesToInsert - the entities about to be inserted

See Also:

• beforeInsert()

notifyAfterInsert

protected final void notifyAfterInsert(Collection<Entity> insertedEntities)

Notifies that insert has been performed

Parameters:

insertedEntities - the inserted entities

See Also:

• afterInsert()

notifyBeforeUpdate

protected final void notifyBeforeUpdate(Collection<Entity> entitiesToUpdate)

Notifies that update is about to be performed

Parameters:

entitiesToUpdate - the entities about to be updated

See Also:

• beforeUpdate()

notifyAfterUpdate

protected final void notifyAfterUpdate(Map<Entity,Entity> updatedEntities)

Notifies that update has been performed

Parameters:

updatedEntities - a map containing the updated entities, mapped to their state before the update

See Also:

• afterUpdate()

notifyBeforeDelete

protected final void notifyBeforeDelete(Collection<Entity> entitiesToDelete)

Notifies that delete is about to be performed

Parameters:

entitiesToDelete - the entities about to be deleted

See Also:

• beforeDelete()

notifyAfterDelete

protected final void notifyAfterDelete(Collection<Entity> deletedEntities)

Notifies that delete has been performed

Parameters:

deletedEntities - the deleted entities

See Also:

• afterDelete()