Module is.codion.framework.model
Package is.codion.framework.model

Interface EntityEditModel

    • Field Detail

      • PERSIST_FOREIGN_KEY_VALUES

        static final PropertyValue<Boolean> PERSIST_FOREIGN_KEY_VALUES
        Specifies whether foreign key values should persist when the UI is cleared or be reset to null
        Value type: Boolean
        Default value: true

      • WARN_ABOUT_UNSAVED_DATA

        static final PropertyValue<Boolean> WARN_ABOUT_UNSAVED_DATA
        Indicates whether the application should ask for confirmation when exiting if some data is unsaved
        and whether it should warn when unsaved data is about to be lost, i.e. due to selection changes. Value type: Boolean
        Default value: false

      • POST_EDIT_EVENTS

        static final PropertyValue<Boolean> POST_EDIT_EVENTS
        Specifies whether edit models post their insert, update and delete events to EntityEditEvents
        Value type: Boolean
        Default value: true

      • INITIALIZE_FOREIGN_KEY_TO_NULL

        static final PropertyValue<Boolean> INITIALIZE_FOREIGN_KEY_TO_NULL
        Specifies whether edit models set the master foreign key to null when initialized with a null foreign key value via initialize(ForeignKey, Entity)
        Value type: Boolean
        Default value: false

    • Method Detail

      • entityType

        EntityType entityType()
        Returns:
        the type of the entity this edit model is based on

      • connectionProvider

        EntityConnectionProvider connectionProvider()
        Returns:
        the connection provider used by this edit model

      • setEntity

        void setEntity​(Entity entity)
        Copies the values from the given Entity into the underlying Entity being edited by this edit model. If entity is null the effect is the same as calling setDefaultValues().
        Parameters:
        entity - the entity
        See Also:
        setDefaultValues()

      • refreshEntity

        void refreshEntity()
        Refreshes the active Entity from the database, discarding all changes. If the active Entity is new then calling this method has no effect.

      • entityCopy

        Entity entityCopy()
        Returns:
        a deep copy of the active entity
        See Also:
        Entity.copy()

      • isEntityNew

        boolean isEntityNew()
        Returns true if the active entity is new or false if it represents a row already persisted. By default, an entity is new if either its primary key or the original primary key are null. Basing the result of this function on a database query is not recommended since it is called very frequently, as in, every time a property value changes.
        Returns:
        true if the active entity is new, that is, does not represent a persistent row
        See Also:
        primaryKeyNullObserver(), Key.isNull()

      • containsUnsavedData

        boolean containsUnsavedData()
        Returns true if an entity is selected and a value has been modified or if the entity is new and one or more non-default values have been entered
        Returns:
        true if this edit model contains unsaved data
        See Also:
        WARN_ABOUT_UNSAVED_DATA

      • isNull

        boolean isNull​(Attribute<?> attribute)
        Parameters:
        attribute - the attribute
        Returns:
        true if the value of the given property is null

      • isNotNull

        boolean isNotNull​(Attribute<?> attribute)
        Parameters:
        attribute - the attribute
        Returns:
        true if the value of the given property is not null

      • isNullable

        boolean isNullable​(Attribute<?> attribute)
        Parameters:
        attribute - the attribute
        Returns:
        true if this value is allowed to be null in the underlying entity

      • put

        <T> void put​(Attribute<T> attribute,
             T value)
        Sets the given value in the underlying Entity
        Type Parameters:
        T - the value type
        Parameters:
        attribute - the attribute to associate the given value with
        value - the value to associate with the given property

      • remove

        <T> T remove​(Attribute<T> attribute)
        Removes the given value from the underlying Entity
        Type Parameters:
        T - the value type
        Parameters:
        attribute - the attribute
        Returns:
        the value, if any

      • get

        <T> T get​(Attribute<T> attribute)
        Returns the value associated with the given property
        Type Parameters:
        T - the value type
        Parameters:
        attribute - the attribute
        Returns:
        the value associated with the given property

      • getOptional

        <T> Optional<T> getOptional​(Attribute<T> attribute)
        Returns the value associated with the given property
        Type Parameters:
        T - the value type
        Parameters:
        attribute - the attribute
        Returns:
        the value associated with the given property, an empty Optional in case it is null

      • referencedEntity

        Entity referencedEntity​(ForeignKey foreignKey)
        Returns the value associated with the given foreign key.
        Parameters:
        foreignKey - the foreign key
        Returns:
        the value assuming it is an Entity
        Throws:
        ClassCastException - in case the value was not an Entity

      • value

        <T> Value<T> value​(Attribute<T> attribute)
        Returns a Value based on attribute in this edit model, note that subsequent calls for the same attribute return the same value instance.
        Type Parameters:
        T - the value type
        Parameters:
        attribute - the attribute
        Returns:
        a Value based on the given edit model value

      • entities

        Entities entities()
        Returns:
        the underlying domain entities

      • entityDefinition

        EntityDefinition entityDefinition()
        Returns:
        the definition of the underlying entity

      • isWarnAboutUnsavedData

        boolean isWarnAboutUnsavedData()
        Returns:
        true if this model warns about unsaved data
        See Also:
        WARN_ABOUT_UNSAVED_DATA

      • setWarnAboutUnsavedData

        void setWarnAboutUnsavedData​(boolean warnAboutUnsavedData)
        Parameters:
        warnAboutUnsavedData - if true then this model warns about unsaved data
        See Also:
        WARN_ABOUT_UNSAVED_DATA

      • isInsertEnabled

        boolean isInsertEnabled()
        Returns:
        true if this model should enable records to be inserted

      • setInsertEnabled

        void setInsertEnabled​(boolean insertEnabled)
        Parameters:
        insertEnabled - true if this model should enable inserts

      • isUpdateEnabled

        boolean isUpdateEnabled()
        Returns:
        true if this model should enable records to be updated

      • setUpdateEnabled

        void setUpdateEnabled​(boolean updateEnabled)
        Parameters:
        updateEnabled - true if this model should enable records to be updated

      • isDeleteEnabled

        boolean isDeleteEnabled()
        Returns:
        true if this model should allow records to be deleted

      • setDeleteEnabled

        void setDeleteEnabled​(boolean deleteEnabled)
        Parameters:
        deleteEnabled - true if this model should enable records to be deleted

      • isPostEditEvents

        boolean isPostEditEvents()
        Returns true if this edit model posts its insert, update and delete events on the EntityEditEvents event bus
        Returns:
        true if insert, update and delete events are posted on the edit event bus

      • setPostEditEvents

        void setPostEditEvents​(boolean postEditEvents)
        Set to true if this edit model should post its insert, update and delete events on the EntityEditEvents event bus
        Parameters:
        postEditEvents - true if edit events should be posted

      • isInitializeForeignKeyToNull

        boolean isInitializeForeignKeyToNull()
        Returns true if this edit model sets the foreign key to null when initialized with a null value.
        Returns:
        true if initialization with a null value sets the foreign key to null
        See Also:
        initialize(ForeignKey, Entity)

      • setInitializeForeignKeyToNull

        void setInitializeForeignKeyToNull​(boolean initializeForeignKeyToNull)
        Set to true if this edit model should set the foreign key value to null when initialized with a null value.
        Parameters:
        initializeForeignKeyToNull - true if initialization with a null value should set the foreign key to null
        See Also:
        initialize(ForeignKey, Entity)

      • createForeignKeySearchModel

        EntitySearchModel createForeignKeySearchModel​(ForeignKey foreignKey)
        Creates a EntitySearchModel for looking up entities referenced by the given foreign key property, using the search properties defined for that entity type, or if none are defined all string based searchable properties in that entity.
        Parameters:
        foreignKey - the foreign key for which to create a EntitySearchModel
        Returns:
        a EntitySearchModel for looking up entities of the type referenced by the given foreign key attribute,
        Throws:
        IllegalStateException - in case no searchable properties can be found for the entity type referenced by the given foreign key property

      • containsSearchModel

        boolean containsSearchModel​(ForeignKey foreignKey)
        Returns true if this edit model contains a EntitySearchModel for the given foreign key
        Parameters:
        foreignKey - the foreign key
        Returns:
        true if a EntitySearchModel has been initialized for the given foreign key

      • foreignKeySearchModel

        EntitySearchModel foreignKeySearchModel​(ForeignKey foreignKey)
        Parameters:
        foreignKey - the foreign key for which to retrieve the EntitySearchModel
        Returns:
        the EntitySearchModel associated with the foreignKey, if no search model has been initialized for the given foreign key, a new one is created, associated with the foreign key and returned.

      • setDefaultValueSupplier

        <T> void setDefaultValueSupplier​(Attribute<T> attribute,
                                 Supplier<T> valueProvider)
        Sets the default value provider for the given attribute. Used when the underlying value is not persistent. Use setEntity(Entity) with a null parameter to populate the model with the default values.
        Type Parameters:
        T - the value type
        Parameters:
        attribute - the attribute
        valueProvider - the value provider
        See Also:
        isPersistValue(Attribute), setPersistValue(Attribute, boolean)

      • setModifiedSupplier

        void setModifiedSupplier​(Supplier<Boolean> modifiedSupplier)
        Sets the 'modified' supplier for this edit model, which is responsible for providing the modified state of the underlying entity. The default supplier returns Entity.isModified().
        Parameters:
        modifiedSupplier - specifies whether the underlying entity is modified
        See Also:
        Entity.isModified(), modifiedObserver()

      • isPersistValue

        boolean isPersistValue​(Attribute<?> attribute)
        Returns true if the last available value for this attribute should be used when initializing a default entity. Override for selective reset of field values when the model is cleared. For foreign key attribute values this method by default returns the value of the attribute PERSIST_FOREIGN_KEY_VALUES.
        Parameters:
        attribute - the attribute
        Returns:
        true if the given field value should be reset when the model is cleared
        See Also:
        PERSIST_FOREIGN_KEY_VALUES

      • setPersistValue

        void setPersistValue​(Attribute<?> attribute,
                     boolean persistValue)
        Specifies whether the value for the given attribute should be persisted when the model is cleared.
        Parameters:
        attribute - the attribute
        persistValue - true if this model should persist the value of the given attribute on clear
        See Also:
        PERSIST_FOREIGN_KEY_VALUES

      • refresh

        void refresh()
        Refreshes all data models used by this edit model, combo box models f.ex.

      • clear

        void clear()
        Clears all data models used by this edit model.

      • addForeignKeyValues

        void addForeignKeyValues​(List<Entity> entities)
        Adds the inserted entities to all foreign key models based on that entity type
        Parameters:
        entities - the values

      • removeForeignKeyValues

        void removeForeignKeyValues​(List<Entity> entities)
        Removes the given entities from all foreign key models based on that entity type and clears any foreign key values referencing them.
        Parameters:
        entities - the values

      • replaceForeignKeyValues

        void replaceForeignKeyValues​(Collection<Entity> entities)
        For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from values, useful when property values have been changed in the referenced entity that must be reflected in the edit model.
        Parameters:
        entities - the foreign key entities

      • setForeignKeyValues

        void setForeignKeyValues​(Collection<Entity> entities)
        Sets the values in the given list as the values for the respective foreign keys, uses the first value found for each entity type in case of multiple entities of that type
        Parameters:
        entities - the entities

      • initialize

        void initialize​(ForeignKey foreignKey,
                Entity foreignKeyValue)
        Initializes this EntityEditModel according to the given foreign key value by setting the foreign key to the given value. Note that this only happens if the current entity is new.
        Parameters:
        foreignKey - the foreign key
        foreignKeyValue - the foreign key value, null for none
        See Also:
        setInitializeForeignKeyToNull(boolean), isEntityNew()

      • validate

        void validate​(Attribute<?> attribute)
       throws ValidationException
        Validates the value associated with the given attribute, using the underlying validator.
        Parameters:
        attribute - the attribute the value is associated with
        Throws:
        ValidationException - if the given value is not valid for the given attribute
        See Also:
        validator()

      • validate

        void validate​(Entity entity)
       throws ValidationException
        Validates the given entity, using the underlying validator. For entities of a type other than this edit model is based on, their respective validators are used.
        Parameters:
        entity - the entity to validate
        Throws:
        ValidationException - in case the entity is invalid
        NullPointerException - in case the entity is null
        See Also:
        validator()

      • isValid

        boolean isValid()
        Returns:
        true if the underlying Entity contains only valid values
        See Also:
        validObserver()

      • modifiedObserver

        StateObserver modifiedObserver()
        Returns a StateObserver responsible for indicating when and if any values in the underlying Entity have been modified.
        Returns:
        a StateObserver indicating the modified state of this edit model
        See Also:
        isModified()

      • modifiedObserver

        StateObserver modifiedObserver​(Attribute<?> attribute)
        Returns a StateObserver instance indicating whether the value of the given attribute has been modified.
        Parameters:
        attribute - the attribute
        Returns:
        a StateObserver indicating the modified state of the value of the given attribute
        See Also:
        isModified()

      • primaryKeyNullObserver

        StateObserver primaryKeyNullObserver()
        Returns:
        a StateObserver indicating whether the primary key of the active entity is null

      • refreshingObserver

        StateObserver refreshingObserver()
        Returns:
        a StateObserver which is active while data models are being refreshed

      • addRefreshingObserver

        void addRefreshingObserver​(StateObserver refreshingObserver)
        Adds a StateObserver instance to this edit models refreshing observer
        Parameters:
        refreshingObserver - the refreshing observer to add
        See Also:
        refreshingObserver()

      • addEditListener

        <T> void addEditListener​(Attribute<T> attribute,
                         EventDataListener<T> listener)
        Adds a listener notified each time the value associated with the given attribute is edited via put(Attribute, Object) or remove(Attribute), note that this event is only fired if the value actually changes.
        Type Parameters:
        T - the value type
        Parameters:
        attribute - the attribute for which to monitor value edits
        listener - a listener notified each time the value of the given property is edited via this model

      • removeEditListener

        <T> void removeEditListener​(Attribute<T> attribute,
                            EventDataListener<T> listener)
        Removes the given listener.
        Type Parameters:
        T - the value type
        Parameters:
        attribute - the attribute
        listener - the listener to remove

      • addValueListener

        <T> void addValueListener​(Attribute<T> attribute,
                          EventDataListener<T> listener)
        Adds a listener notified each time the value associated with the given attribute changes, either via editing or when the active entity is set.
        Type Parameters:
        T - the value type
        Parameters:
        attribute - the attribute for which to monitor value changes
        listener - a listener notified each time the value of the attribute changes
        See Also:
        setEntity(Entity)

      • removeValueListener

        <T> void removeValueListener​(Attribute<T> attribute,
                             EventDataListener<T> listener)
        Removes the given listener.
        Type Parameters:
        T - the value type
        Parameters:
        attribute - the attribute for which to remove the listener
        listener - the listener to remove

      • addValueListener

        void addValueListener​(EventDataListener<Attribute<?>> listener)
        Parameters:
        listener - a listener notified each time a value changes

      • removeValueListener

        void removeValueListener​(EventDataListener<Attribute<?>> listener)
        Parameters:
        listener - the listener to remove

      • removeEntityListener

        void removeEntityListener​(EventDataListener<Entity> listener)
        Removes the given listener.
        Parameters:
        listener - the listener to remove

      • addBeforeInsertListener

        void addBeforeInsertListener​(EventDataListener<List<Entity>> listener)
        Parameters:
        listener - a listener to be notified before an insert is performed

      • removeBeforeInsertListener

        void removeBeforeInsertListener​(EventDataListener<List<Entity>> listener)
        Removes the given listener.
        Parameters:
        listener - a listener to remove

      • addAfterInsertListener

        void addAfterInsertListener​(EventDataListener<List<Entity>> listener)
        Parameters:
        listener - a listener to be notified each time insert has been performed

      • removeAfterInsertListener

        void removeAfterInsertListener​(EventDataListener<List<Entity>> listener)
        Removes the given listener.
        Parameters:
        listener - a listener to remove

      • addBeforeUpdateListener

        void addBeforeUpdateListener​(EventDataListener<Map<Key,​Entity>> listener)
        Parameters:
        listener - a listener to be notified before an update is performed

      • removeBeforeUpdateListener

        void removeBeforeUpdateListener​(EventDataListener<Map<Key,​Entity>> listener)
        Removes the given listener.
        Parameters:
        listener - a listener to remove

      • addAfterUpdateListener

        void addAfterUpdateListener​(EventDataListener<Map<Key,​Entity>> listener)
        Parameters:
        listener - a listener to be notified each time an update has been performed, with the updated entities, mapped to their respective original primary keys, that is, the primary keys before the update was performed

      • removeAfterUpdateListener

        void removeAfterUpdateListener​(EventDataListener<Map<Key,​Entity>> listener)
        Removes the given listener.
        Parameters:
        listener - a listener to remove

      • addBeforeDeleteListener

        void addBeforeDeleteListener​(EventDataListener<List<Entity>> listener)
        Parameters:
        listener - a listener to be notified before a delete is performed

      • removeBeforeDeleteListener

        void removeBeforeDeleteListener​(EventDataListener<List<Entity>> listener)
        Removes the given listener.
        Parameters:
        listener - a listener to remove

      • addAfterDeleteListener

        void addAfterDeleteListener​(EventDataListener<List<Entity>> listener)
        Parameters:
        listener - a listener to be notified each time delete has been performed

      • removeAfterDeleteListener

        void removeAfterDeleteListener​(EventDataListener<List<Entity>> listener)
        Removes the given listener.
        Parameters:
        listener - a listener to remove

      • addRefreshListener

        void addRefreshListener​(EventListener listener)
        Parameters:
        listener - a listener to be notified each time a refresh has been performed
        See Also:
        refresh()

      • removeRefreshListener

        void removeRefreshListener​(EventListener listener)
        Removes the given listener.
        Parameters:
        listener - a listener to remove

      • addEntitiesEditedListener

        void addEntitiesEditedListener​(EventListener listener)
        Parameters:
        listener - a listener to be notified each time an entity is edited via this model, updated, inserted or deleted

      • removeEntitiesEditedListener

        void removeEntitiesEditedListener​(EventListener listener)
        Removes the given listener.
        Parameters:
        listener - a listener to remove

      • addConfirmSetEntityObserver

        void addConfirmSetEntityObserver​(EventDataListener<State> listener)
        Parameters:
        listener - a listener notified each time the active entity is about to be set

      • removeConfirmSetEntityObserver

        void removeConfirmSetEntityObserver​(EventDataListener<State> listener)
        Removes the given listener.
        Parameters:
        listener - a listener to remove