io.jmix.ui.model.impl

Class NoopDataContext

java.lang.Object

io.jmix.ui.model.impl.NoopDataContext

All Implemented Interfaces:

DataContext

public class NoopDataContext
extends java.lang.Object
implements DataContext

Dummy implementation of DataContext used for read-only screens like entity browsers.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.model.DataContext

DataContext.ChangeEvent, DataContext.PostCommitEvent, DataContext.PreCommitEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addChangeListener(java.util.function.Consumer<DataContext.ChangeEvent> listener) Adds a listener to DataContext.ChangeEvent.
io.jmix.core.common.event.Subscription	addPostCommitListener(java.util.function.Consumer<DataContext.PostCommitEvent> listener) Adds a listener to DataContext.PostCommitEvent.
io.jmix.core.common.event.Subscription	addPreCommitListener(java.util.function.Consumer<DataContext.PreCommitEvent> listener) Adds a listener to DataContext.PreCommitEvent.
void	clear() Evicts all tracked entities.
io.jmix.core.EntitySet	commit() Commits changed and removed instances to the middleware.
boolean	contains(java.lang.Object entity) Returns true if the context contains the given entity (distinguished by its class and id).
<T> T	create(java.lang.Class<T> entityClass) Creates an entity instance and merges it into the context.
void	evict(java.lang.Object 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.
<T> T	find(java.lang.Class<T> entityClass, java.lang.Object entityId) Returns an entity instance by its class and id.
<T> T	find(T entity) Returns the instance of entity with the same id if it exists in this context.
java.util.function.Function<io.jmix.core.SaveContext,java.util.Set<java.lang.Object>>	getCommitDelegate() Returns a function which will be used to commit data instead of standard implementation.
java.util.Set	getModified() Returns an immutable set of entities registered as modified.
DataContext	getParent() Returns a parent context, if any.
java.util.Set	getRemoved() Returns an immutable set of entities registered for removal.
boolean	hasChanges() Returns true if the context has detected changes in the tracked entities.
boolean	isModified(java.lang.Object entity) Returns true if the context has detected changes in the given entity.
boolean	isRemoved(java.lang.Object entity) Returns true if the context has registered removal of the given entity.
io.jmix.core.EntitySet	merge(java.util.Collection entities) Merge the given entities into the context.
io.jmix.core.EntitySet	merge(java.util.Collection entities, MergeOptions options) Merge the given entities into the context.
<T> T	merge(T entity) Same as DataContext.merge(Object, MergeOptions) with default options.
<T> T	merge(T entity, MergeOptions options) Merge the given entity into the context.
void	remove(java.lang.Object entity) Removes the entity from the context and registers it as deleted.
void	setCommitDelegate(java.util.function.Function<io.jmix.core.SaveContext,java.util.Set<java.lang.Object>> delegate) Sets a function which will be used to commit data instead of standard implementation.
void	setModified(java.lang.Object entity, boolean modified) Registers or unregisters the given entity as modified.
void	setParent(DataContext parentContext) Sets the parent context.

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

Constructor Detail

NoopDataContext

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

Method Detail

find

@Nullable
public <T> T find(java.lang.Class<T> entityClass,
                            java.lang.Object 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

public <T> 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(java.lang.Object 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> 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> T merge(T entity)

Description copied from interface: DataContext

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

Specified by:

merge in interface DataContext

merge

public io.jmix.core.EntitySet merge(java.util.Collection 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(Object) but for a collection of instances.

Specified by:

merge in interface DataContext

Returns:

set of instances tracked by the context

merge

public io.jmix.core.EntitySet merge(java.util.Collection 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(Object, MergeOptions) but for a collection of instances.

Specified by:

merge in interface DataContext

Returns:

set of instances tracked by the context

remove

public void remove(java.lang.Object 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

evict

public void evict(java.lang.Object 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(Object)

create

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

Description copied from interface: DataContext

Creates an entity instance and merges 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

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(java.lang.Object 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(java.lang.Object 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 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(java.lang.Object 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 getRemoved()

Description copied from interface: DataContext

Returns an immutable set of entities registered for removal.

Specified by:

getRemoved in interface DataContext

commit

public io.jmix.core.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)

getParent

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 io.jmix.core.common.event.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

addPreCommitListener

public io.jmix.core.common.event.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 io.jmix.core.common.event.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<io.jmix.core.SaveContext,java.util.Set<java.lang.Object>> 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<io.jmix.core.SaveContext,java.util.Set<java.lang.Object>> 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