com.haulmont.cuba.gui.model.impl

Class DataContextImpl

java.lang.Object

com.haulmont.cuba.gui.model.impl.DataContextImpl

All Implemented Interfaces:

DataContext

public class DataContextImpl
extends java.lang.Object
implements DataContext

Standard implementation of DataContext which commits data to DataManager.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DataContextImpl.EmbeddedPropertyChangeListener
protected class	DataContextImpl.PropertyChangeListener

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.model.DataContext

DataContext.ChangeEvent, DataContext.PostCommitEvent, DataContext.PreCommitEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
protected java.util.function.Function<CommitContext,java.util.Set<Entity>>	commitDelegate
protected java.util.Map<java.lang.Class<?>,java.util.Map<java.lang.Object,Entity>>	content
protected boolean	disableListeners
protected java.util.Map<Entity,java.util.Map<java.lang.String,DataContextImpl.EmbeddedPropertyChangeListener>>	embeddedPropertyListeners
protected EventHub	events
protected java.util.Set<Entity>	modifiedInstances
protected DataContextImpl	parentContext
protected DataContextImpl.PropertyChangeListener	propertyChangeListener
protected java.util.Set<Entity>	removedInstances

Constructor Summary

Constructors

Constructor and Description
DataContextImpl(org.springframework.context.ApplicationContext applicationContext)

Method Summary

Modifier and Type	Method and Description
Subscription	addChangeListener(java.util.function.Consumer<DataContext.ChangeEvent> listener) Adds a listener to DataContext.ChangeEvent.
Subscription	addPostCommitListener(java.util.function.Consumer<DataContext.PostCommitEvent> listener) Adds a listener to DataContext.PostCommitEvent.
Subscription	addPreCommitListener(java.util.function.Consumer<DataContext.PreCommitEvent> listener) Adds a listener to DataContext.PreCommitEvent.
protected void	cleanupContextAfterRemoveEntity(DataContextImpl context, Entity removedEntity)
void	clear() Evicts all tracked entities.
EntitySet	commit() Commits changed and removed instances to the middleware.
protected java.util.Set<Entity>	commitToDataManager(CommitContext.ValidationMode validationMode, java.util.List<java.lang.Class> validationGroups)
protected java.util.Set<Entity>	commitToParentContext()
boolean	contains(Entity entity) Returns true if the context contains the given entity (distinguished by its class and id).
protected Entity	copyEntity(Entity srcEntity)
protected void	copySystemState(Entity srcEntity, Entity dstEntity)
<T extends Entity> T	create(java.lang.Class<T> entityClass) Creates an entity instance and merge it into the context.
protected java.util.List<Entity>	createObservableList(Entity notifiedEntity)
protected java.util.List<Entity>	createObservableList(java.util.List<Entity> list, Entity notifiedEntity)
protected java.util.Set<Entity>	createObservableSet(Entity notifiedEntity)
protected ObservableSet<Entity>	createObservableSet(java.util.Set<Entity> set, Entity notifiedEntity)
protected boolean	entityHasReference(Entity entity, Entity refEntity)
void	evict(Entity entity) Removes the entity from the context so the context stops tracking it.
void	evictModified() Clears the lists of created/modified/deleted entities and evicts these entities.
protected java.util.Collection	filterCommittedInstances(java.util.Set<Entity> instances)
<T extends Entity<K>,K> T	find(java.lang.Class<T> entityClass, K entityId) Returns an entity instance by its class and id.
<T extends Entity> T	find(T entity) Returns the instance of entity with the same id if it exists in this context.
protected void	fireChangeListener(Entity entity)
java.util.Collection<Entity>	getAll()
java.util.function.Function<CommitContext,java.util.Set<Entity>>	getCommitDelegate() Returns a function which will be used to commit data instead of standard implementation.
protected DataManager	getDataManager()
protected EntityReferencesNormalizer	getEntityReferencesNormalizer()
protected EntityStates	getEntityStates()
protected Metadata	getMetadata()
protected MetadataTools	getMetadataTools()
java.util.Set<Entity>	getModified() Returns an immutable set of entities registered as modified.
DataContext	getParent() Returns a parent context, if any.
java.util.Set<Entity>	getRemoved() Returns an immutable set of entities registered for removal.
boolean	hasChanges() Returns true if the context has detected changes in the tracked entities.
protected Entity	internalMerge(Entity entity, java.util.Set<Entity> mergedSet, boolean isRoot, MergeOptions options)
boolean	isModified(Entity entity) Returns true if the context has detected changes in the given entity.
boolean	isRemoved(Entity entity) Returns true if the context has registered removal of the given entity.
EntitySet	merge(java.util.Collection<? extends Entity> entities) Merge the given entities into the context.
EntitySet	merge(java.util.Collection<? extends Entity> entities, MergeOptions options) Merge the given entities into the context.
<T extends Entity> T	merge(T entity) Same as DataContext.merge(Entity, MergeOptions) with default options.
<T extends Entity> T	merge(T entity, MergeOptions options) Merge the given entity into the context.
protected EntitySet	mergeCommitted(java.util.Set<Entity> committed)
protected void	mergeList(java.util.List<Entity> list, Entity managedEntity, MetaProperty property, boolean replace, MergeOptions options, java.util.Set<Entity> mergedSet)
protected void	mergeSet(java.util.Set<Entity> set, Entity managedEntity, MetaProperty property, boolean replace, MergeOptions options, java.util.Set<Entity> mergedSet)
protected void	mergeState(Entity srcEntity, Entity dstEntity, java.util.Set<Entity> mergedSet, boolean isRoot, MergeOptions options)
protected void	mergeSystemState(Entity srcEntity, Entity dstEntity, boolean isRoot, MergeOptions options)
protected void	modified(Entity entity)
protected java.util.Set<Entity>	performCommit(CommitContext.ValidationMode validationMode, java.util.List<java.lang.Class> validationGroups)
java.lang.String	printContent()
protected java.lang.String	printEntity(Entity entity, int level, java.util.Set<Entity> visited)
protected java.lang.String	printObject(java.lang.Object object)
void	remove(Entity entity) Removes the entity from the context and registers it as deleted.
protected void	removeFromCollections(Entity entityToRemove)
protected void	removeListeners(Entity entity)
void	setCommitDelegate(java.util.function.Function<CommitContext,java.util.Set<Entity>> delegate) Sets a function which will be used to commit data instead of standard implementation.
void	setModified(Entity entity, boolean modified) Registers or unregisters the given entity as modified.
void	setParent(DataContext parentContext) Sets the parent context.
protected void	setPropertyValue(Entity entity, MetaProperty property, java.lang.Object value)
protected void	setPropertyValue(Entity entity, MetaProperty property, java.lang.Object value, boolean checkEquals)

