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 Entity instances. The underlying attribute values are available via value(Attribute).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityEditModel.Delete	Represents a task for deleting entities.
static interface	EntityEditModel.EditableEntity	Provides access to the active entity being edited.
static interface	EntityEditModel.EditableValue<T>	Provides access the an Attribute value in the entity being edited.
static interface	EntityEditModel.Insert	Represents a task for inserting entities, split up for use with a background thread.
static interface	EntityEditModel.Update	Represents a task for updating entities.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	PERSIST_FOREIGN_KEYS	Specifies whether foreign key values should persist by default when defaults are set Value type: Boolean Default value: true
static final PropertyValue<Boolean>	POST_EDIT_EVENTS	Specifies whether edit models post their insert, update and delete events to EntityEditEvents Value type: Boolean Default value: true

Method Summary

Modifier and Type	Method	Description
void	add(ForeignKey foreignKey, Collection<Entity> entities)	Adds the given entities to all foreign key models based on that entity type
Observer<Collection<Entity>>	afterDelete()
Observer<Collection<Entity>>	afterInsert()
Observer<?>	afterInsertUpdateOrDelete()
Observer<Map<Entity.Key,Entity>>	afterUpdate()
Observer<Collection<Entity>>	beforeDelete()
Observer<Collection<Entity>>	beforeInsert()
Observer<Map<Entity.Key,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()
EntityEditModel.Delete	createDelete()	Creates a new EntityEditModel.Delete instance for deleting the active entity.
EntityEditModel.Delete	createDelete(Collection<Entity> entities)	Creates a new EntityEditModel.Delete instance for deleting the given entities.
EntitySearchModel	createForeignKeySearchModel(ForeignKey foreignKey)	Creates a EntitySearchModel for looking up entities referenced by the given foreign key, using the search attributes defined for that entity type.
EntityEditModel.Insert	createInsert()	Creates a new EntityEditModel.Insert instance for inserting the active entity.
EntityEditModel.Insert	createInsert(Collection<Entity> entities)	Creates a new EntityEditModel.Insert instance for inserting the given entities.
EntityEditModel.Update	createUpdate()	Creates a new EntityEditModel.Update instance for updating the active entity.
EntityEditModel.Update	createUpdate(Collection<Entity> entities)	Creates a new EntityEditModel.Update instance for updating the given entities.
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.
State	deleteEnabled()	Disabling delete causes an exception being thrown when deleting.
Entities	entities()
EntityEditModel.EditableEntity	entity()	Returns a EntityEditModel.EditableEntity wrapping the entity being edited.
EntityDefinition	entityDefinition()
EntityType	entityType()
EntitySearchModel	foreignKeySearchModel(ForeignKey foreignKey)
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.
State	insertEnabled()	Disabling insert causes an exception being thrown when inserting.
State	postEditEvents()
State	readOnly()	Making this edit model read-only prevents any changes from being persisted to the database, trying to insert, update or delete will cause an exception being thrown, it does not prevent editing.
void	remove(ForeignKey foreignKey, Collection<Entity> entities)	Removes the given entities from all foreign key models based on that entity type and clears any foreign key values referencing them.
void	replace(ForeignKey foreignKey, Collection<Entity> entities)	For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from entities, useful when attribute values have been changed in the referenced entity that must be reflected in the edit model.
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.
State	updateEnabled()	Disabling update causes an exception being thrown when updating.
State	updateMultipleEnabled()	Disabling updating multiple entities causes an exception being thrown when trying to update multiple entities at a time.
void	validate(Attribute<?> attribute)	Validates the value associated with the given attribute, using the underlying validator.
void	validate(Entity entity)	Validates the given entity, using the underlying validator.
void	validate(Collection<Entity> entities)	Validates the given entities, using the underlying validator.
<T> EntityEditModel.EditableValue<T>	value(Attribute<T> attribute)	Returns the EntityEditModel.EditableValue instance representing attribute in this edit model.

Field Details

PERSIST_FOREIGN_KEYS

static final PropertyValue<Boolean> PERSIST_FOREIGN_KEYS

Specifies whether foreign key values should persist by default when defaults are set

• Value type: Boolean
• Default value: true

See Also:

• EntityEditModel.EditableEntity.defaults()

POST_EDIT_EVENTS

static final PropertyValue<Boolean> POST_EDIT_EVENTS

Specifies whether edit models post their insert, update and delete events to EntityEditEvents

• Value type: Boolean
• Default value: true

See Also:

• postEditEvents()
• EntityTableModel.HANDLE_EDIT_EVENTS

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

entity

EntityEditModel.EditableEntity entity()

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

Returns:

the EntityEditModel.EditableEntity wrapping the Entity instance being edited

See Also:

• Entity.immutable()

value

<T> EntityEditModel.EditableValue<T> value(Attribute<T> attribute)

Returns the EntityEditModel.EditableValue instance representing attribute in this edit model.

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

the EntityEditModel.EditableValue representing the given attribute

entities

Entities entities()

Returns:

the underlying domain entities

entityDefinition

EntityDefinition entityDefinition()

Returns:

the definition of the underlying entity

readOnly

State readOnly()

Making this edit model read-only prevents any changes from being persisted to the database, trying to insert, update or delete will cause an exception being thrown, it does not prevent editing. Use insertEnabled(), updateEnabled() and deleteEnabled() to configure the enabled state of those specific actions.

Returns:

the State controlling whether this model is read only

insertEnabled

State insertEnabled()

Disabling insert causes an exception being thrown when inserting.

Returns:

