Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityEditor.ComponentModels

All Known Subinterfaces:

SwingEntityEditor.SwingComponentModels

Enclosing interface:

EntityEditor<R extends EntityEditor<R>>

public static interface EntityEditor.ComponentModels

Provides models for editor components requiring database access.

Method Summary

Modifier and Type	Method	Description
default <T> FilterComboBoxModel<T>	comboBoxModel(Column<T> column, EntityConnectionProvider connectionProvider)	Creates a combo box model containing the current values of the given column.
default EntityComboBoxModel	comboBoxModel(ForeignKey foreignKey, EntityConnectionProvider connectionProvider)	Creates a new EntityComboBoxModel for the given foreign key, override to provide a custom EntityComboBoxModel implementation.
static <T> @Nullable T	createNullItem(Column<T> column)	Creates a null item for a combo box based on the given column, for use as the FilterComboBoxModel null item.
default EntitySearchModel	searchModel(ForeignKey foreignKey, EntityConnectionProvider connectionProvider)	Creates a EntitySearchModel for looking up entities of the type referenced by the given foreign key, using the search attributes defined for that entity type.

Method Details

searchModel

default EntitySearchModel searchModel(ForeignKey foreignKey,
 EntityConnectionProvider connectionProvider)

Creates a EntitySearchModel for looking up entities of the type referenced by the given foreign key, using the search attributes defined for that entity type.

Parameters:

foreignKey - the foreign key for which to create a EntitySearchModel

connectionProvider - the connection provider

Returns:

a new EntitySearchModel for looking up entities of the type referenced by the given foreign key attribute,

Throws:

IllegalStateException - in case no searchable attributes can be found for the entity type referenced by the given foreign key

See Also:

• EntityDefinition.Columns.searchable()

comboBoxModel

default EntityComboBoxModel comboBoxModel(ForeignKey foreignKey,
 EntityConnectionProvider connectionProvider)

Creates a new EntityComboBoxModel for the given foreign key, override to provide a custom EntityComboBoxModel implementation.

This default implementation returns a sorted EntityComboBoxModel using the default null item caption if the underlying attribute is nullable.

If the foreign key has select attributes defined, those are set in the combo box model.

Parameters:

foreignKey - the foreign key for which to create a EntityComboBoxModel

connectionProvider - the connection provider

Returns:

a EntityComboBoxModel for the given foreign key

See Also:

• FilterComboBoxModel.NULL_CAPTION
• EntityComboBoxModel.Builder.nullCaption(String)
• EntityComboBoxModel.Builder.includeNull(boolean)
• ValueAttributeDefinition.nullable()
• EntityComboBoxModel.Builder.attributes(Collection)
• ForeignKeyDefinition.attributes()

comboBoxModel

default <T> FilterComboBoxModel<T> comboBoxModel(Column<T> column,
 EntityConnectionProvider connectionProvider)

Creates a combo box model containing the current values of the given column. This default implementation returns a sorted FilterComboBoxModel using the default null item caption if the underlying column is nullable

Type Parameters:

T - the value type

Parameters:

column - the column

connectionProvider - the connection provider

Returns:

a combo box model based on the given column

See Also:

• FilterComboBoxModel.NULL_CAPTION

createNullItem

static <T> @Nullable T createNullItem(Column<T> column)

Creates a null item for a combo box based on the given column, for use as the FilterComboBoxModel null item. For interface-typed columns this is a proxy whose toString() returns FilterComboBoxModel.NULL_CAPTION; for other types null is returned, since no toString() override is required.

Type Parameters:

T - the value type

Parameters:

column - the column

Returns:

a null item for the given column, or null if the column value type is not an interface

See Also:

• FilterComboBoxModel.NULL_CAPTION