Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityEditModel.EntityEditor

All Superinterfaces:

Observable<Entity>, Observer<Entity>

Enclosing interface:

EntityEditModel

public static interface EntityEditModel.EntityEditor
extends Observable<Entity>

Provides edit access to the underlying entity.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityEditModel.EntityEditor.Exists	Indicates whether the active entity exists in the database.
static interface	EntityEditModel.EntityEditor.Modified	Indicates whether the active entity is modified, that is, exists and has one or more modified attribute values.

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
Observer<Entity>	changing()
void	clear()	Clears all values from the underlying entity, disregarding the EntityEditModel.EditorValue.persist() directive.
void	defaults()	Populates this edit model with default values for all non-persistent attributes.
EntityEditModel.EntityEditor.Exists	exists()
Entity	get()
EntityEditModel.EntityEditor.Modified	modified()	Returns an ObservableState indicating whether any values have been modified.
boolean	nullable(Attribute<?> attribute)
ObservableState	primaryKeyNull()
void	revert()	Reverts all attribute value changes.
void	set(@Nullable Entity entity)	Populates this editor with the values from the given entity or sets the default value for all attributes in case it is null.
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> EntityEditModel.EditorValue<T>	value(Attribute<T> attribute)	Returns the EntityEditModel.EditorValue instance representing attribute in this EntityEditModel.EntityEditor.
Observer<Attribute<?>>	valueChanged()	Returns an observer notified each time a value is changed, either via its associated EntityEditModel.EditorValue instance or when the entity is set via clear(), set(Entity) or defaults().

Methods inherited from interface is.codion.common.observer.Observable

addConsumer, addListener, addWeakConsumer, addWeakListener, getOrThrow, getOrThrow, is, isNot, isNull, isNullable, observer, optional, removeConsumer, removeListener, removeWeakConsumer, removeWeakListener

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

get

Entity get()

Specified by:

get in interface Observable<Entity>

Returns:

an immutable copy of the entity being edited

set

void set(@Nullable Entity entity)

Populates this editor with the values from the given entity or sets the default value for all attributes in case it is null.

Use clear() in order to clear the editor of all values.

Parameters:

entity - the entity to set, if null, then defaults are set

See Also:

• EntityEditModel.EditorValue.defaultValue()
• EntityEditModel.EditorValue.persist()
• AttributeDefinition.defaultValue()

clear

void clear()

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

defaults

void defaults()

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

See Also:

• EntityEditModel.EditorValue.defaultValue()
• EntityEditModel.EditorValue.persist()
• AttributeDefinition.defaultValue()

revert

void revert()

Reverts all attribute value changes.

exists

EntityEditModel.EntityEditor.Exists exists()

Returns:

an ObservableState indicating whether the entity exists in the database

See Also:

• EntityEditModel.EntityEditor.Exists.predicate()

modified

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

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

changing

Observer<Entity> changing()

Returns:

an observer notified each time the entity is about to be changed via set(Entity) or defaults()

See Also:

• set(Entity)
• defaults()

valueChanged

Observer<Attribute<?>> valueChanged()

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

Returns:

an observer notified each time a value is changed

primaryKeyNull

ObservableState primaryKeyNull()

Returns:

an ObservableState indicating whether the primary key of the entity is null

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> EntityEditModel.EditorValue<T> value(Attribute<T> attribute)

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

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

the EntityEditModel.EditorValue representing the given attribute