Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityEditModel

All Known Implementing Classes:

AbstractEntityEditModel, SwingEntityEditModel

public interface EntityEditModel

Specifies a class for editing an Entity instance. The underlying attribute values are available via EntityEditModel.EntityEditor.value(Attribute).

See Also:

• editor()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityEditModel.EditEvents
static interface	EntityEditModel.EditorValue<T>	Provides edit access to an Attribute value in the underlying entity being edited.
static interface	EntityEditModel.EditTask	Represents a task for inserting, updating or deleting entities, split up for use with a background thread.
static interface	EntityEditModel.EntityEditor	Provides edit access to the underlying entity.
static interface	EntityEditModel.Settings	The edit model settings.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	EDIT_EVENTS	Specifies whether edit models post their insert, update and delete events to EntityEditModel.EditEvents Value type: Boolean Default value: true

Method Summary

Modifier and Type	Method	Description
Observer<Collection<Entity>>	afterDelete()
Observer<Collection<Entity>>	afterInsert()
Observer<Collection<Entity>>	afterInsertUpdateOrDelete()
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.
Observer<Collection<Entity>>	beforeDelete()
Observer<Collection<Entity>>	beforeInsert()
Observer<Collection<Entity>>	beforeUpdate()
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.
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.
Entity	delete()	Note: This method must be called on the UI thread in case a panel has been based on this model.
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.
EntityEditModel.EditTask	deleteTask()	Creates a new EntityEditModel.EditTask instance for deleting the active entity.
EntityEditModel.EditTask	deleteTask(Collection<Entity> entities)	Creates a new EntityEditModel.EditTask instance for deleting the given entities.
EntityEditModel.EntityEditor	editor()	Returns a EntityEditModel.EntityEditor wrapping the entity being edited.
Entities	entities()
EntityDefinition	entityDefinition()
EntityType	entityType()
static EntityEditModel.EditEvents	events(EntityType entityType)
Entity	insert()	Note: This method must be called on the UI thread in case a panel has been based on this model.
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.
EntityEditModel.EditTask	insertTask()	Creates a new EntityEditModel.EditTask instance for inserting the active entity.
EntityEditModel.EditTask	insertTask(Collection<Entity> entities)	Creates a new EntityEditModel.EditTask instance for inserting the given entities.
void	refresh()	Refreshes the active Entity from the database, discarding all changes.
EntitySearchModel	searchModel(ForeignKey foreignKey)	Returns the EntitySearchModel associated with the given foreign key.
EntityEditModel.Settings	settings()
Entity	update()	Note: This method must be called on the UI thread in case a panel has been based on this model.
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.
EntityEditModel.EditTask	updateTask()	Creates a new EntityEditModel.EditTask instance for updating the active entity.
EntityEditModel.EditTask	updateTask(Collection<Entity> entities)	Creates a new EntityEditModel.EditTask instance for updating the given entities.

Field Details

EDIT_EVENTS

static final PropertyValue<Boolean> EDIT_EVENTS

Specifies whether edit models post their insert, update and delete events to EntityEditModel.EditEvents

• Value type: Boolean
• Default value: true

See Also:

• EntityEditModel.Settings.editEvents()

Method Details

entityType

EntityType entityType()

Returns:

the type of the entity this edit model is based on

connectionProvider

EntityConnectionProvider connectionProvider()

Returns:

the connection provider used by this edit model

connection

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.

Returns:

the connection used by this edit model

editor

EntityEditModel.EntityEditor editor()

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

Returns:

the EntityEditModel.EntityEditor wrapping the Entity instance being edited

See Also:

• Entity.immutable()

entities

Entities entities()

Returns:

the underlying domain entities

entityDefinition

EntityDefinition entityDefinition()

Returns:

the definition of the underlying entity

settings

EntityEditModel.Settings settings()

Returns:

the edit model settings

createSearchModel

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.

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,

Throws:

IllegalStateException - in case no searchable attributes can be found for the entity type referenced by the given foreign key

searchModel

EntitySearchModel searchModel(ForeignKey foreignKey)

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

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

Parameters:

foreignKey - the foreign key for which to retrieve the EntitySearchModel

Returns:

the EntitySearchModel associated with the given foreign key

refresh

void refresh()

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

insert

Entity insert()

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

Returns:

the inserted entity

Throws:

DatabaseException - in case of a database exception

ValidationException - in case validation fails

IllegalStateException - in case inserting is not enabled

See Also:

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

insert

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. Performs an insert on the given entities.

Parameters:

entities - the entities to insert

Returns:

a list containing the inserted entities

Throws:

DatabaseException - in case of a database exception

ValidationException - in case validation fails

IllegalStateException - in case inserting is not enabled

See Also:

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

update

Entity update()

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

Returns:

the updated entity

Throws:

DatabaseException - in case of a database exception

RecordModifiedException - in case the entity has been modified since it was loaded

ValidationException - in case validation fails

IllegalStateException - in case updating is not enabled

UpdateException - in case the active entity is not modified

See Also:

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

update

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. Updates the given entities.

Parameters:

entities - the entities to update

Returns:

the updated entities

Throws:

DatabaseException - in case of a database exception

RecordModifiedException - in case an entity has been modified since it was loaded

ValidationException - in case validation fails

IllegalStateException - in case updating is not enabled

UpdateException - in case any of the given entities are not modified

See Also:

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

delete

Entity delete()

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

Returns:

the deleted entity

Throws:

DatabaseException - in case of a database exception

IllegalStateException - in case deleting is not enabled

See Also:

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

delete

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.

Parameters:

entities - the entities to delete

Returns:

the deleted entities

Throws:

DatabaseException - in case of a database exception

IllegalStateException - in case deleting is not enabled

See Also:

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

insertTask

EntityEditModel.EditTask insertTask()

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

Returns:

a new EntityEditModel.EditTask instance

Throws:

IllegalStateException - in inserting is not enabled

ValidationException - in case validation fails

See Also:

• EntityEditModel.Settings.insertEnabled()

insertTask

EntityEditModel.EditTask insertTask(Collection<Entity> entities)

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

Parameters:

entities - the entities to insert

Returns:

a new EntityEditModel.EditTask instance

Throws:

IllegalStateException - in inserting is not enabled

ValidationException - in case validation fails

See Also:

• EntityEditModel.Settings.insertEnabled()

updateTask

EntityEditModel.EditTask updateTask()

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

Returns:

a new EntityEditModel.EditTask instance

Throws:

IllegalStateException - in case the active entity is unmodified or if updating is not enabled

ValidationException - in case validation fails

See Also:

• EntityEditModel.Settings.updateEnabled()

updateTask

EntityEditModel.EditTask updateTask(Collection<Entity> entities)

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

Parameters:

entities - the entities to update

Returns:

a new EntityEditModel.EditTask instance

Throws:

IllegalStateException - in case any of the given entities are unmodified or if updating is not enabled

ValidationException - in case validation fails

See Also:

• EntityEditModel.Settings.updateEnabled()

deleteTask

EntityEditModel.EditTask deleteTask()

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

Returns:

a new EntityEditModel.EditTask instance

Throws:

IllegalStateException - in deleting is not enabled

See Also:

• EntityEditModel.Settings.deleteEnabled()

deleteTask

EntityEditModel.EditTask deleteTask(Collection<Entity> entities)

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

Parameters:

entities - the entities to delete

Returns:

a new EntityEditModel.EditTask instance

Throws:

IllegalStateException - in deleting is not enabled

See Also:

• EntityEditModel.Settings.deleteEnabled()

beforeInsert

Observer<Collection<Entity>> beforeInsert()

Returns:

an observer notified before insert is performed, after validation

afterInsert

Observer<Collection<Entity>> afterInsert()

Returns:

an observer notified after insert is performed

beforeUpdate

Observer<Collection<Entity>> beforeUpdate()

Returns:

an observer notified before update is performed, after validation

afterUpdate

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

Returns:

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

beforeDelete

Observer<Collection<Entity>> beforeDelete()

Returns:

an observer notified before delete is performed

afterDelete

Observer<Collection<Entity>> afterDelete()

Returns:

an observer notified after delete is performed

afterInsertUpdateOrDelete

Observer<Collection<Entity>> afterInsertUpdateOrDelete()

Returns:

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

applyEdit

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

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.

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.get(Customer.ADDRESS)));
 	  }
 	}

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)

events

static EntityEditModel.EditEvents events(EntityType entityType)

Parameters:

entityType - the entity type

Returns:

the central EntityEditModel.EditEvents instance for the given entity type