Module is.codion.framework.model

Package is.codion.framework.model

Class DefaultEntityEditModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

java.lang.Object

is.codion.framework.model.DefaultEntityEditModel<M,E,T,R>

Type Parameters:

M - the EntityModel type

E - the EntityEditModel type

T - the EntityTableModel type

R - the EntityEditor type

All Implemented Interfaces:

EntityEditModel<M,E,T,R>

Direct Known Subclasses:

SwingEntityEditModel

public class DefaultEntityEditModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>
extends Object
implements EntityEditModel<M,E,T,R>

A default EntityEditModel implementation

Nested Class Summary

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

EntityEditModel.PersistEvents, EntityEditModel.PersistTasks, EntityEditModel.Settings

Field Summary

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

PUBLISH_PERSISTENCE_EVENTS

Constructor Summary

Constructors

Constructor	Description
DefaultEntityEditModel(R editor)	Instantiates a new DefaultEntityEditModel based on the given editor

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 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.
final R	editor()	Returns a EntityEditor wrapping the entity being edited.
final Entities	entities()
final EntityDefinition	entityDefinition()
final EntityType	entityType()
final EntityEditModel.PersistEvents	events()
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.
final EntityEditModel.Settings	settings()
final EntityEditModel.PersistTasks	tasks()
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.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEntityEditModel

public DefaultEntityEditModel(R editor)

Instantiates a new DefaultEntityEditModel based on the given editor

Parameters:

editor - the editor

Method Details

entities

public final Entities entities()

Specified by:

entities in interface EntityEditModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Returns:

the underlying domain entities

entityDefinition

public final EntityDefinition entityDefinition()

Specified by:

entityDefinition in interface EntityEditModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

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<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Returns:

the edit model settings

entityType

public final EntityType entityType()

Specified by:

entityType in interface EntityEditModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Returns:

the type of the entity this edit model is based on

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityEditModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

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<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Returns:

the connection used by this edit model

editor

public final R editor()

Description copied from interface: EntityEditModel

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

Specified by:

editor in interface EntityEditModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Returns:

the EntityEditor wrapping the Entity instance being edited

See Also:

• Entity.immutable()

tasks

public final EntityEditModel.PersistTasks tasks()

Specified by:

tasks in interface EntityEditModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Returns:

the EntityEditModel.PersistTasks

events

public final EntityEditModel.PersistEvents events()

Specified by:

events in interface EntityEditModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Returns:

the EntityEditModel.PersistEvents

insert

public final Entity insert()
                    throws EntityValidationException

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<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Returns:

the inserted entity

Throws:

EntityValidationException - in case validation fails

See Also:

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

insert

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

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<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Parameters:

entities - the entities to insert

Returns:

a list containing the inserted entities

Throws:

EntityValidationException - in case validation fails

See Also:

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

update

public final Entity update()
                    throws EntityValidationException

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<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Returns:

the updated entity

Throws:

EntityValidationException - in case validation fails

See Also:

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

update

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

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<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Parameters:

entities - the entities to update

Returns:

the updated entities

Throws:

EntityValidationException - in case validation fails

See Also:

• EntityEditModel.PersistEvents.beforeUpdate()
• EntityEditModel.PersistEvents.afterUpdate()
• EntityEditModel.Settings.updateEnabled()
• 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<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Returns:

the deleted entity

See Also:

• EntityEditModel.PersistEvents.beforeDelete()
• EntityEditModel.PersistEvents.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<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Parameters:

entities - the entities to delete

Returns:

the deleted entities

See Also:

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