is.codion.swing.framework.model

Class EntityComboBoxModel

java.lang.Object

is.codion.swing.common.model.component.combobox.FilteredComboBoxModel<Entity>

is.codion.swing.framework.model.EntityComboBoxModel

All Implemented Interfaces:

FilteredModel<Entity>, ComboBoxModel<Entity>, ListModel<Entity>

public class EntityComboBoxModel
extends FilteredComboBoxModel<Entity>

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

Nested Class Summary

Nested classes/interfaces inherited from class is.codion.swing.common.model.component.combobox.FilteredComboBoxModel

FilteredComboBoxModel.ItemFinder<T,V>

Field Summary

Fields inherited from class is.codion.swing.common.model.component.combobox.FilteredComboBoxModel

COMBO_BOX_NULL_CAPTION

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

ASYNC_REFRESH

Constructor Summary

Constructors

Constructor and Description
EntityComboBoxModel(EntityType entityType, EntityConnectionProvider connectionProvider)

Method Summary

Modifier and Type	Method and Description
EntityConnectionProvider	connectionProvider()
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.
Optional<Entity>	entity(Key primaryKey)
EntityType	entityType()
void	forceRefresh() Forces a refresh of this model, disregarding the staticData directive
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 FilteredComboBoxModel.setIncludeCondition(Predicate).
Collection<Key>	getForeignKeyFilterKeys(ForeignKey foreignKey)
OrderBy	getOrderBy()
Collection<Attribute<?>>	getSelectAttributes()
Supplier<Condition>	getSelectConditionSupplier()
boolean	isListenToEditEvents() True if this combo box model responds to entity edit events, by adding inserted items, updating any updated items and removing deleted ones.
boolean	isStaticData()
boolean	isStrictForeignKeyFiltering()
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
protected Collection<Entity>	performQuery() Retrieves the entities to present in this EntityComboBoxModel, taking into account the select condition supplier (getSelectConditionSupplier()) as well as the select attributes (getSelectAttributes()) and order by clause (getOrderBy().
protected Collection<Entity>	refreshItems()
void	selectByKey(Key primaryKey) Selects the entity with the given primary key, if the entity is not available in the model this method returns silently without changing the selection
void	setForeignKeyFilterKeys(ForeignKey foreignKey, Collection<Key> keys) Filters this combo box model so that only items referencing the given keys via the given foreign key are shown.
void	setListenToEditEvents(boolean listenToEditEvents) Set to true if this combo box model should respond to entity edit events, by adding inserted items, updating any updated items and removing deleted ones.
void	setNullCaption(String caption) Enables the null item and sets the null item caption.
void	setOrderBy(OrderBy orderBy) Sets the order by to use when selecting entities for this model.
void	setSelectAttributes(Collection<Attribute<?>> selectAttributes) Specifies the attributes to include when selecting the entities to populate this model with.
void	setSelectConditionSupplier(Supplier<Condition> selectConditionSupplier) Sets the condition provider to use when querying data, set to null to fetch all underlying entities.
void	setStaticData(boolean staticData) Specifies whether this models data should be considered static, that is, only fetched once.
void	setStrictForeignKeyFiltering(boolean strictForeignKeyFiltering) Specifies whether foreign key filtering should be strict or not.
String	toString()
protected Entity	translateSelectionItem(Object item)

Methods inherited from class is.codion.swing.common.model.component.combobox.FilteredComboBoxModel

addFilterListener, addItem, addListDataListener, addRefreshFailedListener, addRefreshListener, addSelectionListener, allowSelectionChange, clear, containsItem, createSelectorValue, filteredItemCount, filteredItems, filterItems, fireContentsChanged, getElementAt, getIncludeCondition, getSelectedItem, getSize, getSortComparator, isAsyncRefresh, isCleared, isFiltered, isFilterSelectedItem, isIncludeNull, isNullSelected, isSelectionEmpty, isVisible, items, refresh, refreshingObserver, refreshThen, removeFilterListener, removeItem, removeListDataListener, removeRefreshFailedListener, removeRefreshListener, removeSelectionListener, replaceItem, selectedValue, setAsyncRefresh, setFilterSelectedItem, setIncludeCondition, setIncludeNull, setItems, setNullItem, setSelectedItem, setSortComparator, visibleItemCount, visibleItems

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityComboBoxModel

public EntityComboBoxModel(EntityType entityType,
                           EntityConnectionProvider connectionProvider)

Parameters:

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

connectionProvider - a EntityConnectionProvider instance

Method Detail

toString

public final String toString()

Overrides:

toString in class Object

connectionProvider

public final EntityConnectionProvider connectionProvider()

Returns:

the connection provider used by this combo box model

entityType

public final EntityType entityType()

Returns:

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

forceRefresh

public final void forceRefresh()

Forces a refresh of this model, disregarding the staticData directive

See Also:

setStaticData(boolean)

isStaticData

public final boolean isStaticData()

Returns:

true if the data for this model should only be fetched once

See Also:

forceRefresh()

setStaticData

public final void setStaticData(boolean staticData)

Specifies whether this models data should be considered static, that is, only fetched once. Note that forceRefresh() disregards this directive.

Parameters:

staticData - the value

setNullCaption

public final void setNullCaption(String caption)

Enables the null item and sets the null item caption.

Parameters:

caption - the null item caption

See Also:

FilteredComboBoxModel.setIncludeNull(boolean), FilteredComboBoxModel.setNullItem(Object)

setSelectAttributes

public final void setSelectAttributes(Collection<Attribute<?>> selectAttributes)

Specifies 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.

Parameters:

selectAttributes - the attributes to select, an empty Collection for all available attributes

Throws:

IllegalArgumentException - in case any of the given attributes is not part of the underlying entity type

getSelectAttributes

public final Collection<Attribute<?>> getSelectAttributes()

Returns:

an unmodifiable view of the attributes to include when selecting entities for this model, an empty Collection indicates all available attributes

isListenToEditEvents

public final boolean isListenToEditEvents()

True if this combo box model responds to entity edit events, by adding inserted items, updating any updated items and removing deleted ones.

Returns:

true if this combo box model listens edit events

See Also:

EntityEditEvents

setListenToEditEvents

public final void setListenToEditEvents(boolean listenToEditEvents)

Set to true if this combo box model should respond to entity edit events, by adding inserted items, updating any updated items and removing deleted ones.

Parameters:

listenToEditEvents - if true then this model listens to entity edit events

See Also:

EntityEditEvents

entity

public final Optional<Entity> 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

selectByKey

public final void selectByKey(Key primaryKey)

Selects the entity with the given primary key, 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

setSelectConditionSupplier

public final void setSelectConditionSupplier(Supplier<Condition> selectConditionSupplier)

Sets the condition provider to use when querying data, set to null to fetch all underlying entities.

Parameters:

selectConditionSupplier - the condition supplier

getSelectConditionSupplier

public final Supplier<Condition> getSelectConditionSupplier()

Returns:

the select condition supplier, null if none is specified

setOrderBy

public final void setOrderBy(OrderBy orderBy)

Sets 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 (FilteredComboBoxModel.setSortComparator(Comparator)

Parameters:

orderBy - the order by

See Also:

FilteredComboBoxModel.setSortComparator(Comparator)

getOrderBy

public final OrderBy getOrderBy()

Returns:

the order by, possibly null

foreignKeyIncludeCondition

public final 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 FilteredComboBoxModel.setIncludeCondition(Predicate).

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

Returns:

the Predicate based on the foreign key filter entities

See Also:

setForeignKeyFilterKeys(ForeignKey, Collection)

setForeignKeyFilterKeys

public final void setForeignKeyFilterKeys(ForeignKey foreignKey,
                                          Collection<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, null or empty for none

getForeignKeyFilterKeys

public final Collection<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

setStrictForeignKeyFiltering

public final void setStrictForeignKeyFiltering(boolean strictForeignKeyFiltering)

Specifies 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.

Parameters:

strictForeignKeyFiltering - the value

See Also:

setForeignKeyFilterKeys(ForeignKey, Collection)

isStrictForeignKeyFiltering

public final boolean isStrictForeignKeyFiltering()

Returns:

true if strict foreign key filtering is enabled

createForeignKeyFilterComboBoxModel

public final 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 final 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 final 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 final 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 final <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

translateSelectionItem

protected final Entity translateSelectionItem(Object item)

Overrides:

translateSelectionItem in class FilteredComboBoxModel<Entity>

Parameters:

item - the item to be selected

Returns:

the actual item to select

refreshItems

protected final Collection<Entity> refreshItems()

Overrides:

refreshItems in class FilteredComboBoxModel<Entity>

Returns:

a Collection containing the items to be shown in this combo box model, by default this simply returns the items currently contained in the model, both filtered and visible, excluding the null value.

performQuery

protected Collection<Entity> performQuery()

Retrieves the entities to present in this EntityComboBoxModel, taking into account the select condition supplier (getSelectConditionSupplier()) as well as the select attributes (getSelectAttributes()) and order by clause (getOrderBy().

Returns:

the entities to present in this EntityComboBoxModel

See Also:

getSelectConditionSupplier(), getSelectAttributes(), getOrderBy()