Module is.codion.framework.model

Package is.codion.framework.model

Class AbstractEntityEditModel

java.lang.Object

is.codion.framework.model.AbstractEntityEditModel

All Implemented Interfaces:

EntityEditModel

Direct Known Subclasses:

SwingEntityEditModel

public abstract class AbstractEntityEditModel
extends Object
implements EntityEditModel

A default EntityEditModel implementation

Field Summary

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

EDIT_EVENTS, PERSIST_FOREIGN_KEYS, WARN_ABOUT_UNSAVED_DATA

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityEditModel(EntityType entityType, EntityConnectionProvider connectionProvider)	Instantiates a new AbstractEntityEditModel based on the given entity type.
protected	AbstractEntityEditModel(EntityType entityType, EntityConnectionProvider connectionProvider, EntityValidator validator)	Instantiates a new AbstractEntityEditModel based on the given entity type.

Method Summary

Modifier and Type	Method	Description
final void	addAfterDeleteListener(Consumer<Collection<Entity>> listener)
final void	addAfterInsertListener(Consumer<Collection<Entity>> listener)
final void	addAfterUpdateListener(Consumer<Map<Entity.Key,Entity>> listener)
final void	addBeforeDeleteListener(Consumer<Collection<Entity>> listener)
final void	addBeforeInsertListener(Consumer<Collection<Entity>> listener)
final void	addBeforeUpdateListener(Consumer<Map<Entity.Key,Entity>> listener)
final void	addConfirmOverwriteListener(Consumer<State> listener)
final <T> void	addEditListener(Attribute<T> attribute, Consumer<T> listener)	Adds a listener notified each time the value associated with the given attribute is edited via EntityEditModel.put(Attribute, Object) or EntityEditModel.remove(Attribute), note that this event is only fired if the value actually changes.
final void	addEntityListener(Consumer<Entity> listener)	Notified each time the entity is set via EntityEditModel.set(Entity) or EntityEditModel.setDefaults().
final void	addInsertUpdateOrDeleteListener(Runnable listener)
final void	addRefreshListener(Runnable listener)
final void	addValueChangeListener(Consumer<Attribute<?>> listener)
final <T> void	addValueListener(Attribute<T> attribute, Consumer<T> listener)	Adds a listener notified each time the value associated with the given attribute changes, either via editing or when the active entity is set.
final EntityConnectionProvider	connectionProvider()
final boolean	containsSearchModel(ForeignKey foreignKey)	Returns true if this edit model contains a EntitySearchModel for the given foreign key
EntitySearchModel	createForeignKeySearchModel(ForeignKey foreignKey)	Creates a EntitySearchModel for looking up entities referenced by the given foreign key, using the search attributes defined for that entity type.
final void	delete()	Deletes the active entity
final void	delete(Collection<? extends Entity> entities)	Deletes the given entities, returns silently on receiving an empty collection
protected void	delete(Collection<? extends Entity> entities, EntityConnection connection)	Deletes the given entities from the database using the given connection
final State	deleteEnabled()	Disabling delete causes an exception being thrown when deleting.
final State	editEvents()
final Entities	entities()
final Entity	entity()
final EntityDefinition	entityDefinition()
final EntityType	entityType()
final StateObserver	exists()
protected final Value<Predicate<Entity>>	existsPredicate()	Controls the 'exists' predicate for this edit model, which is responsible for providing the exists state of the underlying entity.
final EntitySearchModel	foreignKeySearchModel(ForeignKey foreignKey)
final <T> T	get(Attribute<T> attribute)	Returns the value associated with the given attribute
final Entity	insert()	Performs an insert on the active entity, sets the primary key values of the active entity according to the primary key of the inserted entity
final Collection<Entity>	insert(Collection<? extends Entity> entities)	Performs an insert on the given entities, returns silently on receiving an empty collection.
protected Collection<Entity>	insert(Collection<? extends Entity> entities, EntityConnection connection)	Inserts the given entities into the database using the given connection
final State	insertEnabled()	Disabling insert causes an exception being thrown when inserting.
final StateObserver	isNotNull(Attribute<?> attribute)
final StateObserver	isNull(Attribute<?> attribute)
StateObserver	modified()	Returns a StateObserver indicating when and if any values in the underlying Entity have been modified.
final StateObserver	modified(Attribute<?> attribute)	Returns a StateObserver instance indicating whether the value of the given attribute has been modified.
protected Collection<Entity>	modified(Collection<? extends Entity> entities)	Called during the update() function, to determine which entities need to be updated, these entities will then be forwarded to update(Collection, EntityConnection).
protected final Value<Predicate<Entity>>	modifiedPredicate()	Controls the 'modified' predicate for this edit model, which is responsible for providing the modified state of the underlying entity.
protected final State	modifiedState()
protected final void	notifyAfterDelete(Collection<Entity> deletedEntities)	Notifies that delete has been performed
protected final void	notifyAfterInsert(Collection<Entity> insertedEntities)	Notifies that insert has been performed
protected final void	notifyAfterUpdate(Map<Entity.Key,Entity> updatedEntities)	Notifies that update has been performed
protected final void	notifyBeforeDelete(Collection<Entity> entitiesToDelete)	Notifies that delete is about to be performed
protected final void	notifyBeforeInsert(Collection<Entity> entitiesToInsert)	Notifies that insert is about to be performed
protected final void	notifyBeforeUpdate(Map<Entity.Key,Entity> entitiesToUpdate)	Notifies that update is about to be performed
final boolean	nullable(Attribute<?> attribute)
final <T> Optional<T>	optional(Attribute<T> attribute)	Returns the value associated with the given attribute
final State	overwriteWarning()
final State	persist(Attribute<?> attribute)	Returns a State controlling whether the last used value for this attribute should persist when the model is cleared.
final StateObserver	primaryKeyNull()
final <T> T	put(Attribute<T> attribute, T value)	Sets the given value in the underlying Entity
final State	readOnly()	Making this edit model read-only prevents any changes from being persisted to the database, trying to insert, update or delete will cause an exception being thrown, it does not prevent editing.
final Entity	referencedEntity(ForeignKey foreignKey)	Returns the value associated with the given foreign key.
final void	refresh()	Refreshes all data models used by this edit model, combo box models f.ex.
protected void	refreshDataModels()	Refresh all data-models used by this edit model, combo box models and such.
final void	refreshEntity()	Refreshes the active Entity from the database, discarding all changes.
final <T> T	remove(Attribute<T> attribute)	Removes the given value from the underlying Entity
final void	removeAfterDeleteListener(Consumer<Collection<Entity>> listener)	Removes the given listener.
final void	removeAfterInsertListener(Consumer<Collection<Entity>> listener)	Removes the given listener.
final void	removeAfterUpdateListener(Consumer<Map<Entity.Key,Entity>> listener)	Removes the given listener.
final void	removeBeforeDeleteListener(Consumer<Collection<Entity>> listener)	Removes the given listener.
final void	removeBeforeInsertListener(Consumer<Collection<Entity>> listener)	Removes the given listener.
final void	removeBeforeUpdateListener(Consumer<Map<Entity.Key,Entity>> listener)	Removes the given listener.
final void	removeConfirmOverwriteListener(Consumer<State> listener)	Removes the given listener.
final <T> void	removeEditListener(Attribute<T> attribute, Consumer<T> listener)	Removes the given listener.
final void	removeEntityListener(Consumer<Entity> listener)	Removes the given listener.
final void	removeInsertUpdateOrDeleteListener(Runnable listener)	Removes the given listener.
final void	removeRefreshListener(Runnable listener)	Removes the given listener.
final void	removeValueChangeListener(Consumer<Attribute<?>> listener)
final <T> void	removeValueListener(Attribute<T> attribute, Consumer<T> listener)	Removes the given listener.
final void	replace(ForeignKey foreignKey, Collection<Entity> entities)	For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from entities, useful when attribute values have been changed in the referenced entity that must be reflected in the edit model.
protected void	replaceForeignKey(ForeignKey foreignKey, Collection<Entity> values)	For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from values, useful when attribute values have been changed in the referenced entity that must be reflected in the edit model.
final void	set(Entity entity)	Copies the values from the given Entity into the underlying Entity being edited by this edit model.
final <T> void	setDefault(Attribute<T> attribute, Supplier<T> defaultValue)	Sets the default value supplier for the given attribute.
final void	setDefaults()	Populates this edit model with default values.
final String	toString()
final Entity	update()	Performs an update on the active entity
final Collection<Entity>	update(Collection<? extends Entity> entities)	Updates the given entities.
protected Collection<Entity>	update(Collection<? extends Entity> entities, EntityConnection connection)	Updates the given entities in the database using the given connection
final State	updateEnabled()	Disabling update causes an exception being thrown when updating.
final State	updateMultipleEnabled()	Disabling updating multiple entities causes an exception being thrown when trying to update multiple entities at a time.
final StateObserver	valid()
final StateObserver	valid(Attribute<?> attribute)
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.
void	validate(Entity entity)	Validates the given entity, using the underlying validator.
final void	validate(Collection<? extends Entity> entities)	Validates the given entities, using the underlying validator.
final EntityValidator	validator()
final <T> Value<T>	value(Attribute<T> attribute)	Returns a Value based on attribute in this edit model, note that subsequent calls for the same attribute return the same value instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface is.codion.framework.model.EntityEditModel

