Module is.codion.swing.framework.model

Package is.codion.swing.framework.model.component

Class EntityComboBoxModel

java.lang.Object

is.codion.swing.framework.model.component.EntityComboBoxModel

All Implemented Interfaces:

FilterModel<Entity>, FilterComboBoxModel<Entity>, ComboBoxModel<Entity>, ListModel<Entity>

public final class EntityComboBoxModel
extends Object
implements FilterComboBoxModel<Entity>

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

See Also:

• entityComboBoxModel(EntityType, EntityConnectionProvider)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntityComboBoxModel.ForeignKeyComboBoxModelFactory	Provides a combo box for filtering this combo box instance, either by filter predicate or query condition.
static interface	EntityComboBoxModel.ForeignKeyComboBoxModelLinker	Links a given combo box model representing master entities to this combo box model so that selection in the master model filters this model, either filter predicate or query condition

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

FilterComboBoxModel.ComboBoxItems<T>, FilterComboBoxModel.ComboBoxSelection<T>, FilterComboBoxModel.ItemFinder<T,V>, FilterComboBoxModel.NullItem<T>

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

FilterModel.AbstractRefresher<T>, FilterModel.FilteredItems<T>, FilterModel.Items<T>, FilterModel.Refresher<T>, FilterModel.VisibleItems<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	HANDLE_EDIT_EVENTS	Specifies whether entity combo box models handle entity edit events, by replacing updated entities and removing deleted ones Value type: Boolean Default value: true

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

NULL_CAPTION

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

ASYNC_REFRESH

Method Summary

Modifier and Type	Method	Description
void	addListDataListener(ListDataListener listener)
ValueSet<Attribute<?>>	attributes()	Controls the attributes to include when selecting the entities to populate this model with.
Value<Supplier<Condition>>	condition()	Controls the condition supplier to use when querying data, set to null to fetch all underlying entities.
EntityConnectionProvider	connectionProvider()
<T> Value<T>	createSelectorValue(Attribute<T> attribute)	Creates a Value linked to the selected entity via the value of the given attribute.
<V> Value<V>	createSelectorValue(FilterComboBoxModel.ItemFinder<Entity,V> itemFinder)
static EntityComboBoxModel	entityComboBoxModel(EntityType entityType, EntityConnectionProvider connectionProvider)
EntityType	entityType()
void	filterByForeignKey(ForeignKey foreignKey, Collection<Entity.Key> keys)	Filters this combo box model so that only items referencing the given keys via the given foreign key are visible.
Optional<Entity>	find(Entity.Key primaryKey)
EntityComboBoxModel.ForeignKeyComboBoxModelFactory	foreignKeyComboBoxModel(ForeignKey foreignKey)
EntityComboBoxModel.ForeignKeyComboBoxModelLinker	foreignKeyComboBoxModelLinker(ForeignKey foreignKey)
Collection<Entity.Key>	foreignKeyFilterKeys(ForeignKey foreignKey)
Predicate<Entity>	foreignKeyVisiblePredicate()	Use this method to retrieve the default foreign key filter visible predicate if you want to add a custom Predicate to this model via FilterModel.VisibleItems.predicate().
Entity	getElementAt(int index)
Entity	getSelectedItem()
int	getSize()
State	handleEditEvents()
FilterComboBoxModel.ComboBoxItems<Entity>	items()
Value<OrderBy>	orderBy()	Controls the order by to use when selecting entities for this model.
void	refresh()	Refreshes the items in this model using its FilterModel.Refresher.
void	refresh(Consumer<Collection<Entity>> onRefresh)	Refreshes the data in this filter model using its FilterModel.Refresher.
FilterModel.Refresher<Entity>	refresher()
void	removeListDataListener(ListDataListener listener)
void	select(Entity.Key primaryKey)	Selects the entity with the given primary key, whether filtered or visible.
FilterComboBoxModel.ComboBoxSelection<Entity>	selection()
void	setNullCaption(String nullCaption)	Enables the null item and sets the null item caption.
void	setSelectedItem(Object selectedItem)
State	strictForeignKeyFiltering()	Controls whether foreign key filtering should be strict or not.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