Methods inherited from class java.lang.Object

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

Field Detail

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

events

protected EventHub events

content

protected java.util.Map<java.lang.Class<?>,java.util.Map<java.lang.Object,Entity>> content

modifiedInstances

protected java.util.Set<Entity> modifiedInstances

removedInstances

protected java.util.Set<Entity> removedInstances

propertyChangeListener

protected DataContextImpl.PropertyChangeListener propertyChangeListener

disableListeners

protected boolean disableListeners

parentContext

protected DataContextImpl parentContext

commitDelegate

protected java.util.function.Function<CommitContext,java.util.Set<Entity>> commitDelegate

embeddedPropertyListeners

protected java.util.Map<Entity,java.util.Map<java.lang.String,DataContextImpl.EmbeddedPropertyChangeListener>> embeddedPropertyListeners

Constructor Detail

DataContextImpl

public DataContextImpl(org.springframework.context.ApplicationContext applicationContext)

Method Detail

getMetadata

protected Metadata getMetadata()

getMetadataTools

protected MetadataTools getMetadataTools()

getEntityStates

protected EntityStates getEntityStates()

getDataManager

protected DataManager getDataManager()

getEntityReferencesNormalizer

protected EntityReferencesNormalizer getEntityReferencesNormalizer()

getParent

@Nullable
public DataContext getParent()

Description copied from interface: DataContext

Returns a parent context, if any. If the parent context is set, DataContext.commit() method merges the changed instances to it instead of sending to the middleware.

Specified by:

getParent in interface DataContext

setParent

public void setParent(DataContext parentContext)

Description copied from interface: DataContext

Sets the parent context. If the parent context is set, DataContext.commit() method merges the changed instances to it instead of sending to the middleware.

Specified by:

setParent in interface DataContext

addChangeListener

public Subscription addChangeListener(java.util.function.Consumer<DataContext.ChangeEvent> listener)

Description copied from interface: DataContext

Adds a listener to DataContext.ChangeEvent.

Specified by:

addChangeListener in interface DataContext

fireChangeListener

protected void fireChangeListener(Entity entity)

find

@Nullable
public <T extends Entity<K>,K> T find(java.lang.Class<T> entityClass,
                                                K entityId)

Description copied from interface: DataContext

Returns an entity instance by its class and id.

Specified by:

find in interface DataContext

Returns:

entity instance or null if there is no such entity in the context

find

@Nullable
public <T extends Entity> T find(T entity)

Description copied from interface: DataContext

Returns the instance of entity with the same id if it exists in this context.

Specified by:

find in interface DataContext

Returns:

entity instance or null if there is no such entity in the context

contains

