Uses of Interface
is.codion.framework.domain.entity.attribute.ForeignKey

Packages that use ForeignKey

Package	Description
is.codion.framework.db	Package configuration values: EntityConnectionProvider.CLIENT_DOMAIN_TYPE EntityConnectionProvider.CLIENT_CONNECTION_TYPE
is.codion.framework.domain.entity	Package configuration values: EntityValidator.STRICT_VALIDATION Entities.VALIDATE_FOREIGN_KEYS Entities.STRICT_DESERIALIZATION AttributeDefinition.MAXIMUM_FRACTION_DIGITS AttributeDefinition.TIME_FORMAT AttributeDefinition.NUMBER_FORMAT_GROUPING AttributeDefinition.GROUPING_SEPARATOR AttributeDefinition.DECIMAL_SEPARATOR AttributeDefinition.USE_LEXICAL_STRING_COMPARATOR AttributeDefinition.DATE_TIME_FORMAT AttributeDefinition.DATE_FORMAT AttributeDefinition.DECIMAL_ROUNDING_MODE ForeignKeyDefinition.FOREIGN_KEY_REFERENCE_DEPTH
is.codion.framework.domain.entity.attribute	Attribute related classes.
is.codion.framework.domain.entity.condition	Provides a type-safe condition API for building SQL WHERE clauses programmatically.
is.codion.framework.domain.test
is.codion.framework.model	Package configuration values: EntityApplicationModel.USERNAME_PREFIX EntityApplicationModel.SAVE_DEFAULT_USERNAME EntityEditModel.POST_EDIT_EVENTS EntityEditModel.EntityEditor.PERSIST_FOREIGN_KEYS EntityQueryModel.LIMIT EntityTableModel.ON_INSERT EntityTableModel.HANDLE_EDIT_EVENTS EntityTableModel.ORDER_QUERY_BY_SORT_ORDER ForeignKeyModelLink.SET_CONDITION_ON_INSERT ForeignKeyModelLink.SET_VALUE_ON_INSERT ForeignKeyModelLink.REFRESH_ON_SELECTION ForeignKeyModelLink.CLEAR_CONDITION_ON_EMPTY_SELECTION ForeignKeyModelLink.CLEAR_VALUE_ON_EMPTY_SELECTION EntitySearchModel.DEFAULT_LIMIT
is.codion.framework.model.test
is.codion.swing.framework.model
is.codion.swing.framework.model.component	Package configuration values: EntityComboBoxModel.HANDLE_EDIT_EVENTS
is.codion.swing.framework.ui	Package configuration values: EntityApplicationPanel.HELP_URL EntityApplicationPanel.CONFIRM_EXIT EntityApplicationPanel.SHOW_STARTUP_DIALOG EntityApplicationPanel.CACHE_ENTITY_PANELS EntityApplicationPanel.USER_PREFERENCES_ENABLED EntityApplicationPanel.RESTORE_DEFAULT_PREFERENCES EntityApplicationPanel.CALL_SYSTEM_EXIT EntityEditComponentPanel.VALID_INDICATOR EntityEditComponentPanel.MODIFIED_INDICATOR EntityEditComponentPanel.DEFAULT_TEXT_FIELD_COLUMNS EntityEditPanel.Config.USE_SAVE_CAPTION EntityEditPanel.Config.USE_FOCUS_ACTIVATION EntityEditPanel.Config.INCLUDE_ENTITY_MENU EntityEditPanel.Config.MODIFIED_WARNING EntityPanel.Config.USE_KEYBOARD_NAVIGATION EntityPanel.Config.DISPOSE_EDIT_DIALOG_ON_ESCAPE EntityPanel.Config.INCLUDE_TOGGLE_EDIT_PANEL_CONTROL EntityPanel.Config.TOOLBAR_CONTROLS EntityPanel.Config.CONTROL_PANEL_CONSTRAINTS EntityPanel.Config.CONTROL_TOOLBAR_CONSTRAINTS EntityPanel.Config.WINDOW_TYPE EntityTablePanel.Config.EXCLUDE_HIDDEN_COLUMNS EntityTablePanel.Config.CONDITION_VIEW EntityTablePanel.Config.FILTER_VIEW EntityTablePanel.Config.SUMMARY_PANEL_VISIBLE EntityTablePanel.Config.INCLUDE_POPUP_MENU EntityTablePanel.Config.INCLUDE_ENTITY_MENU EntityTablePanel.Config.INCLUDE_QUERY_INSPECTOR EntityTablePanel.Config.INCLUDE_CLEAR_CONTROL EntityTablePanel.Config.INCLUDE_LIMIT_MENU EntityTablePanel.Config.REFRESH_BUTTON_VISIBLE EntityTablePanel.Config.COLUMN_SELECTION EntityTablePanel.Config.INCLUDE_CONDITIONS EntityTablePanel.Config.INCLUDE_FILTERS EntityTablePanel.Config.INCLUDE_SUMMARY EntityTablePanel.Config.REFRESH_PROGRESS_BAR ReferentialIntegrityErrorHandling.REFERENTIAL_INTEGRITY_ERROR_HANDLING TabbedApplicationLayout.TAB_PLACEMENT TabbedDetailLayout.INCLUDE_CONTROLS
is.codion.swing.framework.ui.component	Package configuration values: EntitySearchField.SEARCH_INDICATOR DefaultEditComponentFactory.DEFAULT_TEXT_FIELD_COLUMNS

