Module is.codion.framework.model
Package is.codion.framework.model
@NullMarked
package is.codion.framework.model
Package configuration values:
EntityApplicationModel.USER_PREFERENCESEntityApplicationModel.PREFERENCES_KEYEntityEditor.PUBLISH_PERSISTENCE_EVENTSEntityEditor.PERSIST_FOREIGN_KEYSEntityQueryModel.LIMITEntityTableModel.ON_INSERTEntityTableModel.ORDER_QUERYForeignKeyModelLink.SET_CONDITION_ON_INSERTForeignKeyModelLink.SET_VALUE_ON_INSERTForeignKeyModelLink.REFRESH_ON_SELECTIONForeignKeyModelLink.CLEAR_CONDITION_ON_EMPTY_SELECTIONForeignKeyModelLink.CLEAR_VALUE_ON_EMPTY_SELECTIONEntitySearchModel.DEFAULT_LIMITEntitySearchModel.PERSISTENCE_AWARE
-
ClassDescriptionAbstractEntityTableModel<M extends EntityModel<M,
E, T, R>, E extends EntityEditModel<M, E, T, R>, T extends EntityTableModel<M, E, T, R>, R extends EntityEditor<R>> An abstractEntityTableModelimplementationAbstractEntityTableModel.AbstractEntityRowEditor<R extends EntityEditor<R>>An abstractEntityTableModel.EntityRowEditorimplementation.A builder for aColumnConditionModelDefaultEntityApplicationModel<M extends EntityModel<M,E, T, R>, E extends EntityEditModel<M, E, T, R>, T extends EntityTableModel<M, E, T, R>, R extends EntityEditor<R>> A central application model class.DefaultEntityEditModel<M extends EntityModel<M,E, T, R>, E extends EntityEditModel<M, E, T, R>, T extends EntityTableModel<M, E, T, R>, R extends EntityEditor<R>> A defaultEntityEditModelimplementationDefaultEntityEditor<R extends EntityEditor<R>>A defaultEntityEditorimplementation.DefaultEntityModel<M extends EntityModel<M,E, T, R>, E extends EntityEditModel<M, E, T, R>, T extends EntityTableModel<M, E, T, R>, R extends EntityEditor<R>> A defaultEntityModelimplementation.Describes how a detailEntityEditorrelates to a master editor for the purposes of one-to-one entity composition.Builder input describing how to prepare a detail entity prior to insertion, given the freshly-inserted master entity.EditorLink.Builder<R extends EntityEditor<R>>Builds anEditorLink.The first step — binds the detail editor that the link will describe.EditorLink.Builder.ForeignKeyNameStep<R extends EntityEditor<R>>The second step — choose whether the link is foreign-key based or named.EditorLink.Builder.LoadStep<R extends EntityEditor<R>>Required afterEditorLink.Builder.ForeignKeyNameStep.name(String)— supplies the load source for the detail entity, expressed as aEditorLink.DetailCondition,EditorLink.DetailSelectorEditorLink.DetailEntity.Builder input describing theConditionused to load the detail row for a given master.Builder input describing how to load the detail entity for a given master — the lowest-level escape hatch when neither aEditorLink.DetailConditionnor aEditorLink.DetailSelectsuffices (e.g.Builder input describing theEntityConnection.Selectused to load the detail row for a given master.EntityApplicationModel<M extends EntityModel<M,E, T, R>, E extends EntityEditModel<M, E, T, R>, T extends EntityTableModel<M, E, T, R>, R extends EntityEditor<R>> A central application model class.EntityApplicationModel.EntityModels<M extends EntityModel<M,E, T, R>, E extends EntityEditModel<M, E, T, R>, T extends EntityTableModel<M, E, T, R>, R extends EntityEditor<R>> Manages theEntityModels for aEntityApplicationModelUseEntityConditionModel.builder()for instance.Manages the additional WHERE and HAVING conditions.Builds anEntityConditionModelThe second step in building anEntityConditionModelThe first step in building anEntityConditionModelManages an additional condition supplier.Indicates if the condition has changed since the last call toEntityConditionModel.Modified.reset()A defaultConditionModelfactory for Entity based condition models.EntityEditModel<M extends EntityModel<M,E, T, R>, E extends EntityEditModel<M, E, T, R>, T extends EntityTableModel<M, E, T, R>, R extends EntityEditor<R>> Specifies a class for editing anEntityinstance.EntityEditor<R extends EntityEditor<R>>Provides edit access to an underlying entity.Provides models for editor components requiring database access.EntityEditor.DetailEditors<R extends EntityEditor<R>>Manages detail editors for one-to-one entity composition within anEntityEditor.Provides access to the entity instance being edited.Manages theEntityPersistenceused by this editorProvides factory methods for creatingEntityEditor.PersistTaskandEntityEditor.RefreshTaskinstances.Provides edit access to anAttributevalue in the underlying entity being edited.Provides access to the underlying values.Indicates whether the active entity exists in the database.Indicates whether the active entity is modified, that is, exists and has one or more modified attribute values.Provides persistence event observers for the editorEvents triggered after entities are persisted.Events triggered before entities are persisted.Represents a task for persisting entities, inserting, updating or deleting, split up for use with a background thread.The task resultIndicates whether an entity is present, according to the predicate specified viaEntityEditor.Present.predicate().A task for refreshing the active entity.The task resultManages theEntitySearchModels used by aEntityEditModelThe editor settings.Builds aEntityExportSpecifies the entities to exportSpecifies the entity typeSpecifies the export attributesSpecifies the export outputAttribute settings for exporting entity data with denormalized foreign key references.EntityModel<M extends EntityModel<M,E, T, R>, E extends EntityEditModel<M, E, T, R>, T extends EntityTableModel<M, E, T, R>, R extends EntityEditor<R>> Specifies a class responsible for, among other things, coordinating aEntityEditModeland anEntityTableModel.EntityModel.DetailModels<M extends EntityModel<M,E, T, R>, E extends EntityEditModel<M, E, T, R>, T extends EntityTableModel<M, E, T, R>, R extends EntityEditor<R>> Manages the detail models for aEntityModelResponsible for persisting entities to the database.Provides entities based on query conditions.Manages the attributes to include and exclude when querying.Searches for entities based on a search text and set of String based condition columns.A builder for aEntitySearchModel.Provides aEntitySearchModel.BuilderManages the search strings and provides search results.Controls the selectionColumn search settingsEntityTableModel<M extends EntityModel<M,E, T, R>, E extends EntityEditModel<M, E, T, R>, T extends EntityTableModel<M, E, T, R>, R extends EntityEditor<R>> Specifies a table model containingEntityinstances.Controls table model editingSpecifies whether an attribute is editable for a given entity instance.Defines the actions a table model can perform when entities are inserted via the associated edit modelA default foreign key condition model usingEntitySearchModelfor both theOperator.EQUALandOperator.INoperands.A builder for aForeignKeyConditionModelAnEditorLinkbacked by aForeignKeyon the detail entity pointing to the master.ForeignKeyEditorLink.Builder<R extends EntityEditor<R>>Builds aForeignKeyEditorLink.Represents a link between two entity models based on a foreign key.ForeignKeyModelLink.Builder<B extends ForeignKeyModelLink.Builder<B>>Builds aForeignKeyModelLinkRepresents a link between two entity models.ModelLink.Builder<B extends ModelLink.Builder<B>>Builds aModelLinkNotified on delete.Notified on insert.Notified on update.