Module is.codion.framework.model

Package is.codion.framework.model

Class AbstractEntityComboBoxModelBuilder<B extends EntityComboBoxModel.Builder<B>>

java.lang.Object

is.codion.framework.model.AbstractEntityComboBoxModelBuilder<B>

Type Parameters:

B - the builder type

All Implemented Interfaces:

EntityComboBoxModel.Builder<B>

public abstract class AbstractEntityComboBoxModelBuilder<B extends EntityComboBoxModel.Builder<B>>
extends Object
implements EntityComboBoxModel.Builder<B>

A base class for EntityComboBoxModel.Builder implementations. A toolkit builder extends this class, adding its own options and overriding build() to wrap the EntityComboBoxModel in its own model.

Nested Class Summary

Nested classes/interfaces inherited from interface is.codion.framework.model.EntityComboBoxModel.Builder

EntityComboBoxModel.Builder.ConnectionStep, EntityComboBoxModel.Builder.EntityTypeStep

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityComboBoxModelBuilder(ForeignKey foreignKey, EntityConnection connection)	Configures the builder according to the given foreign key, including null if it is nullable and specifying the attributes to include if defined.
protected	AbstractEntityComboBoxModelBuilder(EntityType entityType, EntityConnection connection)

Method Summary

Modifier and Type	Method	Description
final B	attributes(Collection<Attribute<?>> attributes)	Specifies the attributes to include when selecting the entities to populate this model with.
EntityComboBoxModel	build()
final B	comparator(@Nullable Comparator<Entity> comparator)	Note that this comparator is not used if EntityComboBoxModel.Builder.orderBy(OrderBy) has been specified.
final B	condition(@Nullable Supplier<Condition> condition)	If condition is null, the default condition, specifying all underlying entities is used.
final B	filter(ForeignKey foreignKey, EntityComboBoxModel filterModel)	Links the given combo box model representing foreign key entities to this combo box model so that selection in the foreign key model filters this model.
final B	filterSelected(boolean filterSelected)	Specifies whether filtering the model affects the currently selected item.
final B	includeNull(boolean includeNull)
final B	nullCaption(@Nullable String nullCaption)	Enables the null item and sets the null item caption.
final B	onSelectedItem(Consumer<@Nullable Entity> item)
final B	orderBy(@Nullable OrderBy orderBy)	Specifies the OrderBy to use when selecting entities for this model.
final B	persistenceAware(boolean persistenceAware)
final B	refresh(boolean refresh)
final B	select(@Nullable Entity entity)
protected final B	self()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractEntityComboBoxModelBuilder

protected AbstractEntityComboBoxModelBuilder(EntityType entityType,
 EntityConnection connection)

Parameters:

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

connection - the connection

AbstractEntityComboBoxModelBuilder

protected AbstractEntityComboBoxModelBuilder(ForeignKey foreignKey,
 EntityConnection connection)

Configures the builder according to the given foreign key, including null if it is nullable and specifying the attributes to include if defined.

Parameters:

foreignKey - the foreign key which referenced entity type the combo box model should represent

connection - the connection

See Also:

• EntityComboBoxModel.Builder.EntityTypeStep.foreignKey(ForeignKey)

Method Details

orderBy

public final B orderBy(@Nullable OrderBy orderBy)

Description copied from interface: EntityComboBoxModel.Builder

Specifies the OrderBy to use when selecting entities for this model.

Note that when orderBy is specified the model is left unsorted and the database order is used. That order is retained across refreshes, but only survives until the first foreign key filter transition, after which re-included items are appended (in an unsorted model) rather than restored to their original position.

Specified by:

orderBy in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

orderBy - the OrderBy to use when selecting

Returns:

this builder instance

comparator

public final B comparator(@Nullable Comparator<Entity> comparator)

Description copied from interface: EntityComboBoxModel.Builder

Note that this comparator is not used if EntityComboBoxModel.Builder.orderBy(OrderBy) has been specified.

Specified by:

comparator in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

comparator - the comparator to use, null for unsorted

Returns:

this builder instance

condition

public final B condition(@Nullable Supplier<Condition> condition)

Description copied from interface: EntityComboBoxModel.Builder

If condition is null, the default condition, specifying all underlying entities is used.

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

Specified by:

condition in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

condition - the condition supplier to use when querying data, may not return null

Returns:

this builder instance

attributes

public final B attributes(Collection<Attribute<?>> attributes)

Description copied from interface: EntityComboBoxModel.Builder

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.

Specified by:

attributes in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

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

Returns:

this builder instance

includeNull

public final B includeNull(boolean includeNull)

Specified by:

includeNull in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

includeNull - if true then the null item is enabled using the default null item caption (FilterComboBoxModel.NULL_CAPTION)

Returns:

this builder instance

See Also:

• FilterComboBoxModel.NULL_CAPTION

nullCaption

public final B nullCaption(@Nullable String nullCaption)

Description copied from interface: EntityComboBoxModel.Builder

Enables the null item and sets the null item caption.

Specified by:

nullCaption in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

nullCaption - the null item caption

Returns:

this builder instance

select

public final B select(@Nullable Entity entity)

Specified by:

select in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

entity - the entity to select initially

Returns:

this builder

persistenceAware

public final B persistenceAware(boolean persistenceAware)

Specified by:

persistenceAware in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

persistenceAware - controls whether this combo box model should respond to entity persistence events, by adding inserted items, updating any updated items and removing deleted ones

Returns:

this builder instance

See Also:

• EntityComboBoxModel.PERSISTENCE_AWARE
• PersistenceEvents

filterSelected

public final B filterSelected(boolean filterSelected)

Description copied from interface: EntityComboBoxModel.Builder

Specifies whether filtering the model affects the currently selected item. If true, the selection is cleared when the selected item is filtered from the model, otherwise the selected item can potentially represent a value which is not currently included in the model This is false by default.

Specified by:

filterSelected in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

filterSelected - if true then the selected item is cleared when filtered

Returns:

this builder instance

See Also:

• FilterModel.IncludedItems.predicate()

filter

public final B filter(ForeignKey foreignKey,
 EntityComboBoxModel filterModel)

Description copied from interface: EntityComboBoxModel.Builder

Links the given combo box model representing foreign key entities to this combo box model so that selection in the foreign key model filters this model. Note that filterModel is automatically refreshed each time this combo box model is refreshed.

Specified by:

filter in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

foreignKey - the foreign key

filterModel - the combo box model filtering this model

Returns:

this builder instance

See Also:

• EntityComboBoxModel.ForeignKeyFilter.link(EntityComboBoxModel)

onSelectedItem

public final B onSelectedItem(Consumer<@Nullable Entity> item)

Specified by:

onSelectedItem in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

item - receives the selected item, note that this item may be null

Returns:

this builder instance

refresh

public final B refresh(boolean refresh)

Specified by:

refresh in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Parameters:

refresh - true if the model items should be refreshed on initialization, false by default

Returns:

this builder instance

build

public EntityComboBoxModel build()

Specified by:

build in interface EntityComboBoxModel.Builder<B extends EntityComboBoxModel.Builder<B>>

Returns:

a new EntityComboBoxModel instance

self

protected final B self()

Returns:

this builder instance