Uses of ForeignKey in is.codion.framework.db

Methods in is.codion.framework.db that return types with arguments of type ForeignKey

Modifier and Type	Method	Description
Map<ForeignKey,Integer>	EntityConnection.Select.foreignKeyReferenceDepths()	Returns a map containing the number of levels of foreign key values to fetch per foreign key, with 0 meaning no referenced entities should be fetched, -1 no limit.

Methods in is.codion.framework.db with parameters of type ForeignKey

Modifier and Type	Method	Description
EntityConnection.Select.Builder	EntityConnection.Select.Builder.referenceDepth(ForeignKey foreignKey, int referenceDepth)	Returns the depth limit for a specific foreign key traversal.
OptionalInt	EntityConnection.Select.referenceDepth(ForeignKey foreignKey)	Returns the number of levels of foreign key values to fetch, with 0 meaning the referenced entity should not be fetched, -1 no limit and an empty Optional if the global limit should be used (EntityConnection.Select.referenceDepth()).

Uses of ForeignKey in is.codion.framework.domain.entity

Methods in is.codion.framework.domain.entity that return ForeignKey

Modifier and Type	Method	Description
<A> ForeignKey	EntityType.foreignKey(String name, Column<A> column, Column<A> referencedColumn)	Creates a new ForeignKey based on the given attributes.
<A, B> ForeignKey	EntityType.foreignKey(String name, Column<A> firstColumn, Column<A> firstReferencedColumn, Column<B> secondColumn, Column<B> secondReferencedColumn)	Creates a new ForeignKey based on the given columns.
<A, B, C> ForeignKey	EntityType.foreignKey(String name, Column<A> firstColumn, Column<A> firstReferencedColumn, Column<B> secondColumn, Column<B> secondReferencedColumn, Column<C> thirdColumn, Column<C> thirdReferencedColumn)	Creates a new ForeignKey based on the given columns.
ForeignKey	EntityType.foreignKey(String name, List<ForeignKey.Reference<?>> references)	Creates a new ForeignKey based on the given references.

Methods in is.codion.framework.domain.entity that return types with arguments of type ForeignKey

Modifier and Type	Method	Description
Collection<ForeignKey>	EntityDefinition.ForeignKeys.get()
Collection<ForeignKey>	EntityDefinition.ForeignKeys.get(EntityType referencedEntityType)	Returns the foreign keys referencing entities of the given type

Methods in is.codion.framework.domain.entity with parameters of type ForeignKey

Modifier and Type	Method	Description
ForeignKeyDefinition	EntityDefinition.ForeignKeys.definition(ForeignKey foreignKey)
@Nullable Entity	Entity.entity(ForeignKey foreignKey)	Returns the Entity instance referenced by the given ForeignKey.
@Nullable Entity.Key	Entity.key(ForeignKey foreignKey)	Returns the key referenced by the given ForeignKey, if the reference is null this method returns null.
static Collection<Entity.Key>	Entity.keys(ForeignKey foreignKey, Collection<Entity> entities)	Returns the non-null keys referenced by the given ForeignKey
EntityDefinition	EntityDefinition.ForeignKeys.referencedBy(ForeignKey foreignKey)	Returns the EntityDefinition of the entity referenced by the given foreign key.
boolean	EntityDefinition.ForeignKeys.updatable(ForeignKey foreignKey)
StringFactory.Builder	StringFactory.Builder.value(ForeignKey foreignKey, Attribute<?> attribute)	Adds the value mapped to the given attribute in the Entity instance mapped to the given foreign key to this StringFactory.Builder