add, refreshing, remove

Constructor Details

AbstractEntityEditModel

protected AbstractEntityEditModel(EntityType entityType,
 EntityConnectionProvider connectionProvider)

Instantiates a new AbstractEntityEditModel based on the given entity type.

Parameters:

entityType - the type of the entity to base this AbstractEntityEditModel on

connectionProvider - the EntityConnectionProvider instance

AbstractEntityEditModel

protected AbstractEntityEditModel(EntityType entityType,
 EntityConnectionProvider connectionProvider,
 EntityValidator validator)

Instantiates a new AbstractEntityEditModel based on the given entity type.

Parameters:

entityType - the type of the entity to base this AbstractEntityEditModel on

connectionProvider - the EntityConnectionProvider instance

validator - the validator to use

Method Details

entities

public final Entities entities()

Specified by:

entities in interface EntityEditModel

Returns:

the underlying domain entities

entityDefinition

public final EntityDefinition entityDefinition()

Specified by:

entityDefinition in interface EntityEditModel

Returns:

the definition of the underlying entity

toString

public final String toString()

Overrides:

toString in class Object

setDefault

public final <T> void setDefault(Attribute<T> attribute,
 Supplier<T> defaultValue)

Description copied from interface: EntityEditModel

Sets the default value supplier for the given attribute. Used when the underlying value is not persistent. Use EntityEditModel.setDefaults() or EntityEditModel.set(Entity) with a null parameter to populate the model with the default values.

