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/interfaces inherited from interface is.codion.swing.common.model.component.combobox.FilterComboBoxModel

FilterComboBoxModel.ItemFinder<T,V>

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

FilterModel.AbstractRefresher<T>, FilterModel.Refresher<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

COMBO_BOX_NULL_CAPTION

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

ASYNC_REFRESH

Method Summary

Modifier and Type	Method	Description
void	add(Entity item)	Adds the given item to this model, respecting the sorting order if specified.
void	addListDataListener(ListDataListener listener)
ValueSet<Attribute<?>>	attributes()	Controls the attributes to include when selecting the entities to populate this model with.
void	clear()	Clears all items from this combo box model, including the null item and sets the selected item to null
boolean	cleared()
Value<Comparator<Entity>>	comparator()	Controls the Comparator used when sorting the visible items in this model and sorts the model accordingly.
Value<Supplier<Condition>>	condition()	Controls the condition supplier to use when querying data, set to null to fetch all underlying entities.
EntityConnectionProvider	connectionProvider()
boolean	containsItem(Entity item)	Returns true if this model contains the given item, visible or filtered.
EntityComboBoxModel	createForeignKeyConditionComboBoxModel(ForeignKey foreignKey)	Returns a combo box model for selecting a foreign key value for using as a condition this model.
EntityComboBoxModel	createForeignKeyFilterComboBoxModel(ForeignKey foreignKey)	Returns a combo box model for selecting a foreign key value for filtering this model.
<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()
boolean	filtered(Entity item)	Returns true if this model contains the given item, and it is filtered, that is, is not visible
int	filteredCount()
Collection<Entity>	filteredItems()
void	filterItems()	Filters this model according to the condition specified by FilterModel.includeCondition().
State	filterSelectedItem()	Specifies whether filtering can change the selected item, if true then the selected item is set to null when the currently selected item is filtered from the model, otherwise the selected item can potentially represent a value which is not currently visible in the model.
Optional<Entity>	find(Entity.Key primaryKey)
Predicate<Entity>	foreignKeyIncludeCondition()	Use this method to retrieve the default foreign key filter include condition if you want to add a custom Predicate to this model via includeCondition().
Entity	getElementAt(int index)
Collection<Entity.Key>	getForeignKeyFilterKeys(ForeignKey foreignKey)
Entity	getSelectedItem()
int	getSize()
State	handleEditEvents()
Value<Predicate<Entity>>	includeCondition()
State	includeNull()
Collection<Entity>	items()
void	linkForeignKeyConditionComboBoxModel(ForeignKey foreignKey, EntityComboBoxModel foreignKeyModel)	Links the given combo box model representing master entities to this combo box model so that selection in the master model refreshes this model with the selected master entity as condition
void	linkForeignKeyFilterComboBoxModel(ForeignKey foreignKey, EntityComboBoxModel foreignKeyModel)	Links the given combo box model representing master entities to this combo box model so that selection in the master model filters this model according to the selected master entity
Value<Entity>	nullItem()	Controls the item that should represent the null value in this model.
boolean	nullSelected()	Returns true if this model contains null and it is selected.
Value<OrderBy>	orderBy()	Controls the order by to use when selecting entities for this model.
void	refresh()	Refreshes the items in this filtered model using its FilterModel.Refresher.
FilterModel.Refresher<Entity>	refresher()
void	refreshThen(Consumer<Collection<Entity>> afterRefresh)	Refreshes the data in this filter model using its FilterModel.Refresher.
void	remove(Entity item)	Removes the given item from this model
void	removeListDataListener(ListDataListener listener)
void	replace(Entity item, Entity replacement)	Replaces the given item in this combo box model
void	select(Entity.Key primaryKey)	Selects the entity with the given primary key, whether filtered or visible.
Value<Function<Object,Entity>>	selectedItemTranslator()	Provides a way for the combo box model to translate an item when it is selected, such as selecting the String "1" in a String based model when selected item is set to the number 1.
Entity	selectedValue()
StateObserver	selectionEmpty()
EventObserver<Entity>	selectionEvent()
void	setForeignKeyFilterKeys(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 shown.
void	setItems(Collection<Entity> items)	Resets the items of this model using the values found in items.
void	setNullCaption(String nullCaption)	Enables the null item and sets the null item caption.
void	setSelectedItem(Object selectedItem)
void	sortItems()	Sorts the items in this model
State	strictForeignKeyFiltering()	Controls whether foreign key filtering should be strict or not.
String	toString()
Value<Predicate<Entity>>	validator()	Provides a way for the model to prevent the addition of certain items.
Value<Predicate<Entity>>	validSelectionPredicate()	Provides a way for the combo box model to prevent the selection of certain items.
boolean	visible(Entity item)	Returns true if this model contains the given item, and it is visible, that is, not filtered
int	visibleCount()
List<Entity>	visibleItems()

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:

• includeNull()
• 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 (comparator()

Returns:

the Value controlling the orderBy

See Also:

• comparator()

foreignKeyIncludeCondition

public Predicate<Entity> foreignKeyIncludeCondition()

Use this method to retrieve the default foreign key filter include condition if you want to add a custom Predicate to this model via includeCondition().

   Predicate fkCondition = model.foreignKeyIncludeCondition();
   model.includeCondition().set(item -> fkCondition.test(item) && ...);
 

Returns:

the Predicate based on the foreign key filter entities

See Also:

• setForeignKeyFilterKeys(ForeignKey, Collection)

setForeignKeyFilterKeys

public void setForeignKeyFilterKeys(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 shown.

Parameters:

foreignKey - the foreign key

keys - the keys, an empty Collection for none

getForeignKeyFilterKeys

public Collection<Entity.Key> getForeignKeyFilterKeys(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

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:

• setForeignKeyFilterKeys(ForeignKey, Collection)

createForeignKeyFilterComboBoxModel

public EntityComboBoxModel createForeignKeyFilterComboBoxModel(ForeignKey foreignKey)

Returns a combo box model for selecting a foreign key value for filtering this model.

Parameters:

foreignKey - the foreign key

Returns:

a combo box model for selecting a filtering value for this combo box model

See Also:

• linkForeignKeyFilterComboBoxModel(ForeignKey, EntityComboBoxModel)

createForeignKeyConditionComboBoxModel

public EntityComboBoxModel createForeignKeyConditionComboBoxModel(ForeignKey foreignKey)

Returns a combo box model for selecting a foreign key value for using as a condition this model. Note that each time the selection changes in the created model this model is refreshed.

Parameters:

foreignKey - the foreign key

Returns:

a combo box model for selecting a filtering value for this combo box model

See Also:

• linkForeignKeyConditionComboBoxModel(ForeignKey, EntityComboBoxModel)

linkForeignKeyFilterComboBoxModel

public void linkForeignKeyFilterComboBoxModel(ForeignKey foreignKey,
 EntityComboBoxModel foreignKeyModel)

Links the given combo box model representing master entities to this combo box model so that selection in the master model filters this model according to the selected master entity

Parameters:

foreignKey - the foreign key attribute

foreignKeyModel - the combo box model to link

linkForeignKeyConditionComboBoxModel

public void linkForeignKeyConditionComboBoxModel(ForeignKey foreignKey,
 EntityComboBoxModel foreignKeyModel)

Links the given combo box model representing master entities to this combo box model so that selection in the master model refreshes this model with the selected master entity as condition

Parameters:

foreignKey - the foreign key attribute

foreignKeyModel - the combo box model to link

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

clear

public void clear()

Description copied from interface: FilterComboBoxModel

Clears all items from this combo box model, including the null item and sets the selected item to null

Specified by:

clear in interface FilterComboBoxModel<Entity>

cleared

public boolean cleared()

Specified by:

cleared in interface FilterComboBoxModel<Entity>

Returns:

true if the model data has been cleared and needs to be refreshed

setItems

public void setItems(Collection<Entity> items)

Description copied from interface: FilterComboBoxModel

Resets the items of this model using the values found in items.

Specified by:

setItems in interface FilterComboBoxModel<Entity>

Parameters:

items - the items to display in this combo box model

See Also:

• FilterComboBoxModel.cleared()
• FilterComboBoxModel.validator()

add

public void add(Entity item)

Description copied from interface: FilterComboBoxModel

Adds the given item to this model, respecting the sorting order if specified. If this model already contains the item, calling this method has no effect. Note that if the item does not satisfy the include condition, it will be filtered right away.

Specified by:

add in interface FilterComboBoxModel<Entity>

Parameters:

item - the item to add

See Also:

• FilterModel.includeCondition()

remove

public void remove(Entity item)

Description copied from interface: FilterComboBoxModel

Removes the given item from this model

Specified by:

remove in interface FilterComboBoxModel<Entity>

Parameters:

item - the item to remove

replace

public void replace(Entity item,
 Entity replacement)

Description copied from interface: FilterComboBoxModel

Replaces the given item in this combo box model

Specified by:

replace in interface FilterComboBoxModel<Entity>

Parameters:

item - the item to replace

replacement - the replacement item

sortItems

public void sortItems()

Description copied from interface: FilterComboBoxModel

Sorts the items in this model

Specified by:

sortItems in interface FilterComboBoxModel<Entity>

See Also:

• FilterComboBoxModel.comparator()

comparator

public Value<Comparator<Entity>> comparator()

Description copied from interface: FilterComboBoxModel

Controls the Comparator used when sorting the visible items in this model and sorts the model accordingly. This Comparator must take into account the null value if a null item has been set via FilterComboBoxModel.nullItem(). If a null comparator is provided no sorting will be performed.

Specified by:

comparator in interface FilterComboBoxModel<Entity>

Returns:

the Value controlling the comparator used when sorting, value may be null if the items of this model should not be sorted

validator

public Value<Predicate<Entity>> validator()

Description copied from interface: FilterComboBoxModel

Provides a way for the model to prevent the addition of certain items. Trying to add items that fail validation will result in an exception. Note that any translation of the selected item is done before validation.

Specified by:

validator in interface FilterComboBoxModel<Entity>

Returns:

the Value controlling the item validator

selectedItemTranslator

public Value<Function<Object,Entity>> selectedItemTranslator()

Description copied from interface: FilterComboBoxModel

Provides a way for the combo box model to translate an item when it is selected, such as selecting the String "1" in a String based model when selected item is set to the number 1.

Specified by:

selectedItemTranslator in interface FilterComboBoxModel<Entity>

Returns:

the Value controlling the selected item translator

validSelectionPredicate

public Value<Predicate<Entity>> validSelectionPredicate()

Description copied from interface: FilterComboBoxModel

Provides a way for the combo box model to prevent the selection of certain items.

Specified by:

validSelectionPredicate in interface FilterComboBoxModel<Entity>

Returns:

the Value controlling the valid selection predicate

includeNull

public State includeNull()

Specified by:

includeNull in interface FilterComboBoxModel<Entity>

Returns:

the State controlling whether a null value is included as the first item

See Also:

• FilterComboBoxModel.nullItem()

nullItem

public Value<Entity> nullItem()

Description copied from interface: FilterComboBoxModel

Controls the item that should represent the null value in this model. Note that FilterComboBoxModel.includeNull() must be used as well to enable the null value.

Specified by:

nullItem in interface FilterComboBoxModel<Entity>

Returns:

the Value controlling the item representing null

See Also:

• FilterComboBoxModel.includeNull()

nullSelected

public boolean nullSelected()

Description copied from interface: FilterComboBoxModel

Returns true if this model contains null and it is selected.

Specified by:

nullSelected in interface FilterComboBoxModel<Entity>

Returns:

true if this model contains null and it is selected, false otherwise

See Also:

• FilterComboBoxModel.includeNull()

selectionEmpty

public StateObserver selectionEmpty()

Specified by:

selectionEmpty in interface FilterComboBoxModel<Entity>

Returns:

a StateObserver indicating whether the selection is empty or the value representing null is selected

selectedValue

public Entity selectedValue()

Specified by:

selectedValue in interface FilterComboBoxModel<Entity>

Returns:

the selected value, null in case the value representing null is selected

See Also:

• FilterComboBoxModel.nullSelected()

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.nullItem(), FilterComboBoxModel.selectedValue() is usually what you want

filterSelectedItem

public State filterSelectedItem()

Description copied from interface: FilterComboBoxModel

Specifies whether filtering can change the selected item, if true then the selected item is set to null when the currently selected item is filtered from the model, otherwise the selected item can potentially represent a value which is not currently visible in the model. This is true by default.

Specified by:

filterSelectedItem in interface FilterComboBoxModel<Entity>

Returns:

the State controlling whether the selected item is changed when it is filtered

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 via the given finder instance

selectionEvent

public EventObserver<Entity> selectionEvent()

Specified by:

selectionEvent in interface FilterComboBoxModel<Entity>

Returns:

an observer notified each time the selection changes

filterItems

public void filterItems()

Description copied from interface: FilterModel

Filters this model according to the condition specified by FilterModel.includeCondition(). If no include condition is specified this method does nothing. This method does not interfere with the internal ordering of the visible items.

Specified by:

filterItems in interface FilterModel<Entity>

See Also:

• FilterModel.includeCondition()

includeCondition

public Value<Predicate<Entity>> includeCondition()

Specified by:

includeCondition in interface FilterModel<Entity>

Returns:

the include condition value

items

public Collection<Entity> items()

Specified by:

items in interface FilterModel<Entity>

Returns:

an unmodifiable view of all visible and filtered items in this model

See Also:

• FilterModel.visibleItems()
• FilterModel.filteredItems()

visibleItems

public List<Entity> visibleItems()

Specified by:

visibleItems in interface FilterModel<Entity>

Returns:

an unmodifiable view of the visible items, in the order they appear in the model

filteredItems

public Collection<Entity> filteredItems()

Specified by:

filteredItems in interface FilterModel<Entity>

Returns:

an unmodifiable view of the filtered items

visibleCount

public int visibleCount()

Specified by:

visibleCount in interface FilterModel<Entity>

Returns:

the number of currently visible items

filteredCount

public int filteredCount()

Specified by:

filteredCount in interface FilterModel<Entity>

Returns:

the number of currently filtered items

containsItem

public boolean containsItem(Entity item)

Description copied from interface: FilterModel

Returns true if this model contains the given item, visible or filtered.

Specified by:

containsItem in interface FilterModel<Entity>

Parameters:

item - the item

Returns:

true if this model contains the item

visible

public boolean visible(Entity item)

Description copied from interface: FilterModel

Returns true if this model contains the given item, and it is visible, that is, not filtered

Specified by:

visible in interface FilterModel<Entity>

Parameters:

item - the item

Returns:

true if the given item is visible

filtered

public boolean filtered(Entity item)

Description copied from interface: FilterModel

Returns true if this model contains the given item, and it is filtered, that is, is not visible

Specified by:

filtered in interface FilterModel<Entity>

Parameters:

item - the item

Returns:

true if the given item is filtered

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 filtered model using its FilterModel.Refresher.

Specified by:

refresh in interface FilterModel<Entity>

See Also:

• FilterModel.Refresher.refresh()

refreshThen

public void refreshThen(Consumer<Collection<Entity>> afterRefresh)

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.refreshFailedEvent() to listen for exceptions that happen during asynchronous refresh.

Specified by:

refreshThen in interface FilterModel<Entity>

Parameters:

afterRefresh - called after a successful refresh, may be null

See Also:

• FilterModel.Refresher.observer()
• FilterModel.Refresher.refreshEvent()
• FilterModel.Refresher.refreshFailedEvent()
• 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