Module is.codion.framework.model

Package is.codion.framework.model

Class DefaultEntityEditor

java.lang.Object

is.codion.framework.model.DefaultEntityEditor

All Implemented Interfaces:

EntityEditor

Direct Known Subclasses:

SwingEntityEditor

public class DefaultEntityEditor
extends Object
implements EntityEditor

A default EntityEditor implementation.

Nested Class Summary

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

EntityEditor.ComponentModels, EntityEditor.EditorEntity, EntityEditor.EditorPersistence, EntityEditor.EditorValue<T>, EntityEditor.EditorValues, EntityEditor.Exists, EntityEditor.Modified, EntityEditor.PersistEvents, EntityEditor.PersistTask<T>, EntityEditor.PersistTasks, EntityEditor.SearchModels

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 Entities	entities()
final EntityEditor.EditorEntity	entity()
final EntityDefinition	entityDefinition()
final EntityEditor.PersistEvents	events()
final EntityEditor.Exists	exists()
final EntityEditor.Modified	modified()	Returns an ObservableState indicating whether any values have been modified.
final EntityEditor.EditorPersistence	persistence()
final ObservableState	primaryKeyPresent()
final State	publishPersistenceEvents()
final EntityEditor.SearchModels	searchModels()
final EntityEditor.PersistTasks	tasks(EntityConnection connection)
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 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

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

events

public final EntityEditor.PersistEvents events()

Specified by:

events in interface EntityEditor

Returns:

the EntityEditor.PersistEvents

publishPersistenceEvents

public final State publishPersistenceEvents()

Specified by:

publishPersistenceEvents in interface EntityEditor

Returns:

a state controlling whether this edit model publishes insert, update and delete events on the PersistenceEvents event bus.

See Also:

• EntityEditor.PUBLISH_PERSISTENCE_EVENTS

entity

public final EntityEditor.EditorEntity entity()

Specified by:

entity in interface EntityEditor

Returns:

the EntityEditor.EditorEntity instance

values

public final EntityEditor.EditorValues values()

Specified by:

values in interface EntityEditor

Returns:

the EntityEditor.EditorValues

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

See Also:

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

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()
                    throws EntityValidationException

Description copied from interface: EntityEditor

Validates the current state of the entity

Specified by:

validate in interface EntityEditor

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

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

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

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

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

persistence

public final EntityEditor.EditorPersistence persistence()

Specified by:

persistence in interface EntityEditor

Returns:

the EntityEditor.EditorPersistence used by this editor

tasks

public final EntityEditor.PersistTasks tasks(EntityConnection connection)

Specified by:

tasks in interface EntityEditor

Parameters:

connection - the connection to use when persisting

Returns:

the EntityEditor.PersistTasks instance

toString

public final String toString()

Overrides:

toString in class Object

componentModels

protected EntityEditor.ComponentModels componentModels()

Returns:

the EntityEditor.ComponentModels instance