Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityEditor

All Known Implementing Classes:

DefaultEntityEditor, SwingEntityEditor

public interface EntityEditor

Provides edit access to an underlying entity.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityEditor.ComponentModels	Provides models for editor components requiring database access.
static interface	EntityEditor.EditorEntity	Provides access to the entity instance being edited.
static interface	EntityEditor.EditorPersistence	Manages the EntityPersistence used by this editor
static interface	EntityEditor.EditorValue<T>	Provides edit access to an Attribute value in the underlying entity being edited.
static interface	EntityEditor.EditorValues	Provides access to the underlying values.
static interface	EntityEditor.Exists	Indicates whether the active entity exists in the database.
static interface	EntityEditor.Modified	Indicates whether the active entity is modified, that is, exists and has one or more modified attribute values.
static interface	EntityEditor.PersistEvents	Provides persistence event observers for the editor
static interface	EntityEditor.PersistTask<T>	Represents a task for persisting entities, inserting, updating or deleting, split up for use with a background thread.
static interface	EntityEditor.PersistTasks	Provides builders for async persist tasks.
static interface	EntityEditor.SearchModels	Manages the EntitySearchModels used by a EntityEditModel
static interface	EntityEditor.Settings	The editor settings.

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>	PUBLISH_PERSISTENCE_EVENTS	Specifies whether editors publish their insert, update and delete events to PersistenceEvents Value type: Boolean Default value: true

Method Summary

Modifier and Type	Method	Description
EntityConnectionProvider	connectionProvider()
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.
Entities	entities()
EntityEditor.EditorEntity	entity()
EntityDefinition	entityDefinition()
EntityEditor.PersistEvents	events()
EntityEditor.Exists	exists()
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.
EntityEditor.Modified	modified()	Returns an ObservableState indicating whether any values have been modified.
EntityEditor.EditorPersistence	persistence()
ObservableState	primaryKeyPresent()
EntityEditor.SearchModels	searchModels()
EntityEditor.Settings	settings()
EntityEditor.PersistTasks	tasks()
EntityEditor.PersistTasks	tasks(EntityConnection connection)
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.
ObservableState	valid()
void	validate()	Validates the current state of the entity
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.
Value<EntityValidator>	validator()	Controls the validator used by this editor.
<T> EntityEditor.EditorValue<T>	value(Attribute<T> attribute)	Returns the EntityEditor.EditorValue instance representing attribute in this EntityEditor.
EntityEditor.EditorValues	values()

Field Details

PUBLISH_PERSISTENCE_EVENTS

static final PropertyValue<Boolean> PUBLISH_PERSISTENCE_EVENTS

Specifies whether editors publish their insert, update and delete events to PersistenceEvents

• Value type: Boolean
• Default value: true

See Also:

• EntityEditor.Settings.publishPersistenceEvents()

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:

• EntityEditor.EditorValues.defaults()

Method Details

entities

Entities entities()

Returns:

the underlying domain entities

entityDefinition

EntityDefinition entityDefinition()

Returns:

the entity definition

connectionProvider

EntityConnectionProvider connectionProvider()

Returns:

the connection provider

settings

EntityEditor.Settings settings()

Returns:

the editor settings

events

EntityEditor.PersistEvents events()

Returns:

the EntityEditor.PersistEvents

entity

EntityEditor.EditorEntity entity()

Returns:

the EntityEditor.EditorEntity instance

exists

EntityEditor.Exists exists()

Returns:

an ObservableState indicating whether the entity exists in the database

See Also:

• EntityEditor.Exists.predicate()

modified

EntityEditor.Modified modified()

Returns an ObservableState indicating whether any values have been modified.

Note that only existing entities are modified, new, or non-existing entities are never modified.

Returns:

an ObservableState indicating the modified state of this editor entity

See Also:

• EntityEditor.Modified.additional()
• EntityEditor.Exists

primaryKeyPresent

ObservableState primaryKeyPresent()

Returns:

an ObservableState indicating whether the value of the entity primary key is present

valid

ObservableState valid()

Returns:

an ObservableState indicating the valid status of the underlying Entity.

See Also:

• validate(Attribute)
• EntityValidator.validate(Entity)

validator

Value<EntityValidator> validator()

Controls the validator used by this editor.

Returns:

the Value controlling the validator

See Also:

• validate(Entity)

validate

void validate()
       throws EntityValidationException

Validates the current state of the entity

Throws:

EntityValidationException - in case the entity is invalid

validate

void validate(Attribute<?> attribute)
       throws AttributeValidationException

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

Parameters:

attribute - the attribute the value is associated with

Throws:

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

validate

void validate(Collection<Entity> entities)
       throws EntityValidationException

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

Parameters:

entities - the entities to validate

Throws:

EntityValidationException - on finding the first invalid entity

See Also:

• EntityDefinition.validator()

validate

void validate(Entity entity)
       throws EntityValidationException

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

Parameters:

entity - the entity to validate

Throws:

EntityValidationException - in case the entity is invalid

NullPointerException - in case the entity is null

value

<T> EntityEditor.EditorValue<T> value(Attribute<T> attribute)

Returns the EntityEditor.EditorValue instance representing attribute in this EntityEditor.

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

the EntityEditor.EditorValue representing the given attribute

searchModels

EntityEditor.SearchModels searchModels()

Returns:

the EntityEditor.SearchModels instance

persistence

EntityEditor.EditorPersistence persistence()

Returns:

the EntityEditor.EditorPersistence used by this editor

values

EntityEditor.EditorValues values()

Returns:

the EntityEditor.EditorValues

tasks

EntityEditor.PersistTasks tasks()

Returns:

the EntityEditor.PersistTasks instance

tasks

EntityEditor.PersistTasks tasks(EntityConnection connection)

Parameters:

connection - the connection to use when persisting

Returns:

the EntityEditor.PersistTasks instance

insert

Entity insert()
       throws EntityValidationException

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

EntityValidationException - in case validation fails

IllegalStateException - in case inserting is not enabled

See Also:

• EntityEditor.PersistEvents.BeforePersist.insert()
• EntityEditor.PersistEvents.AfterPersist.insert()
• EntityEditor.Settings.insertEnabled()
• validate(Entity)

insert

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

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

EntityValidationException - in case validation fails

IllegalStateException - in case inserting is not enabled

See Also:

• EntityEditor.PersistEvents.BeforePersist.insert()
• EntityEditor.PersistEvents.AfterPersist.insert()
• EntityEditor.Settings.insertEnabled()
• validate(Entity)

update

Entity update()
       throws EntityValidationException

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

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

EntityValidationException - in case validation fails

IllegalStateException - in case updating is not enabled

UpdateEntityException - in case the active entity is not modified

See Also:

• EntityEditor.PersistEvents.BeforePersist.update()
• EntityEditor.PersistEvents.AfterPersist.update()
• EntityEditor.Settings.updateEnabled()
• validate(Entity)

update

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

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

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

EntityValidationException - in case validation fails

IllegalStateException - in case updating is not enabled

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

See Also:

• EntityEditor.PersistEvents.BeforePersist.update()
• EntityEditor.PersistEvents.AfterPersist.update()
• EntityEditor.Settings.updateEnabled()
• 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:

• EntityEditor.PersistEvents.BeforePersist.delete()
• EntityEditor.PersistEvents.AfterPersist.delete()
• EntityEditor.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:

• EntityEditor.PersistEvents.BeforePersist.delete()
• EntityEditor.PersistEvents.AfterPersist.delete()
• EntityEditor.Settings.deleteEnabled()