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.Delete, EntityEditModel.EditableEntity, EntityEditModel.EditableValue<T>, EntityEditModel.Insert, EntityEditModel.Update

Field Summary

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

PERSIST_FOREIGN_KEYS, POST_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<?>	afterInsertUpdateOrDelete()
final Observer<Map<Entity.Key,Entity>>	afterUpdate()
final Observer<Collection<Entity>>	beforeDelete()
final Observer<Collection<Entity>>	beforeInsert()
final Observer<Map<Entity.Key,Entity>>	beforeUpdate()
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 EntityEditModel.Delete	createDelete()	Creates a new EntityEditModel.Delete instance for deleting the active entity.
final 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.
final EntityEditModel.Insert	createInsert()	Creates a new EntityEditModel.Insert instance for inserting the active entity.
final EntityEditModel.Insert	createInsert(Collection<Entity> entities)	Creates a new EntityEditModel.Insert instance for inserting the given entities.
final EntityEditModel.Update	createUpdate()	Creates a new EntityEditModel.Update instance for updating the active entity.
final EntityEditModel.Update	createUpdate(Collection<Entity> entities)	Creates a new EntityEditModel.Update instance for updating the given entities.
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
final State	deleteEnabled()	Disabling delete causes an exception being thrown when deleting.
final Entities	entities()
final EntityEditModel.EditableEntity	entity()	Returns a EntityEditModel.EditableEntity wrapping the entity being edited.
final EntityDefinition	entityDefinition()
final EntityType	entityType()
final EntitySearchModel	foreignKeySearchModel(ForeignKey foreignKey)
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
final State	insertEnabled()	Disabling insert causes an exception being thrown when inserting.
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.Key,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(Map<Entity.Key,Entity> entitiesToUpdate)	Notifies that update is about to be performed
final State	postEditEvents()
final 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.
final 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.
protected void	replaceForeignKey(ForeignKey foreignKey, Collection<Entity> values)	For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from values, useful when attribute values have been changed in the referenced entity that must be reflected in the edit model.
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
final State	updateEnabled()	Disabling update causes an exception being thrown when updating.
final State	updateMultipleEnabled()	Disabling updating multiple entities causes an exception being thrown when trying to update multiple entities at a time.
final void	validate(Attribute<?> attribute)	Validates the value associated with the given attribute, using the underlying validator.
final void	validate(Entity entity)	Validates the given entity, using the underlying validator.
final void	validate(Collection<Entity> entities)	Validates the given entities, using the underlying validator.
final <T> EntityEditModel.EditableValue<T>	value(Attribute<T> attribute)	Returns the EntityEditModel.EditableValue instance representing attribute in this edit model.

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

add, remove

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

postEditEvents

public final State postEditEvents()

Specified by:

postEditEvents in interface EntityEditModel

Returns:

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

See Also:

• EntityEditModel.POST_EDIT_EVENTS

readOnly

public final State readOnly()

Description copied from interface: EntityEditModel

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 EntityEditModel.insertEnabled(), EntityEditModel.updateEnabled() and EntityEditModel.deleteEnabled() to configure the enabled state of those specific actions.

Specified by:

readOnly in interface EntityEditModel

Returns:

the State controlling whether this model is read only

insertEnabled

public final State insertEnabled()

Description copied from interface: EntityEditModel

Disabling insert causes an exception being thrown when inserting.

Specified by:

insertEnabled in interface EntityEditModel

Returns:

the State controlling whether inserting is enabled via this edit model

updateEnabled

public final State updateEnabled()

Description copied from interface: EntityEditModel

Disabling update causes an exception being thrown when updating.

Specified by:

updateEnabled in interface EntityEditModel

Returns:

the State controlling whether updating is enabled via this edit model

updateMultipleEnabled

public final State updateMultipleEnabled()

Description copied from interface: EntityEditModel

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

Specified by:

updateMultipleEnabled in interface EntityEditModel

Returns:

the State controlling whether updating multiple entities is enabled

deleteEnabled

public final State deleteEnabled()

Description copied from interface: EntityEditModel

Disabling delete causes an exception being thrown when deleting.

Specified by:

deleteEnabled in interface EntityEditModel

Returns:

the State controlling whether deleting is enabled via this edit model

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

replace

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

Description copied from interface: EntityEditModel

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.

Specified by:

replace in interface EntityEditModel

Parameters:

foreignKey - the foreign key

entities - the foreign key entities

entity

public final EntityEditModel.EditableEntity entity()

Description copied from interface: EntityEditModel

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 EntityEditModel.value(Attribute).

Specified by:

entity in interface EntityEditModel

Returns:

the EntityEditModel.EditableEntity wrapping the Entity instance being edited

See Also:

• Entity.immutable()

value

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

Description copied from interface: EntityEditModel

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

Specified by:

value in interface EntityEditModel

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

the EntityEditModel.EditableValue representing the given attribute

validate

public final void validate(Attribute<?> attribute)
                    throws ValidationException

Description copied from interface: EntityEditModel

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

Specified by:

validate in interface EntityEditModel

Parameters:

attribute - the attribute the value is associated with

Throws:

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

validate

public final void validate(Collection<Entity> entities)
                    throws ValidationException

Description copied from interface: EntityEditModel

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.

Specified by:

validate in interface EntityEditModel

Parameters:

entities - the entities to validate

Throws:

ValidationException - on finding the first invalid entity

See Also:

• EntityDefinition.validator()

validate

public final void validate(Entity entity)
                    throws ValidationException

Description copied from interface: EntityEditModel

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.

Specified by:

validate in interface EntityEditModel

Parameters:

entity - the entity to validate

Throws:

ValidationException - in case the entity is invalid

insert

public final Entity insert()
                    throws DatabaseException,
ValidationException

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

Throws:

DatabaseException - in case of a database exception

ValidationException - in case validation fails

See Also:

• EntityValidator.validate(Entity)

insert

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

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

Throws:

DatabaseException - in case of a database exception

ValidationException - in case validation fails

See Also:

• EntityEditModel.beforeInsert()
• EntityEditModel.afterInsert()
• EntityValidator.validate(Entity)

update

public final Entity update()
                    throws DatabaseException,
ValidationException

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

Throws:

DatabaseException - in case of a database exception

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

UpdateException - in case the active entity is not modified

ValidationException - in case validation fails

See Also:

• EntityValidator.validate(Entity)

update

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

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

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

See Also:

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

delete

public final Entity delete()
                    throws DatabaseException

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

Throws:

DatabaseException - in case of a database exception

See Also:

• EntityEditModel.beforeDelete()
• EntityEditModel.afterDelete()

delete

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

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

Throws:

DatabaseException - in case of a database exception

See Also:

• EntityEditModel.beforeDelete()
• EntityEditModel.afterDelete()

createInsert

public final EntityEditModel.Insert createInsert()
                                          throws ValidationException

Description copied from interface: EntityEditModel

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

Specified by:

createInsert in interface EntityEditModel

Returns:

a new EntityEditModel.Insert instance

Throws:

ValidationException - in case validation fails

createInsert

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

Description copied from interface: EntityEditModel

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

Specified by:

createInsert in interface EntityEditModel

Parameters:

entities - the entities to insert

Returns:

a new EntityEditModel.Insert instance

Throws:

ValidationException - in case validation fails

createUpdate

public final EntityEditModel.Update createUpdate()
                                          throws ValidationException

Description copied from interface: EntityEditModel

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

Specified by:

createUpdate in interface EntityEditModel

Returns:

a new EntityEditModel.Update instance

Throws:

ValidationException - in case validation fails

createUpdate

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

Description copied from interface: EntityEditModel

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

Specified by:

createUpdate in interface EntityEditModel

Parameters:

entities - the entities to update

Returns:

a new EntityEditModel.Update instance

Throws:

ValidationException - in case validation fails

createDelete

public final EntityEditModel.Delete createDelete()

Description copied from interface: EntityEditModel

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

Specified by:

createDelete in interface EntityEditModel

Returns:

a new EntityEditModel.Delete instance

createDelete

public final EntityEditModel.Delete createDelete(Collection<Entity> entities)

Description copied from interface: EntityEditModel

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

Specified by:

createDelete in interface EntityEditModel

Parameters:

entities - the entities to delete

Returns:

a new EntityEditModel.Delete instance

createForeignKeySearchModel

public EntitySearchModel createForeignKeySearchModel(ForeignKey foreignKey)

Description copied from interface: EntityEditModel

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

Specified by:

createForeignKeySearchModel in interface EntityEditModel

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,

foreignKeySearchModel

public final EntitySearchModel foreignKeySearchModel(ForeignKey foreignKey)

Specified by:

foreignKeySearchModel in interface EntityEditModel

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.

beforeInsert

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

Specified by:

beforeInsert in interface EntityEditModel

Returns:

an observer notified before an insert is performed

afterInsert

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

Specified by:

afterInsert in interface EntityEditModel

Returns:

an observer notified after an insert is performed

beforeUpdate

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

Specified by:

beforeUpdate in interface EntityEditModel

Returns:

an observer notified before an update is performed

afterUpdate

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

Specified by:

afterUpdate in interface EntityEditModel

Returns:

an observer notified after an update is performed

beforeDelete

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

Specified by:

beforeDelete in interface EntityEditModel

Returns:

an observer notified before a delete is performed

afterDelete

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

Specified by:

afterDelete in interface EntityEditModel

Returns:

an observer notified after a delete is performed

afterInsertUpdateOrDelete

public final Observer<?> 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

insert

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

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)
                             throws DatabaseException

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)
               throws DatabaseException

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

replaceForeignKey

protected void replaceForeignKey(ForeignKey foreignKey,
 Collection<Entity> values)

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

Parameters:

foreignKey - the foreign key attribute

values - the foreign key entities

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(Map<Entity.Key,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.Key,Entity> updatedEntities)

Notifies that update has been performed

Parameters:

updatedEntities - the updated entities

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