Uses of ForeignKey in is.codion.framework.domain.entity.attribute

Methods in is.codion.framework.domain.entity.attribute that return ForeignKey

Modifier and Type	Method	Description
ForeignKey	ForeignKeyDefinition.attribute()
static ForeignKey	ForeignKey.foreignKey(EntityType entityType, String name, List<ForeignKey.Reference<?>> references)	Creates a new ForeignKey based on the given entityType and references.

Uses of ForeignKey in is.codion.framework.domain.entity.condition

Methods in is.codion.framework.domain.entity.condition with parameters of type ForeignKey

Modifier and Type	Method	Description
static ForeignKeyCondition.Factory	ForeignKeyCondition.factory(ForeignKey foreignKey)	Instantiates a new ForeignKeyCondition.Factory instance

Uses of ForeignKey in is.codion.framework.domain.test

Methods in is.codion.framework.domain.test with parameters of type ForeignKey

Modifier and Type	Method	Description
Optional<Entity>	DefaultEntityFactory.entity(ForeignKey foreignKey)
Optional<Entity>	DomainTest.EntityFactory.entity(ForeignKey foreignKey)	Initializes an Entity instance to reference via the given foreign key.

Uses of ForeignKey in is.codion.framework.model

Methods in is.codion.framework.model that return ForeignKey

Modifier and Type	Method	Description
ForeignKey	ForeignKeyModelLink.foreignKey()

Methods in is.codion.framework.model with parameters of type ForeignKey

Modifier and Type	Method	Description
void	EntityModel.DetailModels.add(M detailModel, ForeignKey foreignKey)	Adds the given detail model to this model, based on the given foreign key.
static <M extends EntityModel<M, E, T>, E extends EntityEditModel, T extends EntityTableModel<E>, B extends ForeignKeyModelLink.Builder<M, E, T, B>> ForeignKeyModelLink.Builder<M,E,T,B>	ForeignKeyModelLink.builder(M model, ForeignKey foreignKey)	Returns a new ForeignKeyModelLink.Builder instance.
protected ForeignKeyConditionModel	EntityConditionModelFactory.conditionModel(ForeignKey foreignKey)	Only called if EntityConditionModelFactory.include(ForeignKey) returns true
protected void	AbstractEntityEditModel.configureSearchModel(ForeignKey foreignKey, EntitySearchModel entitySearchModel)	Called when a EntitySearchModel is created in AbstractEntityEditModel.searchModel(ForeignKey).
protected EntitySearchModel	EntityConditionModelFactory.createEqualSearchModel(ForeignKey foreignKey)
protected EntitySearchModel	EntityConditionModelFactory.createInSearchModel(ForeignKey foreignKey)
EntitySearchModel	AbstractEntityEditModel.createSearchModel(ForeignKey foreignKey)
EntitySearchModel	EntityEditModel.createSearchModel(ForeignKey foreignKey)	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.
protected void	AbstractEntityEditModel.deleted(ForeignKey foreignKey, Collection<Entity> entities)	Called when entities of the type referenced by the given foreign key are deleted.
ForeignKeyConditionModel	EntityTableConditionModel.get(ForeignKey foreignKey)	Returns the ConditionModel associated with the given foreignKey.
protected boolean	EntityConditionModelFactory.include(ForeignKey foreignKey)
protected void	AbstractEntityEditModel.inserted(ForeignKey foreignKey, Collection<Entity> entities)	Called when entities of the type referenced by the given foreign key are inserted.
final EntitySearchModel	AbstractEntityEditModel.searchModel(ForeignKey foreignKey)
EntitySearchModel	EntityEditModel.searchModel(ForeignKey foreignKey)	Returns the EntitySearchModel associated with the given foreign key.
protected void	AbstractEntityEditModel.updated(ForeignKey foreignKey, Map<Entity.Key,Entity> entities)	Called when entities of the type referenced by the given foreign key have been updated.
protected void	AbstractEntityTableModel.updated(ForeignKey foreignKey, Map<Entity.Key,Entity> entities)	Called when entities of the type referenced by the given foreign key are updated

Uses of ForeignKey in is.codion.framework.model.test

Fields in is.codion.framework.model.test declared as ForeignKey

Modifier and Type	Field	Description
static final ForeignKey	TestDomain.Employee.DEPARTMENT_FK
static final ForeignKey	TestDomain.Detail.MASTER_FK
static final ForeignKey	TestDomain.Employee.MGR_FK

Uses of ForeignKey in is.codion.swing.framework.model

