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.EditorValue<T>	Provides edit access to an Attribute value in the underlying entity being edited.
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.SearchModels	Manages the EntitySearchModels used by a EntityEditModel

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

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears all values from the underlying entity, disregarding the EntityEditor.EditorValue.persist() directive.
EntityConnectionProvider	connectionProvider()
void	defaults()	Populates this editor with default values for all non-persistent attributes.
Entities	entities()
EntityEditor.EditorEntity	entity()
EntityDefinition	entityDefinition()
EntityEditor.Exists	exists()
EntityEditor.Modified	modified()	Returns an ObservableState indicating whether any values have been modified.
boolean	nullable(Attribute<?> attribute)
ObservableState	primaryKeyPresent()
void	revert()	Reverts all attribute value changes.
EntityEditor.SearchModels	searchModels()
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 edit model.
<T> EntityEditor.EditorValue<T>	value(Attribute<T> attribute)	Returns the EntityEditor.EditorValue instance representing attribute in this EntityEditor.
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 clear(), EntityEditor.EditorEntity.set(Entity) or defaults().

Field Details

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:

• 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

entity

EntityEditor.EditorEntity entity()

Returns:

the EntityEditor.EditorEntity instance

clear

void clear()

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

defaults

void defaults()

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

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

See Also:

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

revert

void revert()

Reverts all attribute value changes.

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 entity

See Also:

• EntityEditor.Modified.predicate()
• EntityEditor.Exists

valueChanged

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 clear(), EntityEditor.EditorEntity.set(Entity) or defaults().

Returns:

an observer notified each time a value is changed

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

Returns:

the Value controlling the validator

See Also:

• validate(Entity)

validate

void validate()

Validates the current state of the entity

Throws:

ValidationException - in case the entity is invalid

validate

void validate(Attribute<?> attribute)

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

Parameters:

attribute - the attribute the value is associated with

Throws:

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

validate

void validate(Collection<Entity> entities)

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.

Parameters:

entities - the entities to validate

Throws:

ValidationException - on finding the first invalid entity

See Also:

• EntityDefinition.validator()

validate

void validate(Entity entity)

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.

Parameters:

entity - the entity to validate

Throws:

ValidationException - in case the entity is invalid

NullPointerException - in case the entity is null

nullable

boolean nullable(Attribute<?> attribute)

Parameters:

attribute - the attribute

Returns:

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

See Also:

• validator()

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