Specified by:

setDefault in interface EntityEditModel

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

defaultValue - the default value supplier

See Also:

• EntityEditModel.persist(Attribute)

overwriteWarning

public final State overwriteWarning()

Specified by:

overwriteWarning in interface EntityEditModel

Returns:

a state controlling whether this edit model triggers a warning before overwriting unsaved data

See Also:

• EntityEditModel.WARN_ABOUT_UNSAVED_DATA

editEvents

public final State editEvents()

Specified by:

editEvents in interface EntityEditModel

Returns:

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

See Also:

• EntityEditModel.EDIT_EVENTS

persist

public final State persist(Attribute<?> attribute)

Description copied from interface: EntityEditModel

Returns a State controlling whether the last used value for this attribute should persist when the model is cleared.

Specified by:

persist in interface EntityEditModel

Parameters:

attribute - the attribute

Returns:

a State controlling whether the given attribute value should persist when the model is cleared

See Also:

• EntityEditModel.PERSIST_FOREIGN_KEYS

readOnly

public final State readOnly()

Description copied from interface: EntityEditModel

Making this edit model read-only prevents any changes from being persisted to the database, trying to insert, update or delete will cause an exception being thrown, it does not prevent editing. Use EntityEditModel.insertEnabled(), EntityEditModel.updateEnabled() and EntityEditModel.deleteEnabled() to configure the enabled state of those specific actions.

Specified by:

readOnly in interface EntityEditModel

Returns:

the State controlling whether this model is read only

insertEnabled

public final State insertEnabled()

Description copied from interface: EntityEditModel

Disabling insert causes an exception being thrown when inserting.

Specified by:

insertEnabled in interface EntityEditModel

Returns:

the state controlling whether inserting is enabled via this edit model

updateEnabled

public final State updateEnabled()

Description copied from interface: EntityEditModel

Disabling update causes an exception being thrown when updating.

Specified by:

updateEnabled in interface EntityEditModel

Returns:

the state controlling whether updating is enabled via this edit model

updateMultipleEnabled

public final State updateMultipleEnabled()

Description copied from interface: EntityEditModel

Disabling updating multiple entities causes an exception being thrown when trying to update multiple entities at a time.

Specified by:

updateMultipleEnabled in interface EntityEditModel

Returns:

the state controlling whether updating multiple entities is enabled

deleteEnabled

public final State deleteEnabled()

Description copied from interface: EntityEditModel

Disabling delete causes an exception being thrown when deleting.

Specified by:

deleteEnabled in interface EntityEditModel

Returns:

the state controlling whether deleting is enabled via this edit model

exists

public final StateObserver exists()

Specified by:

exists in interface EntityEditModel

Returns:

a StateObserver indicating whether the active entity exists in the database

primaryKeyNull

public final StateObserver primaryKeyNull()

Specified by:

primaryKeyNull in interface EntityEditModel

Returns:

a StateObserver indicating whether the primary key of the active entity is null

set

public final void set(Entity entity)

Description copied from interface: EntityEditModel

Copies the values from the given Entity into the underlying Entity being edited by this edit model. If entity is null the effect is the same as calling EntityEditModel.setDefaults().

Specified by:

set in interface EntityEditModel

Parameters:

entity - the entity

See Also:

• EntityEditModel.setDefaults()

setDefaults

public final void setDefaults()

Description copied from interface: EntityEditModel

Populates this edit model with default values.

Specified by:

setDefaults in interface EntityEditModel

See Also:

• EntityEditModel.setDefault(Attribute, Supplier)
• AttributeDefinition.defaultValue()

entityType

public final EntityType entityType()

Specified by:

entityType in interface EntityEditModel

Returns:

the type of the entity this edit model is based on

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityEditModel

Returns:

the connection provider used by this edit model

replace

public final void replace(ForeignKey foreignKey,
 Collection<Entity> entities)

Description copied from interface: EntityEditModel

For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from entities, useful when attribute values have been changed in the referenced entity that must be reflected in the edit model.

Specified by:

replace in interface EntityEditModel

Parameters:

foreignKey - the foreign key

entities - the foreign key entities

entity

public final Entity entity()

Specified by:

entity in interface EntityEditModel

Returns:

an immutable version of the Entity instance being edited

See Also:

• Entity.immutable()

referencedEntity

public final Entity referencedEntity(ForeignKey foreignKey)

Description copied from interface: EntityEditModel

Returns the value associated with the given foreign key.

Specified by:

referencedEntity in interface EntityEditModel

Parameters:

foreignKey - the foreign key

Returns:

the foreign key value

modified

public StateObserver modified()

Description copied from interface: EntityEditModel

Returns a StateObserver indicating when and if any values in the underlying Entity have been modified.

Specified by:

modified in interface EntityEditModel

Returns:

a StateObserver indicating the modified state of this edit model

modified

public final StateObserver modified(Attribute<?> attribute)

Description copied from interface: EntityEditModel

Returns a StateObserver instance indicating whether the value of the given attribute has been modified.

Specified by:

modified in interface EntityEditModel

Parameters:

attribute - the attribute

Returns:

a StateObserver indicating the modified state of the value of the given attribute

See Also:

• EntityEditModel.modified()

get

public final <T> T get(Attribute<T> attribute)

Description copied from interface: EntityEditModel

Returns the value associated with the given attribute

Specified by:

get in interface EntityEditModel

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

the value associated with the given attribute

optional

public final <T> Optional<T> optional(Attribute<T> attribute)

Description copied from interface: EntityEditModel

Returns the value associated with the given attribute

Specified by:

optional in interface EntityEditModel

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

the value associated with the given attribute, an empty Optional in case it is null

put

public final <T> T put(Attribute<T> attribute,
 T value)

Description copied from interface: EntityEditModel

Sets the given value in the underlying Entity

Specified by:

put in interface EntityEditModel

Type Parameters:

T - the value type

Parameters:

attribute - the attribute to associate the given value with

value - the value to associate with the given attribute

Returns:

the previous value, if any

remove

public final <T> T remove(Attribute<T> attribute)

Description copied from interface: EntityEditModel

Removes the given value from the underlying Entity

Specified by:

remove in interface EntityEditModel

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

the value, if any

nullable

public final boolean nullable(Attribute<?> attribute)

Specified by:

nullable in interface EntityEditModel

Parameters:

attribute - the attribute

Returns:

true if this value is allowed to be null in the underlying entity

isNull

public final StateObserver isNull(Attribute<?> attribute)

Specified by:

isNull in interface EntityEditModel

Parameters:

attribute - the attribute

Returns:

a StateObserver indicating whether the value of the given attribute is null