HANDLE_EDIT_EVENTS

public static final PropertyValue<Boolean> HANDLE_EDIT_EVENTS

Specifies whether entity combo box models handle entity edit events, by replacing updated entities and removing deleted ones

Value type: Boolean

Default value: true

See Also:

• handleEditEvents()
• EntityEditModel.POST_EDIT_EVENTS

Method Details

toString

public String toString()

Overrides:

toString in class Object

connectionProvider

public EntityConnectionProvider connectionProvider()

Returns:

the connection provider used by this combo box model

entityType

public EntityType entityType()

Returns:

the type of the entity this combo box model is based on

setNullCaption

public void setNullCaption(String nullCaption)

Enables the null item and sets the null item caption.

Parameters:

nullCaption - the null item caption

Throws:

NullPointerException - in case nullCaption is null

See Also:

• FilterComboBoxModel.ComboBoxItems.nullItem()

attributes

public ValueSet<Attribute<?>> attributes()

Controls the attributes to include when selecting the entities to populate this model with. Note that the primary key attribute values are always included. An empty Collection indicates that all attributes should be selected.

Returns:

the ValueSet controlling the attributes to select, an empty ValueSet indicating all available attributes

handleEditEvents

public State handleEditEvents()

Returns:

the State controlling whether this combo box model should handle entity edit events, by adding inserted items, updating any updated items and removing deleted ones

See Also:

• EntityEditEvents

find

public Optional<Entity> find(Entity.Key primaryKey)

Parameters:

primaryKey - the primary key of the entity to fetch from this model

Returns:

the entity with the given key if found in the model, an empty Optional otherwise

select

public void select(Entity.Key primaryKey)

Selects the entity with the given primary key, whether filtered or visible. 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

public Value<Supplier<Condition>> condition()

Controls the condition supplier to use when querying data, set to null to fetch all underlying entities.

Returns:

a value controlling the condition supplier

orderBy

public Value<OrderBy> orderBy()

Controls the order by to use when selecting entities for this model. Note that in order for this to have an effect, you must disable sorting by setting the sort comparator to null via FilterModel.VisibleItems.comparator()

Returns:

the Value controlling the OrderBy

See Also:

• FilterModel.VisibleItems.comparator()

foreignKeyVisiblePredicate

public Predicate<Entity> foreignKeyVisiblePredicate()

Use this method to retrieve the default foreign key filter visible predicate if you want to add a custom Predicate to this model via FilterModel.VisibleItems.predicate().

 
   Predicate fkPredicate = model.foreignKeyVisiblePredicate();
   model.items().visiblePredicate().set(item -> fkPredicate.test(item) && ...);
 
 

Returns:

the Predicate based on the foreign key filter entities

See Also:

• filterByForeignKey(ForeignKey, Collection)

filterByForeignKey

public void filterByForeignKey(ForeignKey foreignKey,
 Collection<Entity.Key> keys)

Filters this combo box model so that only items referencing the given keys via the given foreign key are visible. Note that this uses the FilterModel.VisibleItems.predicate() and replaces any previously set prediate.

Parameters:

foreignKey - the foreign key

keys - the keys, an empty Collection to clear the filter

See Also:

• FilterModel.VisibleItems.predicate()

foreignKeyFilterKeys

public Collection<Entity.Key> foreignKeyFilterKeys(ForeignKey foreignKey)

Parameters:

foreignKey - the foreign key

Returns:

the keys currently used to filter the items of this model by foreign key, an empty collection for none

See Also:

• filterByForeignKey(ForeignKey, Collection)

strictForeignKeyFiltering

public State strictForeignKeyFiltering()

Controls whether foreign key filtering should be strict or not. When the filtering is strict only entities with the correct reference are included, that is, entities with null values for the given foreign key are filtered. Non-strict simply means that entities with null references are not filtered.

Returns:

the State controlling whether foreign key filtering should be strict

See Also:

• filterByForeignKey(ForeignKey, Collection)

foreignKeyComboBoxModel

public EntityComboBoxModel.ForeignKeyComboBoxModelFactory foreignKeyComboBoxModel(ForeignKey foreignKey)

Parameters:

foreignKey - the foreign key

Returns:

a new EntityComboBoxModel.ForeignKeyComboBoxModelFactory

foreignKeyComboBoxModelLinker

public EntityComboBoxModel.ForeignKeyComboBoxModelLinker foreignKeyComboBoxModelLinker(ForeignKey foreignKey)

Parameters:

foreignKey - the foreign key

Returns:

a new EntityComboBoxModel.ForeignKeyComboBoxModelLinker

createSelectorValue

public <T> Value<T> createSelectorValue(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 Value for selecting items by attribute value

selection

public FilterComboBoxModel.ComboBoxSelection<Entity> selection()

Specified by:

selection in interface FilterComboBoxModel<Entity>

Specified by:

selection in interface FilterModel<Entity>

Returns:

the SingleItemSelection instance used by this filter model

getSelectedItem

public Entity getSelectedItem()

Specified by:

getSelectedItem in interface ComboBoxModel<Entity>

Specified by:

getSelectedItem in interface FilterComboBoxModel<Entity>

Returns:

the selected item, N.B. this can include the nullItem in case it has been set via FilterComboBoxModel.ComboBoxItems.nullItem(), FilterComboBoxModel.ComboBoxSelection.value() is usually what you want

createSelectorValue

public <V> Value<V> createSelectorValue(FilterComboBoxModel.ItemFinder<Entity,V> itemFinder)

Specified by:

createSelectorValue in interface FilterComboBoxModel<Entity>

Type Parameters:

V - the value type

Parameters:

itemFinder - responsible for finding the item to select

Returns:

a Value linked to the selected item using the given FilterComboBoxModel.ItemFinder instance

items

public FilterComboBoxModel.ComboBoxItems<Entity> items()

Specified by:

items in interface FilterComboBoxModel<Entity>

Specified by:

items in interface FilterModel<Entity>

Returns:

the model items

refresher

public FilterModel.Refresher<Entity> refresher()

Specified by:

refresher in interface FilterModel<Entity>

Returns:

this models Refresher instance

refresh

public void refresh()

Description copied from interface: FilterModel

Refreshes the items in this model using its FilterModel.Refresher.

Specified by:

refresh in interface FilterModel<Entity>

See Also:

• FilterModel.refresh()

refresh

public void refresh(Consumer<Collection<Entity>> onRefresh)

Description copied from interface: FilterModel

Refreshes the data in this filter model using its FilterModel.Refresher. Note that this method only throws exceptions when run synchronously off the user interface thread. Use FilterModel.Refresher.failure() to listen for exceptions that happen during asynchronous refresh.

Specified by:

refresh in interface FilterModel<Entity>

Parameters:

onRefresh - called after a successful refresh, may be null

See Also:

• FilterModel.Refresher.observer()
• FilterModel.Refresher.success()
• FilterModel.Refresher.failure()
• FilterModel.Refresher.async()

setSelectedItem

public void setSelectedItem(Object selectedItem)

Specified by:

setSelectedItem in interface ComboBoxModel<Entity>

getSize

public int getSize()

Specified by:

getSize in interface ListModel<Entity>

getElementAt

public Entity getElementAt(int index)

Specified by:

getElementAt in interface ListModel<Entity>

addListDataListener

public void addListDataListener(ListDataListener listener)

Specified by:

addListDataListener in interface ListModel<Entity>

removeListDataListener

public void removeListDataListener(ListDataListener listener)

Specified by:

removeListDataListener in interface ListModel<Entity>

entityComboBoxModel

public static EntityComboBoxModel entityComboBoxModel(EntityType entityType,
 EntityConnectionProvider connectionProvider)

Parameters:

entityType - the type of the entity this combo box model should represent

connectionProvider - a EntityConnectionProvider instance

Returns:

a new EntityComboBoxModel instance