Module is.codion.framework.model

Package is.codion.framework.model

Class DefaultEntityEditor<R extends EntityEditor<R>>

java.lang.Object

is.codion.framework.model.DefaultEntityEditor<R>

Type Parameters:

R - the editor type

All Implemented Interfaces:

EntityEditor<R>

Direct Known Subclasses:

SwingEntityEditor

public class DefaultEntityEditor<R extends EntityEditor<R>>
extends Object
implements EntityEditor<R>

A default EntityEditor implementation.

Nested Class Summary

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

EntityEditor.ComponentModels, EntityEditor.DetailEditors<R extends EntityEditor<R>>, EntityEditor.EditorEntity, EntityEditor.EditorPersistence, EntityEditor.EditorTasks, EntityEditor.EditorValue<T>, EntityEditor.EditorValues, EntityEditor.Exists, EntityEditor.Modified, EntityEditor.PersistEvents, EntityEditor.PersistTask<T>, EntityEditor.Present, EntityEditor.RefreshTask, EntityEditor.SearchModels, EntityEditor.Settings

Field Summary

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

PERSIST_FOREIGN_KEYS, PUBLISH_PERSISTENCE_EVENTS

Constructor Summary

Constructors

Constructor	Description
DefaultEntityEditor(EntityType entityType, EntityConnectionProvider connectionProvider, EntityEditor.ComponentModels componentModels)	Instantiates a new DefaultEntityEditor

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEntityEditor

public DefaultEntityEditor(EntityType entityType,
 EntityConnectionProvider connectionProvider,
 EntityEditor.ComponentModels componentModels)

Instantiates a new DefaultEntityEditor

Parameters:

entityType - the entity type

connectionProvider - the connection provider

componentModels - the editor component models

Method Details

entities

public final Entities entities()

Specified by:

entities in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the underlying domain entities

entityDefinition

public final EntityDefinition entityDefinition()

Specified by:

entityDefinition in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the entity definition

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the connection provider

settings

public final EntityEditor.Settings settings()

Specified by:

settings in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the editor settings

events

public final EntityEditor.PersistEvents events()

Specified by:

events in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the EntityEditor.PersistEvents

entity

public final EntityEditor.EditorEntity entity()

Specified by:

entity in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the EntityEditor.EditorEntity instance

values

public final EntityEditor.EditorValues values()

Specified by:

values in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the EntityEditor.EditorValues

exists

public final EntityEditor.Exists exists()

Specified by:

exists in interface EntityEditor<R extends EntityEditor<R>>

Returns:

an ObservableState indicating whether the entity exists in the database

See Also:

• EntityEditor.Exists.predicate()

modified

public final EntityEditor.Modified modified()

Description copied from interface: EntityEditor

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.

Specified by:

modified in interface EntityEditor<R extends EntityEditor<R>>

Returns:

an ObservableState indicating the modified state of this editor entity

See Also:

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

present

public final EntityEditor.Present present()

Specified by:

present in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the EntityEditor.Present instance

primaryKeyPresent

public final ObservableState primaryKeyPresent()

Specified by:

primaryKeyPresent in interface EntityEditor<R extends EntityEditor<R>>

Returns:

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

validator

public final Value<EntityValidator> validator()

Description copied from interface: EntityEditor

Controls the validator used by this editor.

Specified by:

validator in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the Value controlling the validator

See Also:

• EntityEditor.validate(Entity)

valid

public final ObservableState valid()

Specified by:

valid in interface EntityEditor<R extends EntityEditor<R>>

Returns:

an ObservableState indicating the valid status of the underlying Entity.

See Also:

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

validate

public final void validate()
                    throws EntityValidationException

Description copied from interface: EntityEditor

Validates the current state of the entity

Specified by:

validate in interface EntityEditor<R extends EntityEditor<R>>

Throws:

EntityValidationException - in case the entity is invalid

validate

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

Description copied from interface: EntityEditor

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

Specified by:

validate in interface EntityEditor<R extends EntityEditor<R>>

Parameters:

attribute - the attribute the value is associated with

Throws:

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

validate

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

Description copied from interface: EntityEditor

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.

Specified by:

validate in interface EntityEditor<R extends EntityEditor<R>>

Parameters:

entities - the entities to validate

Throws:

EntityValidationException - on finding the first invalid entity

See Also:

• EntityDefinition.validator()

validate

public final void validate(Entity entity)
                    throws EntityValidationException

Description copied from interface: EntityEditor

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.

Specified by:

validate in interface EntityEditor<R extends EntityEditor<R>>

Parameters:

entity - the entity to validate

Throws:

EntityValidationException - in case the entity is invalid

value

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

Description copied from interface: EntityEditor

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

Specified by:

value in interface EntityEditor<R extends EntityEditor<R>>

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

the EntityEditor.EditorValue representing the given attribute

searchModels

public final EntityEditor.SearchModels searchModels()

Specified by:

searchModels in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the EntityEditor.SearchModels instance

detail

public final EntityEditor.DetailEditors<R> detail()

Specified by:

detail in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the EntityEditor.DetailEditors instance

persistence

public final EntityEditor.EditorPersistence persistence()

Specified by:

persistence in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the EntityEditor.EditorPersistence used by this editor

tasks

public final EntityEditor.EditorTasks tasks()

Specified by:

tasks in interface EntityEditor<R extends EntityEditor<R>>

Returns:

the EntityEditor.EditorTasks instance

tasks

public final EntityEditor.EditorTasks tasks(EntityConnection connection)

Specified by:

tasks in interface EntityEditor<R extends EntityEditor<R>>

Parameters:

connection - the connection to use when persisting

Returns:

the EntityEditor.EditorTasks instance

insert

public final Entity insert()
                    throws EntityValidationException

Description copied from interface: EntityEditor

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 EntityEditor<R extends EntityEditor<R>>

Returns:

the inserted entity

Throws:

EntityValidationException - in case validation fails

See Also:

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

insert

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

Description copied from interface: EntityEditor

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 EntityEditor<R extends EntityEditor<R>>

Parameters:

entities - the entities to insert

Returns:

a list containing the inserted entities

Throws:

EntityValidationException - in case validation fails

See Also:

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

update

public final Entity update()
                    throws EntityValidationException

Description copied from interface: EntityEditor

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 EntityEditor<R extends EntityEditor<R>>

Returns:

the updated entity

Throws:

EntityValidationException - in case validation fails

See Also:

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

update

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

Description copied from interface: EntityEditor

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 EntityEditor<R extends EntityEditor<R>>

Parameters:

entities - the entities to update

Returns:

the updated entities

Throws:

EntityValidationException - in case validation fails

See Also:

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

delete

public final Entity delete()

Description copied from interface: EntityEditor

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 EntityEditor<R extends EntityEditor<R>>

Returns:

the deleted entity

See Also:

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

delete

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

Description copied from interface: EntityEditor

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 EntityEditor<R extends EntityEditor<R>>

Parameters:

entities - the entities to delete

Returns:

the deleted entities

See Also:

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

toString

public final String toString()

Overrides:

toString in class Object

componentModels

protected EntityEditor.ComponentModels componentModels()

Returns:

the EntityEditor.ComponentModels instance