isNotNull

public final StateObserver isNotNull(Attribute<?> attribute)

Specified by:

isNotNull in interface EntityEditModel

Parameters:

attribute - the attribute

Returns:

a StateObserver indicating whether the value of the given attribute is not null

valid

public final StateObserver valid()

Specified by:

valid in interface EntityEditModel

Returns:

a StateObserver indicating the valid status of the underlying Entity.

See Also:

• EntityEditModel.validator()
• EntityEditModel.validate(Attribute)
• EntityValidator.validate(Entity)

valid

public final StateObserver valid(Attribute<?> attribute)

Specified by:

valid in interface EntityEditModel

Parameters:

attribute - the attribute

Returns:

a StateObserver indicating the valid status of the given attribute.

See Also:

• EntityEditModel.validator()

validate

public final void validate(Attribute<?> attribute)
                    throws ValidationException

Description copied from interface: EntityEditModel

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

Specified by:

validate in interface EntityEditModel

Parameters:

attribute - the attribute the value is associated with

Throws:

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

See Also:

• EntityEditModel.validator()

validate

public final void validate()
                    throws ValidationException

Description copied from interface: EntityEditModel

Validates the current state of the entity

Specified by:

validate in interface EntityEditModel

Throws:

ValidationException - in case the entity is invalid

validate

public final void validate(Collection<? extends Entity> entities)
                    throws ValidationException

Description copied from interface: EntityEditModel

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 EntityEditModel

Parameters:

entities - the entities to validate

Throws:

ValidationException - on finding the first invalid entity

See Also:

• EntityEditModel.validator()
• EntityDefinition.validator()

validate

public void validate(Entity entity)
              throws ValidationException

Description copied from interface: EntityEditModel

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 EntityEditModel

Parameters:

entity - the entity to validate

Throws:

ValidationException - in case the entity is invalid

See Also:

• EntityEditModel.validator()

validator

public final EntityValidator validator()

Specified by:

validator in interface EntityEditModel

Returns:

the validator

insert

public final Entity insert()
                    throws DatabaseException,
ValidationException

Description copied from interface: EntityEditModel

Performs an insert on the active entity, sets the primary key values of the active entity according to the primary key of the inserted entity

Specified by:

insert in interface EntityEditModel

Returns:

the inserted entity

Throws:

DatabaseException - in case of a database exception

ValidationException - in case validation fails

See Also:

• EntityValidator.validate(Entity)

insert

public final Collection<Entity> insert(Collection<? extends Entity> entities)
                                throws DatabaseException,
ValidationException

Description copied from interface: EntityEditModel

Performs an insert on the given entities, returns silently on receiving an empty collection.

Specified by:

insert in interface EntityEditModel

Parameters:

entities - the entities to insert

Returns:

a list containing the inserted entities

Throws:

DatabaseException - in case of a database exception

ValidationException - in case validation fails

See Also:

• EntityEditModel.addBeforeInsertListener(Consumer)
• EntityEditModel.addAfterInsertListener(Consumer)
• EntityValidator.validate(Entity)

update

public final Entity update()
                    throws DatabaseException,
ValidationException

Description copied from interface: EntityEditModel

Performs an update on the active entity

Specified by:

update in interface EntityEditModel

Returns:

the updated entity

Throws:

DatabaseException - in case of a database exception

RecordModifiedException - in case the entity has been modified since it was loaded

UpdateException - in case the active entity is not modified

ValidationException - in case validation fails

See Also:

• EntityValidator.validate(Entity)

update

public final Collection<Entity> update(Collection<? extends Entity> entities)
                                throws DatabaseException,
ValidationException

Description copied from interface: EntityEditModel

Updates the given entities. If the entities are unmodified or the collection is empty this method returns silently.

Specified by:

update in interface EntityEditModel

Parameters:

entities - the entities to update

Returns:

the updated entities

Throws:

DatabaseException - in case of a database exception

RecordModifiedException - in case an entity has been modified since it was loaded

ValidationException - in case validation fails

See Also:

• EntityEditModel.addBeforeUpdateListener(Consumer)
• EntityEditModel.addAfterUpdateListener(Consumer)
• EntityValidator.validate(Entity)

delete

public final void delete()
                  throws DatabaseException

Description copied from interface: EntityEditModel

Deletes the active entity

Specified by:

delete in interface EntityEditModel

Throws:

DatabaseException - in case of a database exception

See Also:

• EntityEditModel.addBeforeDeleteListener(Consumer)
• EntityEditModel.addAfterDeleteListener(Consumer)

delete

public final void delete(Collection<? extends Entity> entities)
                  throws DatabaseException

Description copied from interface: EntityEditModel

Deletes the given entities, returns silently on receiving an empty collection

Specified by:

delete in interface EntityEditModel

Parameters:

entities - the entities to delete

Throws:

DatabaseException - in case of a database exception

See Also:

• EntityEditModel.addBeforeDeleteListener(Consumer)
• EntityEditModel.addAfterDeleteListener(Consumer)

refresh

public final void refresh()

Description copied from interface: EntityEditModel

Refreshes all data models used by this edit model, combo box models f.ex.

Specified by:

refresh in interface EntityEditModel

refreshEntity

public final void refreshEntity()

Description copied from interface: EntityEditModel

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:

refreshEntity in interface EntityEditModel

containsSearchModel

public final boolean containsSearchModel(ForeignKey foreignKey)

Description copied from interface: EntityEditModel

Returns true if this edit model contains a EntitySearchModel for the given foreign key

Specified by:

containsSearchModel in interface EntityEditModel

Parameters:

foreignKey - the foreign key

Returns:

true if a EntitySearchModel has been initialized for the given foreign key

createForeignKeySearchModel

public EntitySearchModel createForeignKeySearchModel(ForeignKey foreignKey)

Description copied from interface: EntityEditModel

Creates a EntitySearchModel for looking up entities referenced by the given foreign key, using the search attributes defined for that entity type.

Specified by:

createForeignKeySearchModel in interface EntityEditModel

Parameters:

foreignKey - the foreign key for which to create a EntitySearchModel

Returns:

a EntitySearchModel for looking up entities of the type referenced by the given foreign key attribute,

foreignKeySearchModel

public final EntitySearchModel foreignKeySearchModel(ForeignKey foreignKey)

Specified by:

foreignKeySearchModel in interface EntityEditModel

Parameters:

foreignKey - the foreign key for which to retrieve the EntitySearchModel

Returns:

the EntitySearchModel associated with the foreignKey, if no search model has been initialized for the given foreign key, a new one is created, associated with the foreign key and returned.

value

public final <T> Value<T> value(Attribute<T> attribute)

Description copied from interface: EntityEditModel

Returns a Value based on attribute in this edit model, note that subsequent calls for the same attribute return the same value instance.

Specified by:

value in interface EntityEditModel

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

a Value based on the given edit model value

removeEditListener

