Module is.codion.framework.model

Package is.codion.framework.model

Class DefaultEntityEditor

java.lang.Object

is.codion.framework.model.DefaultEntityEditor

All Implemented Interfaces:

Observable<Entity>, Observer<Entity>, EntityEditor

Direct Known Subclasses:

SwingEntityEditor

public class DefaultEntityEditor
extends Object
implements EntityEditor

A default EntityEditor implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultEntityEditor.DefaultComponentModels	A default EntityEditor.ComponentModels implementation providing foreign key based EntitySearchModel.

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

EntityEditor.ComponentModels, EntityEditor.EditorValue<T>, EntityEditor.Exists, EntityEditor.Modified, EntityEditor.SearchModels

Nested classes/interfaces inherited from interface is.codion.common.reactive.observer.Observer

Observer.Builder<T,B extends Observer.Builder<T,B>>

Field Summary

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

PERSIST_FOREIGN_KEYS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Observer<Entity>	changing()	Throwing a CancelException from a listener will cancel the change.
final void	clear()	Clears all values from the underlying entity, disregarding the EntityEditor.EditorValue.persist() directive.
final EntityConnectionProvider	connectionProvider()
final void	defaults()	Populates this edit model with default values for all non-persistent attributes.
final Entities	entities()
final EntityDefinition	entityDefinition()
final EntityEditor.Exists	exists()
final Entity	get()
final EntityEditor.Modified	modified()	Returns an ObservableState indicating whether any values have been modified.
final boolean	nullable(Attribute<?> attribute)
final Observer<Entity>	observer()	Returns the underlying Observer to which listener operations are delegated.
final ObservableState	primaryKeyPresent()
final void	refresh()	Refreshes the active Entity from the database, discarding all changes.
final void	replace(Entity entity)	Replaces the entity without notifying that it is changing.
final void	revert()	Reverts all attribute value changes.
final EntityEditor.SearchModels	searchModels()
final 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.
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.set(Entity) or EntityEditor.defaults().

Methods inherited from class java.lang.Object

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

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

getOrThrow, getOrThrow, is, isNot, isNull, isNullable, optional

Methods inherited from interface is.codion.common.reactive.observer.Observer

addConsumer, addListener, addWeakConsumer, addWeakListener, removeConsumer, removeListener, removeWeakConsumer, removeWeakListener, when, when

Constructor Details

DefaultEntityEditor

public DefaultEntityEditor(EntityType entityType,
 EntityConnectionProvider connectionProvider)

Instantiates a new DefaultEntityEditor

Parameters:

entityType - the entity type

connectionProvider - the connection provider

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 models

Method Details

entities

public final Entities entities()

Specified by:

entities in interface EntityEditor

Returns:

the underlying domain entities

entityDefinition

public final EntityDefinition entityDefinition()

Specified by:

entityDefinition in interface EntityEditor

Returns:

the entity definition

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityEditor

Returns:

the connection provider

set

public final void set(@Nullable Entity entity)

Description copied from interface: EntityEditor

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

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

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

Specified by:

set in interface EntityEditor

Parameters:

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

See Also:

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

get

public final Entity get()

Specified by:

get in interface EntityEditor

Specified by:

get in interface Observable<Entity>

Returns:

an immutable copy of the entity being edited

replace

public final void replace(Entity entity)

Description copied from interface: EntityEditor

Replaces the entity without notifying that it is changing.

Specified by:

replace in interface EntityEditor

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

observer

public final Observer<Entity> observer()

Description copied from interface: Observer

Returns the underlying Observer to which listener operations are delegated.

For AbstractObserver subclasses this method returns this. For wrapper types, this returns the delegate observer.

Specified by:

observer in interface Observer<Entity>

Returns:

the Observer handling listener management

defaults

public final void defaults()

Description copied from interface: EntityEditor

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

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

Specified by:

defaults in interface EntityEditor

See Also:

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

revert

public final void revert()

Description copied from interface: EntityEditor

Reverts all attribute value changes.

Specified by:

revert in interface EntityEditor

refresh

public final void refresh()

Description copied from interface: EntityEditor

Refreshes the active Entity from the database, discarding all changes. If the active Entity is new then calling this method has no effect.

Specified by:

refresh in interface EntityEditor

See Also:

• EntityEditor.exists()

exists

public final EntityEditor.Exists exists()

Specified by:

exists in interface EntityEditor

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

Returns:

an ObservableState indicating the modified state of this entity

See Also:

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

changing

public final Observer<Entity> changing()

Description copied from interface: EntityEditor

Throwing a CancelException from a listener will cancel the change.

Specified by:

changing in interface EntityEditor

Returns:

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

See Also:

• EntityEditor.set(Entity)
• EntityEditor.defaults()

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

Specified by:

valueChanged in interface EntityEditor

Returns:

an observer notified each time a value is changed

nullable

public final boolean nullable(Attribute<?> attribute)

Specified by:

nullable in interface EntityEditor

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

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

Returns:

the Value controlling the validator

See Also:

• EntityEditor.validate(Entity)

valid

public final ObservableState valid()

Specified by:

valid in interface EntityEditor

Returns:

an ObservableState indicating the valid status of the underlying Entity.

See Also:

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

validate

public final void validate()

Description copied from interface: EntityEditor

Validates the current state of the entity

Specified by:

validate in interface EntityEditor

validate

public final void validate(Attribute<?> attribute)

Description copied from interface: EntityEditor

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

Specified by:

validate in interface EntityEditor

Parameters:

attribute - the attribute the value is associated with

validate

public final void validate(Collection<Entity> entities)

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

Parameters:

entities - the entities to validate

See Also:

• EntityDefinition.validator()

validate

public final void validate(Entity entity)

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

Parameters:

entity - the entity to validate

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

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

Returns:

the EntityEditor.SearchModels instance