Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityComboBoxModel

All Superinterfaces:

FilterComboBoxModel<Entity>, FilterModel<Entity>

All Known Subinterfaces:

SwingEntityComboBoxModel

public interface EntityComboBoxModel
extends FilterComboBoxModel<Entity>

A ComboBoxModel based on an Entity, showing by default all the entities in the underlying table.

To filter a EntityComboBoxModel use filter() to set a Predicate or configure ForeignKey based filtering.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityComboBoxModel.Builder	Builds a EntityComboBoxModel.
static interface	EntityComboBoxModel.Filter	Controls the filters for a EntityComboBoxModel
static interface	EntityComboBoxModel.ForeignKeyFilter	Controls a foreign key filter for a EntityComboBoxModel

Nested classes/interfaces inherited from interface is.codion.common.model.component.combobox.FilterComboBoxModel

FilterComboBoxModel.ComboBoxItems<T>, FilterComboBoxModel.ItemComboBoxModelBuilder<T>, FilterComboBoxModel.ItemFinder<T,V>

Nested classes/interfaces inherited from interface is.codion.common.model.filter.FilterModel

FilterModel.AbstractRefresher<T>, FilterModel.FilteredItems<T>, FilterModel.IncludedItems<T>, FilterModel.IncludePredicate<T>, FilterModel.Items<T>, FilterModel.Refresher<T>, FilterModel.Sort<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	PERSISTENCE_AWARE	Specifies whether entity combo box models respond to entity persistence events, by adding new entities, replacing updated and removing deleted ones Value type: Boolean Default value: true

Fields inherited from interface is.codion.common.model.component.combobox.FilterComboBoxModel

NULL_CAPTION

Fields inherited from interface is.codion.common.model.filter.FilterModel

ASYNC

Method Summary

Modifier and Type	Method	Description
static EntityComboBoxModel.Builder.EntityTypeStep	builder()
Value<Supplier<Condition>>	condition()	Controls the condition supplier used when querying data, setting this to null reverts to the condition specifying all underlying entities.
EntityConnectionProvider	connectionProvider()
EntityDefinition	entityDefinition()
EntityComboBoxModel.Filter	filter()
void	select(Entity.Key primaryKey)	Selects the entity with the given primary key, whether included or filtered.
<T> Value<T>	selector(Attribute<T> attribute)	Creates a Value linked to the selected entity via the value of the given attribute.

Methods inherited from interface is.codion.common.model.component.combobox.FilterComboBoxModel

items, selectedItem, selector

Methods inherited from interface is.codion.common.model.filter.FilterModel

selection, sort

Field Details

PERSISTENCE_AWARE

static final PropertyValue<Boolean> PERSISTENCE_AWARE

Specifies whether entity combo box models respond to entity persistence events, by adding new entities, replacing updated and removing deleted ones

• Value type: Boolean
• Default value: true

See Also:

• EntityComboBoxModel.Builder.persistenceAware(boolean)
• EntityEditor.PUBLISH_PERSISTENCE_EVENTS

Method Details

connectionProvider

EntityConnectionProvider connectionProvider()

Returns:

the connection provider used by this combo box model

entityDefinition

EntityDefinition entityDefinition()

Returns:

the underlying EntityDefinition

select

void select(Entity.Key primaryKey)

Selects the entity with the given primary key, whether included or filtered. If the entity is not available in the model this method returns silently without changing the selection.

Parameters:

primaryKey - the primary key of the entity to select

condition

Value<Supplier<Condition>> condition()

Controls the condition supplier used when querying data, setting this to null reverts to the condition specifying all underlying entities.

The condition supplier may not return null, doing so will cause an exception when refreshing the model items.

Returns:

a value controlling the condition supplier

filter

EntityComboBoxModel.Filter filter()

Returns:

the EntityComboBoxModel.Filter instance

selector

<T> Value<T> selector(Attribute<T> attribute)

Creates a Value linked to the selected entity via the value of the given attribute.

Type Parameters:

T - the attribute type

Parameters:

attribute - the attribute

Returns:

a new Value for selecting items by attribute value

builder

static EntityComboBoxModel.Builder.EntityTypeStep builder()

Returns:

a EntityComboBoxModel.Builder.EntityTypeStep instance