public boolean contains(Entity entity)

Description copied from interface: DataContext

Returns true if the context contains the given entity (distinguished by its class and id).

Specified by:

contains in interface DataContext

merge

public <T extends Entity> T merge(T entity,
                                  MergeOptions options)

Description copied from interface: DataContext

Merge the given entity into the context. The whole object graph with all references will be merged.

If an entity with the same identifier already exists in the context, the passed entity state is copied into it and the existing instance is returned. Otherwise, a copy of the passed instance is registered in the context and returned.

If the given instance is new and the context doesn't contain an instance with the same identifier, the context will save the new instance on DataContext.commit(). Otherwise, even if some attributes of the merged instance are changed as a result of copying the state of the passed instance, the merged instance will not be committed. Such modifications are considered as a result of loading more fresh state from the database.

WARNING: use the returned value because it is always a different object instance. The only case when you get the same instance is if the input was previously returned from the same context as a result of DataContext.find(Class, Object) or merge().

Specified by:

merge in interface DataContext

Parameters:

entity - instance to merge

options - merge options

Returns:

the instance which is tracked by the context

merge

public <T extends Entity> T merge(T entity)

Description copied from interface: DataContext

Same as DataContext.merge(Entity, MergeOptions) with default options.

Specified by:

merge in interface DataContext

merge

public EntitySet merge(java.util.Collection<? extends Entity> entities,
                       MergeOptions options)

Description copied from interface: DataContext

Merge the given entities into the context. The whole object graph for each element of the collection with all references will be merged.

Same as DataContext.merge(Entity) but for a collection of instances.

Specified by:

merge in interface DataContext

Returns:

set of instances tracked by the context

merge

public EntitySet merge(java.util.Collection<? extends Entity> entities)

Description copied from interface: DataContext

Merge the given entities into the context. The whole object graph for each element of the collection with all references will be merged.

Same as DataContext.merge(Entity, MergeOptions) but for a collection of instances.

Specified by:

merge in interface DataContext

Returns:

set of instances tracked by the context

internalMerge

protected Entity internalMerge(Entity entity,
                               java.util.Set<Entity> mergedSet,
                               boolean isRoot,
                               MergeOptions options)

copyEntity

protected Entity copyEntity(Entity srcEntity)

mergeState

protected void mergeState(Entity srcEntity,
                          Entity dstEntity,
                          java.util.Set<Entity> mergedSet,
                          boolean isRoot,
                          MergeOptions options)

setPropertyValue

protected void setPropertyValue(Entity entity,
                                MetaProperty property,
                                @Nullable
                                java.lang.Object value)

setPropertyValue

protected void setPropertyValue(Entity entity,
                                MetaProperty property,
                                @Nullable
                                java.lang.Object value,
                                boolean checkEquals)

copySystemState

protected void copySystemState(Entity srcEntity,
                               Entity dstEntity)

mergeSystemState

protected void mergeSystemState(Entity srcEntity,
                                Entity dstEntity,
                                boolean isRoot,
                                MergeOptions options)

mergeList

protected void mergeList(java.util.List<Entity> list,
                         Entity managedEntity,
                         MetaProperty property,
                         boolean replace,
                         MergeOptions options,
                         java.util.Set<Entity> mergedSet)

mergeSet

protected void mergeSet(java.util.Set<Entity> set,
                        Entity managedEntity,
                        MetaProperty property,
                        boolean replace,
                        MergeOptions options,
                        java.util.Set<Entity> mergedSet)

createObservableList

protected java.util.List<Entity> createObservableList(Entity notifiedEntity)

createObservableList

protected java.util.List<Entity> createObservableList(java.util.List<Entity> list,
                                                      Entity notifiedEntity)

createObservableSet

protected java.util.Set<Entity> createObservableSet(Entity notifiedEntity)

createObservableSet

protected ObservableSet<Entity> createObservableSet(java.util.Set<Entity> set,
                                                    Entity notifiedEntity)

remove

public void remove(Entity entity)

Description copied from interface: DataContext

Removes the entity from the context and registers it as deleted. The entity will be removed from the data store upon subsequent call to DataContext.commit().

If the given entity is not in the context, nothing happens.

Specified by:

remove in interface DataContext

removeFromCollections

protected void removeFromCollections(Entity entityToRemove)

evict

public void evict(Entity entity)

Description copied from interface: DataContext

Removes the entity from the context so the context stops tracking it.

If the given entity is not in the context, nothing happens.

Specified by:

evict in interface DataContext

evictModified

public void evictModified()

Description copied from interface: DataContext

Clears the lists of created/modified/deleted entities and evicts these entities.

Specified by:

evictModified in interface DataContext

clear

public void clear()

Description copied from interface: DataContext