public final <T> void removeEditListener(Attribute<T> attribute,
 Consumer<T> listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeEditListener in interface EntityEditModel

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

listener - the listener to remove

addEditListener

public final <T> void addEditListener(Attribute<T> attribute,
 Consumer<T> listener)

Description copied from interface: EntityEditModel

Adds a listener notified each time the value associated with the given attribute is edited via EntityEditModel.put(Attribute, Object) or EntityEditModel.remove(Attribute), note that this event is only fired if the value actually changes.

Specified by:

addEditListener in interface EntityEditModel

Type Parameters:

T - the value type

Parameters:

attribute - the attribute for which to monitor value edits

listener - a listener notified each time the value of the given attribute is edited via this model

removeValueListener

public final <T> void removeValueListener(Attribute<T> attribute,
 Consumer<T> listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeValueListener in interface EntityEditModel

Type Parameters:

T - the value type

Parameters:

attribute - the attribute for which to remove the listener

listener - the listener to remove

addValueListener

public final <T> void addValueListener(Attribute<T> attribute,
 Consumer<T> listener)

Description copied from interface: EntityEditModel

Adds a listener notified each time the value associated with the given attribute changes, either via editing or when the active entity is set.

Specified by:

addValueListener in interface EntityEditModel

Type Parameters:

T - the value type

Parameters:

attribute - the attribute for which to monitor value changes

listener - a listener notified each time the value of the attribute changes

See Also:

• EntityEditModel.set(Entity)

removeValueChangeListener

public final void removeValueChangeListener(Consumer<Attribute<?>> listener)

Specified by:

removeValueChangeListener in interface EntityEditModel

Parameters:

listener - the listener to remove

addValueChangeListener

public final void addValueChangeListener(Consumer<Attribute<?>> listener)

Specified by:

addValueChangeListener in interface EntityEditModel

Parameters:

listener - a listener notified each time a value changes, providing the attribute

removeEntityListener

public final void removeEntityListener(Consumer<Entity> listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeEntityListener in interface EntityEditModel

Parameters:

listener - the listener to remove

addEntityListener

public final void addEntityListener(Consumer<Entity> listener)

Description copied from interface: EntityEditModel

Notified each time the entity is set via EntityEditModel.set(Entity) or EntityEditModel.setDefaults().

Specified by:

addEntityListener in interface EntityEditModel

Parameters:

listener - a listener notified each time the entity is set, possibly to null

See Also:

• EntityEditModel.set(Entity)
• EntityEditModel.setDefaults()

removeBeforeInsertListener

public final void removeBeforeInsertListener(Consumer<Collection<Entity>> listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeBeforeInsertListener in interface EntityEditModel

Parameters:

listener - a listener to remove

addBeforeInsertListener

public final void addBeforeInsertListener(Consumer<Collection<Entity>> listener)

Specified by:

addBeforeInsertListener in interface EntityEditModel

Parameters:

listener - a listener to be notified before an insert is performed

removeAfterInsertListener

public final void removeAfterInsertListener(Consumer<Collection<Entity>> listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeAfterInsertListener in interface EntityEditModel

Parameters:

listener - a listener to remove

addAfterInsertListener

public final void addAfterInsertListener(Consumer<Collection<Entity>> listener)

Specified by:

addAfterInsertListener in interface EntityEditModel

Parameters:

listener - a listener to be notified each time insert has been performed

removeBeforeUpdateListener

public final void removeBeforeUpdateListener(Consumer<Map<Entity.Key,Entity>> listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeBeforeUpdateListener in interface EntityEditModel

Parameters:

listener - a listener to remove

addBeforeUpdateListener

public final void addBeforeUpdateListener(Consumer<Map<Entity.Key,Entity>> listener)

Specified by:

addBeforeUpdateListener in interface EntityEditModel

Parameters:

listener - a listener to be notified before an update is performed

removeAfterUpdateListener

public final void removeAfterUpdateListener(Consumer<Map<Entity.Key,Entity>> listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeAfterUpdateListener in interface EntityEditModel

Parameters:

listener - a listener to remove

addAfterUpdateListener

public final void addAfterUpdateListener(Consumer<Map<Entity.Key,Entity>> listener)

Specified by:

addAfterUpdateListener in interface EntityEditModel

Parameters:

listener - a listener to be notified each time an update has been performed, with the updated entities, mapped to their respective original primary keys, that is, the primary keys before the update was performed

addBeforeDeleteListener

public final void addBeforeDeleteListener(Consumer<Collection<Entity>> listener)

Specified by:

addBeforeDeleteListener in interface EntityEditModel

Parameters:

listener - a listener to be notified before a delete is performed

removeBeforeDeleteListener

public final void removeBeforeDeleteListener(Consumer<Collection<Entity>> listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeBeforeDeleteListener in interface EntityEditModel

Parameters:

listener - a listener to remove

removeAfterDeleteListener

public final void removeAfterDeleteListener(Consumer<Collection<Entity>> listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeAfterDeleteListener in interface EntityEditModel

Parameters:

listener - a listener to remove

addAfterDeleteListener

public final void addAfterDeleteListener(Consumer<Collection<Entity>> listener)

Specified by:

addAfterDeleteListener in interface EntityEditModel

Parameters:

listener - a listener to be notified each time delete has been performed

removeInsertUpdateOrDeleteListener

public final void removeInsertUpdateOrDeleteListener(Runnable listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeInsertUpdateOrDeleteListener in interface EntityEditModel

Parameters:

listener - a listener to remove

addInsertUpdateOrDeleteListener

public final void addInsertUpdateOrDeleteListener(Runnable listener)

Specified by:

addInsertUpdateOrDeleteListener in interface EntityEditModel

Parameters:

listener - a listener notified each time one or more entities are updated, inserted or deleted via this model

addConfirmOverwriteListener

public final void addConfirmOverwriteListener(Consumer<State> listener)

Specified by:

addConfirmOverwriteListener in interface EntityEditModel

Parameters:

listener - a listener notified each time the active entity is about to be set

removeConfirmOverwriteListener

public final void removeConfirmOverwriteListener(Consumer<State> listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeConfirmOverwriteListener in interface EntityEditModel

Parameters:

listener - a listener to remove

addRefreshListener

public final void addRefreshListener(Runnable listener)

Specified by:

addRefreshListener in interface EntityEditModel

Parameters:

listener - a listener to be notified each time a refresh has been performed

See Also:

• EntityEditModel.refresh()

removeRefreshListener

public final void removeRefreshListener(Runnable listener)

Description copied from interface: EntityEditModel

Removes the given listener.

Specified by:

removeRefreshListener in interface EntityEditModel

Parameters:

listener - a listener to remove

insert

protected Collection<Entity> insert(Collection<? extends Entity> entities,
 EntityConnection connection)
                             throws DatabaseException

Inserts the given entities into the database using the given connection

Parameters:

entities - the entities to insert

connection - the connection to use

Returns:

the inserted entities

Throws:

DatabaseException - in case of a database exception

update

protected Collection<Entity> update(Collection<? extends Entity> entities,
 EntityConnection connection)
                             throws DatabaseException

Updates the given entities in the database using the given connection

Parameters:

entities - the entities to update

connection - the connection to use

Returns:

the updated entities

Throws:

DatabaseException - in case of a database exception

delete

protected void delete(Collection<? extends Entity> entities,
 EntityConnection connection)
               throws DatabaseException

Deletes the given entities from the database using the given connection

Parameters:

entities - the entities to delete

connection - the connection to use

Throws:

DatabaseException - in case of a database exception

modified

protected Collection<Entity> modified(Collection<? extends Entity> entities)

Called during the update() function, to determine which entities need to be updated, these entities will then be forwarded to update(Collection, EntityConnection). Returns the entities that have been modified and require updating, override to be able to perform an update on unmodified entities or to return an empty list to veto an update action.

Parameters:

entities - the entities

Returns:

the entities requiring update

See Also:

• update()
• update(Collection)

refreshDataModels

protected void refreshDataModels()

Refresh all data-models used by this edit model, combo box models and such.

replaceForeignKey

protected void replaceForeignKey(ForeignKey foreignKey,
 Collection<Entity> values)

For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from values, useful when attribute values have been changed in the referenced entity that must be reflected in the edit model.

Parameters:

foreignKey - the foreign key attribute

values - the foreign key entities

modifiedPredicate

protected final Value<Predicate<Entity>> modifiedPredicate()

Controls the 'modified' predicate for this edit model, which is responsible for providing the modified state of the underlying entity.

Returns:

the value controlling the predicate used to check if the entity is modified

See Also:

• Entity.modified()
• modified()

existsPredicate

protected final Value<Predicate<Entity>> existsPredicate()

Controls the 'exists' predicate for this edit model, which is responsible for providing the exists state of the underlying entity.

Returns:

the value controlling the predicate used to check if the entity exists

See Also:

• EntityDefinition.exists()
• Entity.exists()

modifiedState

protected final State modifiedState()

Returns:

the State used to indicate the modified state of this edit model, handle with care

notifyBeforeInsert

protected final void notifyBeforeInsert(Collection<Entity> entitiesToInsert)

Notifies that insert is about to be performed

Parameters:

entitiesToInsert - the entities about to be inserted

See Also:

• addBeforeInsertListener(Consumer)

notifyAfterInsert

protected final void notifyAfterInsert(Collection<Entity> insertedEntities)

Notifies that insert has been performed

Parameters:

insertedEntities - the inserted entities

See Also:

• addAfterInsertListener(Consumer)

notifyBeforeUpdate

protected final void notifyBeforeUpdate(Map<Entity.Key,Entity> entitiesToUpdate)

Notifies that update is about to be performed

Parameters:

entitiesToUpdate - the entities about to be updated

See Also:

• addBeforeUpdateListener(Consumer)

notifyAfterUpdate

protected final void notifyAfterUpdate(Map<Entity.Key,Entity> updatedEntities)

Notifies that update has been performed

Parameters:

updatedEntities - the updated entities

See Also:

• addAfterUpdateListener(Consumer)

notifyBeforeDelete

protected final void notifyBeforeDelete(Collection<Entity> entitiesToDelete)

Notifies that delete is about to be performed

Parameters:

entitiesToDelete - the entities about to be deleted

See Also:

• addBeforeDeleteListener(Consumer)

notifyAfterDelete

protected final void notifyAfterDelete(Collection<Entity> deletedEntities)

Notifies that delete has been performed

Parameters:

deletedEntities - the deleted entities

See Also:

• addAfterDeleteListener(Consumer)