Module is.codion.framework.model

Package is.codion.framework.model

Class DefaultEntityEditor<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.DefaultEntityEditor<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:

EntityEditor<M,E,T,R>

Direct Known Subclasses:

SwingEntityEditor

public class DefaultEntityEditor<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 EntityEditor<M,E,T,R>

A default EntityEditor implementation.

Nested Class Summary

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

EntityEditor.ComponentModels<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>>, EntityEditor.DeleteTaskBuilder, EntityEditor.EditorEntity, EntityEditor.EditorPersistence, EntityEditor.EditorValue<T>, EntityEditor.Exists, EntityEditor.InsertTaskBuilder, EntityEditor.Modified, EntityEditor.PersistTask, EntityEditor.PersistTasks, EntityEditor.SearchModels, EntityEditor.UpdateTaskBuilder

Field Summary

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

PERSIST_FOREIGN_KEYS

Constructor Summary

Constructors

Constructor	Description
DefaultEntityEditor(EntityType entityType, EntityConnectionProvider connectionProvider, EntityEditor.ComponentModels<M,E,T,R> componentModels)	Instantiates a new DefaultEntityEditor

Method Summary

Modifier and Type	Method	Description
final void	clear()	Clears all values from the underlying entity, disregarding the EntityEditor.EditorValue.persist() directive.
protected EntityEditor.ComponentModels<M,E,T,R>	componentModels()
final EntityConnectionProvider	connectionProvider()
final void	defaults()	Populates this editor with default values for all non-persistent attributes.
final Entities	entities()
final EntityEditor.EditorEntity	entity()
final EntityDefinition	entityDefinition()
final EntityEditor.Exists	exists()
final EntityEditor.Modified	modified()	Returns an ObservableState indicating whether any values have been modified.
final boolean	nullable(Attribute<?> attribute)
final EntityEditor.EditorPersistence	persistence()
final ObservableState	primaryKeyPresent()
final void	revert()	Reverts all attribute value changes.
final EntityEditor.SearchModels	searchModels()
final EntityEditor.PersistTasks	tasks()
final String	toString()
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 edit model.
final <T> EntityEditor.EditorValue<T>	value(Attribute<T> attribute)	Returns the EntityEditor.EditorValue instance representing attribute in this EntityEditor.
final Observer<Attribute<?>>	valueChanged()	Returns an observer notified each time a value is changed, either via its associated EntityEditor.EditorValue instance or when the entity is set via EntityEditor.clear(), EntityEditor.EditorEntity.set(Entity) or EntityEditor.defaults().

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<M,E,T,R> 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<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 EntityEditor<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 entity definition

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityEditor<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

entity

public final EntityEditor.EditorEntity entity()

Specified by:

entity in interface EntityEditor<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.EditorEntity instance

clear

public final void clear()

Description copied from interface: EntityEditor

Clears all values from the underlying entity, disregarding the EntityEditor.EditorValue.persist() directive.

Specified by:

clear in interface EntityEditor<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>>

defaults

public final void defaults()

Description copied from interface: EntityEditor

Populates this editor with default values for all non-persistent attributes.

Notifies that the entity is about to change via EntityEditor.EditorEntity.changing()

Specified by:

defaults in interface EntityEditor<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>>

See Also:

• EntityEditor.EditorValue.defaultValue()
• EntityEditor.EditorValue.persist()
• ValueAttributeDefinition.defaultValue()
• EntityEditor.EditorEntity.changing()

revert

public final void revert()

Description copied from interface: EntityEditor

Reverts all attribute value changes.

Specified by:

revert in interface EntityEditor<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>>

exists

public final EntityEditor.Exists exists()

Specified by:

exists in interface EntityEditor<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:

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<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:

an ObservableState indicating the modified state of this editor entity

See Also:

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

valueChanged

public final Observer<Attribute<?>> valueChanged()

Description copied from interface: EntityEditor

Returns an observer notified each time a value is changed, either via its associated EntityEditor.EditorValue instance or when the entity is set via EntityEditor.clear(), EntityEditor.EditorEntity.set(Entity) or EntityEditor.defaults().

Specified by:

valueChanged in interface EntityEditor<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:

an observer notified each time a value is changed

nullable

public final boolean nullable(Attribute<?> attribute)

Specified by:

nullable in interface EntityEditor<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:

attribute - the attribute

Returns:

true if this value is allowed to be null according to the validator

See Also:

• EntityEditor.validator()

primaryKeyPresent

public final ObservableState primaryKeyPresent()

Specified by:

primaryKeyPresent in interface EntityEditor<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:

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 edit model.

Specified by:

validator in interface EntityEditor<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 Value controlling the validator

See Also:

• EntityEditor.validate(Entity)

valid

public final ObservableState valid()

Specified by:

valid in interface EntityEditor<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:

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

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<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:

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 edit model is based on, their respective validators are used.

Specified by:

validate in interface EntityEditor<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 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 edit model is based on, their respective validators are used.

Specified by:

validate in interface EntityEditor<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:

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

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<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.SearchModels instance

persistence

public final EntityEditor.EditorPersistence persistence()

Specified by:

persistence in interface EntityEditor<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.EditorPersistence used by this editor

tasks

public final EntityEditor.PersistTasks tasks()

Specified by:

tasks in interface EntityEditor<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.PersistTasks instance

toString

public final String toString()

Overrides:

toString in class Object

componentModels

protected EntityEditor.ComponentModels<M,E,T,R> componentModels()

Returns:

the EntityEditor.ComponentModels instance