Evicts all tracked entities.

Specified by:

clear in interface DataContext

See Also:

DataContext.evict(Entity)

create

public <T extends Entity> T create(java.lang.Class<T> entityClass)

Description copied from interface: DataContext

Creates an entity instance and merge it into the context.

Same as:

 Foo foo = dataContext.merge(metadata.create(Foo.class));
 

Specified by:

create in interface DataContext

Parameters:

entityClass - entity class

Returns:

a new instance which is tracked by the context

removeListeners

protected void removeListeners(Entity entity)

hasChanges

public boolean hasChanges()

Description copied from interface: DataContext

Returns true if the context has detected changes in the tracked entities.

Specified by:

hasChanges in interface DataContext

isModified

public boolean isModified(Entity entity)

Description copied from interface: DataContext

Returns true if the context has detected changes in the given entity.

Specified by:

isModified in interface DataContext

setModified

public void setModified(Entity entity,
                        boolean modified)

Description copied from interface: DataContext

Registers or unregisters the given entity as modified.

Specified by:

setModified in interface DataContext

Parameters:

entity - entity instance which is already merged into the context

modified - true to register or false to unregister

getModified

public java.util.Set<Entity> getModified()

Description copied from interface: DataContext

Returns an immutable set of entities registered as modified.

Specified by:

getModified in interface DataContext

isRemoved

public boolean isRemoved(Entity entity)

Description copied from interface: DataContext

Returns true if the context has registered removal of the given entity.

Specified by:

isRemoved in interface DataContext

getRemoved

public java.util.Set<Entity> getRemoved()

Description copied from interface: DataContext

Returns an immutable set of entities registered for removal.

Specified by:

getRemoved in interface DataContext

commit

public EntitySet commit()

Description copied from interface: DataContext

Commits changed and removed instances to the middleware. After successful commit, the context contains updated instances returned from the middleware.

Specified by:

commit in interface DataContext

Returns:

set of committed and merged back to the context instances. Does not contain removed instances.

See Also:

DataContext.setParent(DataContext)

addPreCommitListener

public Subscription addPreCommitListener(java.util.function.Consumer<DataContext.PreCommitEvent> listener)

Description copied from interface: DataContext

Adds a listener to DataContext.PreCommitEvent.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe(target = Target.DATA_CONTEXT)
    protected void onPreCommit(DataContext.PreCommitEvent event) {
       // handle event here
    }
 

Specified by:

addPreCommitListener in interface DataContext

Parameters:

listener - listener

Returns:

subscription

addPostCommitListener

public Subscription addPostCommitListener(java.util.function.Consumer<DataContext.PostCommitEvent> listener)

Description copied from interface: DataContext

Adds a listener to DataContext.PostCommitEvent.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe(target = Target.DATA_CONTEXT)
    protected void onPostCommit(DataContext.PostCommitEvent event) {
       // handle event here
    }
 

Specified by:

addPostCommitListener in interface DataContext

Parameters:

listener - listener

Returns:

subscription

getCommitDelegate

public java.util.function.Function<CommitContext,java.util.Set<Entity>> getCommitDelegate()

Description copied from interface: DataContext

Returns a function which will be used to commit data instead of standard implementation.

Specified by:

getCommitDelegate in interface DataContext

setCommitDelegate

public void setCommitDelegate(java.util.function.Function<CommitContext,java.util.Set<Entity>> delegate)

Description copied from interface: DataContext

Sets a function which will be used to commit data instead of standard implementation.

Specified by:

setCommitDelegate in interface DataContext

performCommit

protected java.util.Set<Entity> performCommit(CommitContext.ValidationMode validationMode,
                                              java.util.List<java.lang.Class> validationGroups)

commitToDataManager

protected java.util.Set<Entity> commitToDataManager(CommitContext.ValidationMode validationMode,
                                                    java.util.List<java.lang.Class> validationGroups)

filterCommittedInstances

protected java.util.Collection filterCommittedInstances(java.util.Set<Entity> instances)

commitToParentContext

protected java.util.Set<Entity> commitToParentContext()

cleanupContextAfterRemoveEntity

protected void cleanupContextAfterRemoveEntity(DataContextImpl context,
                                               Entity removedEntity)

entityHasReference

protected boolean entityHasReference(Entity entity,
                                     Entity refEntity)

mergeCommitted

protected EntitySet mergeCommitted(java.util.Set<Entity> committed)

getAll

public java.util.Collection<Entity> getAll()

modified

protected void modified(Entity entity)

printContent

public java.lang.String printContent()

printEntity

protected java.lang.String printEntity(Entity entity,
                                       int level,
                                       java.util.Set<Entity> visited)

printObject

protected java.lang.String printObject(java.lang.Object object)