the State controlling whether inserting is enabled via this edit model

updateEnabled

State updateEnabled()

Disabling update causes an exception being thrown when updating.

Returns:

the State controlling whether updating is enabled via this edit model

updateMultipleEnabled

State updateMultipleEnabled()

Disabling updating multiple entities causes an exception being thrown when trying to update multiple entities at a time.

Returns:

the State controlling whether updating multiple entities is enabled

deleteEnabled

State deleteEnabled()

Disabling delete causes an exception being thrown when deleting.

Returns:

the State controlling whether deleting is enabled via this edit model

createForeignKeySearchModel

EntitySearchModel createForeignKeySearchModel(ForeignKey foreignKey)

Creates a EntitySearchModel for looking up entities 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 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

foreignKeySearchModel

EntitySearchModel foreignKeySearchModel(ForeignKey foreignKey)

Parameters:

foreignKey - the foreign key for which to retrieve the EntitySearchModel

Returns:

the EntitySearchModel associated with the foreignKey, if no search model has been initialized for the given foreign key, a new one is created, associated with the foreign key and returned.

postEditEvents

State postEditEvents()

Returns:

a state controlling whether this edit model posts insert, update and delete events on the EntityEditEvents event bus.

See Also:

• POST_EDIT_EVENTS

insert

Entity insert()
       throws DatabaseException,
ValidationException

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:

• EntityValidator.validate(Entity)

insert

Collection<Entity> insert(Collection<Entity> entities)
                   throws DatabaseException,
ValidationException

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()
• EntityValidator.validate(Entity)

update

Entity update()
       throws DatabaseException,
ValidationException

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:

• EntityValidator.validate(Entity)

update

Collection<Entity> update(Collection<Entity> entities)
                   throws DatabaseException,
ValidationException

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

See Also:

• beforeUpdate()
• afterUpdate()
• EntityValidator.validate(Entity)

delete

Entity delete()
       throws DatabaseException

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

delete

Collection<Entity> delete(Collection<Entity> entities)
                   throws DatabaseException

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

createInsert

EntityEditModel.Insert createInsert()
                             throws ValidationException

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

Returns:

a new EntityEditModel.Insert instance

Throws:

ValidationException - in case validation fails

createInsert

EntityEditModel.Insert createInsert(Collection<Entity> entities)
                             throws ValidationException

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

Parameters:

entities - the entities to insert

Returns:

a new EntityEditModel.Insert instance

Throws:

ValidationException - in case validation fails

createUpdate

EntityEditModel.Update createUpdate()
                             throws ValidationException

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

Returns:

a new EntityEditModel.Update instance

Throws:

IllegalArgumentException - in case the active entity is unmodified

ValidationException - in case validation fails

createUpdate

EntityEditModel.Update createUpdate(Collection<Entity> entities)
                             throws ValidationException

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

Parameters:

entities - the entities to update

Returns:

a new EntityEditModel.Update instance

Throws:

IllegalArgumentException - in case any of the given entities are unmodified

ValidationException - in case validation fails

createDelete

EntityEditModel.Delete createDelete()

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

Returns:

a new EntityEditModel.Delete instance

createDelete

EntityEditModel.Delete createDelete(Collection<Entity> entities)

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

Parameters:

entities - the entities to delete

Returns:

a new EntityEditModel.Delete instance

add

void add(ForeignKey foreignKey,
 Collection<Entity> entities)

Adds the given entities to all foreign key models based on that entity type

Parameters:

foreignKey - the foreign key

entities - the values

remove

void remove(ForeignKey foreignKey,
 Collection<Entity> entities)

Removes the given entities from all foreign key models based on that entity type and clears any foreign key values referencing them.

Parameters:

foreignKey - the foreign key

entities - the values

replace

void replace(ForeignKey foreignKey,
 Collection<Entity> entities)

For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from entities, useful when attribute values have been changed in the referenced entity that must be reflected in the edit model.

Parameters:

foreignKey - the foreign key

entities - the foreign key entities

validate

void validate(Attribute<?> attribute)
       throws ValidationException

Validates the value associated with the given attribute, using the underlying validator.

Parameters:

attribute - the attribute the value is associated with

Throws:

ValidationException - if the given value is not valid for the given attribute

validate

void validate(Collection<Entity> entities)
       throws ValidationException

Validates the given entities, using the underlying validator. For entities of a type other than this edit model is based on, their respective validators are used.

Parameters:

entities - the entities to validate

Throws:

ValidationException - on finding the first invalid entity

See Also:

• EntityDefinition.validator()

validate

void validate(Entity entity)
       throws ValidationException

Validates the given entity, using the underlying validator. For entities of a type other than this edit model is based on, their respective validators are used.

Parameters:

entity - the entity to validate

Throws:

ValidationException - in case the entity is invalid

NullPointerException - in case the entity is null

beforeInsert

Observer<Collection<Entity>> beforeInsert()

Returns:

an observer notified before an insert is performed

afterInsert

Observer<Collection<Entity>> afterInsert()

Returns:

an observer notified after an insert is performed

beforeUpdate

Observer<Map<Entity.Key,Entity>> beforeUpdate()

Returns:

an observer notified before an update is performed

afterUpdate

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

Returns:

an observer notified after an update is performed

beforeDelete

Observer<Collection<Entity>> beforeDelete()

Returns:

an observer notified before a delete is performed

afterDelete

Observer<Collection<Entity>> afterDelete()

Returns:

an observer notified after a delete is performed

afterInsertUpdateOrDelete

Observer<?> afterInsertUpdateOrDelete()

Returns:

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