Methods in is.codion.swing.framework.model with parameters of type ForeignKey

Modifier and Type	Method	Description
final EntityComboBoxModel	SwingEntityEditModel.comboBoxModel(ForeignKey foreignKey)	Returns the EntityComboBoxModel associated with the given foreign key.
protected ForeignKeyConditionModel	SwingEntityConditionModelFactory.conditionModel(ForeignKey foreignKey)
protected void	SwingEntityEditModel.configureComboBoxModel(ForeignKey foreignKey, EntityComboBoxModel comboBoxModel)	Called when a EntityComboBoxModel is created by SwingEntityEditModel.comboBoxModel(ForeignKey).
EntityComboBoxModel	SwingEntityEditModel.createComboBoxModel(ForeignKey foreignKey)	Creates a new EntityComboBoxModel for the given foreign key, override to provide a custom EntityComboBoxModel implementation.
protected EntityComboBoxModel	SwingEntityConditionModelFactory.createEqualComboBoxModel(ForeignKey foreignKey)

Uses of ForeignKey in is.codion.swing.framework.model.component

Methods in is.codion.swing.framework.model.component with parameters of type ForeignKey

Modifier and Type	Method	Description
EntityComboBoxModel.ForeignKeyFilter	EntityComboBoxModel.Filter.get(ForeignKey foreignKey)	Returns a filter based on the given foreign key

Uses of ForeignKey in is.codion.swing.framework.ui

Methods in is.codion.swing.framework.ui with parameters of type ForeignKey

Modifier and Type	Method	Description
protected final EntityComboBox.Builder	EntityEditComponentPanel.createComboBox(ForeignKey foreignKey)	Creates a builder for foreign key combo boxes.
protected final EntityComboBoxPanel.Builder	EntityEditComponentPanel.createComboBoxPanel(ForeignKey foreignKey, Supplier<EntityEditPanel> editPanel)	Creates a builder for a foreign key combo box panel with optional buttons for adding and editing items.
protected final EntitySearchField.SingleSelectionBuilder	EntityEditComponentPanel.createSearchField(ForeignKey foreignKey)	Creates a builder for foreign key search fields.
protected final EntitySearchFieldPanel.SingleSelectionBuilder	EntityEditComponentPanel.createSearchFieldPanel(ForeignKey foreignKey, Supplier<EntityEditPanel> editPanel)	Creates a builder for a foreign key search field panel with optional buttons for adding and editing items.
protected final <B extends TextFieldBuilder<Entity, JTextField, B>> TextFieldBuilder<Entity,JTextField,B>	EntityEditComponentPanel.createTextField(ForeignKey foreignKey)	Creates a builder for a read-only, non-focusable foreign key text field.

Uses of ForeignKey in is.codion.swing.framework.ui.component

Methods in is.codion.swing.framework.ui.component with parameters of type ForeignKey

Modifier and Type	Method	Description
protected EntityComboBox.Builder	DefaultEditComponentFactory.comboBox(ForeignKey foreignKey, EntityDefinition entityDefinition, EntityComboBoxModel comboBoxModel)
EntityComboBox.Builder	EntityComponents.comboBox(ForeignKey foreignKey, EntityComboBoxModel comboBoxModel)	Creates a EntityComboBox.Builder based on the given foreign key.
EntityComboBoxPanel.Builder	EntityComponents.comboBoxPanel(ForeignKey foreignKey, EntityComboBoxModel comboBoxModel, Supplier<EntityEditPanel> editPanel)	Creates a EntityComboBoxPanel.Builder with optional buttons for adding and editing items.
protected EntitySearchField.SingleSelectionBuilder	DefaultEditComponentFactory.searchField(ForeignKey foreignKey, EntityDefinition entityDefinition, EntitySearchModel searchModel)
EntitySearchField.Builder.Factory	EntityComponents.searchField(ForeignKey foreignKey, EntitySearchModel searchModel)	Creates a EntitySearchField.Builder.Factory.
EntitySearchFieldPanel.Builder.Factory	EntityComponents.searchFieldPanel(ForeignKey foreignKey, EntitySearchModel searchModel, Supplier<EntityEditPanel> editPanel)	Creates a EntitySearchFieldPanel.Builder.Factory.
<B extends TextFieldBuilder<Entity, JTextField, B>> TextFieldBuilder<Entity,JTextField,B>	EntityComponents.textField(ForeignKey foreignKey)	Creates Entity text field builder for the given foreign key, read-only and non-focusable, displaying the String representation the Entity