io.jmix.core

Class SaveContext

java.lang.Object

io.jmix.core.SaveContext

All Implemented Interfaces:

java.io.Serializable

public class SaveContext
extends java.lang.Object
implements java.io.Serializable

Defines collections of entities to be saved or removed, as well as parameters of saving.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<AccessConstraint<?>>	accessConstraints
protected boolean	discardSaved
protected java.util.Collection<java.lang.Object>	entitiesToRemove
protected java.util.Collection<java.lang.Object>	entitiesToSave
protected java.util.Map<java.lang.Object,FetchPlan>	fetchPlans
protected java.util.Map<java.lang.String,java.io.Serializable>	hints
protected boolean	joinTransaction
protected boolean	softDeletion

Constructor Summary

Constructors

Constructor and Description
SaveContext()

Method Summary

Modifier and Type	Method and Description
java.util.List<AccessConstraint<?>>	getAccessConstraints() Returns the list of access constraints.
java.util.Collection<java.lang.Object>	getEntitiesToRemove()
java.util.Collection<java.lang.Object>	getEntitiesToSave()
java.util.Map<java.lang.Object,FetchPlan>	getFetchPlans() Enables defining a fetchPlan for each committed entity.
java.util.Map<java.lang.String,java.io.Serializable>	getHints()
boolean	isDiscardSaved()
boolean	isJoinTransaction()
SaveContext	removing(java.lang.Object... entities) Adds an entity to be removed from the database.
SaveContext	saving(java.lang.Object... entities) Adds an entity to be committed to the database.
SaveContext	saving(java.lang.Object entity, FetchPlan fetchPlan) Adds an entity to be committed to the database.
SaveContext	setAccessConstraints(java.util.List<AccessConstraint<?>> accessConstraints) Sets the list of access constraints.
SaveContext	setDiscardSaved(boolean discardSaved) Set to true if calling code does not need saved instances, which allows for performance optimization.
SaveContext	setHint(java.lang.String hintName, java.io.Serializable value) Sets custom hint that should be used by the query.
SaveContext	setHints(java.util.Map<java.lang.String,java.io.Serializable> hints) Sets custom hints that should be used by the query.
SaveContext	setJoinTransaction(boolean joinTransaction) Sets whether to join existing transaction or always start a new one.

Methods inherited from class java.lang.Object

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

Field Detail

entitiesToSave

protected java.util.Collection<java.lang.Object> entitiesToSave

entitiesToRemove

protected java.util.Collection<java.lang.Object> entitiesToRemove

fetchPlans

protected java.util.Map<java.lang.Object,FetchPlan> fetchPlans

softDeletion

protected boolean softDeletion

discardSaved

protected boolean discardSaved

joinTransaction

protected boolean joinTransaction

accessConstraints

protected java.util.List<AccessConstraint<?>> accessConstraints

hints

protected java.util.Map<java.lang.String,java.io.Serializable> hints

Constructor Detail

SaveContext

public SaveContext()

Method Detail

saving

public SaveContext saving(java.lang.Object... entities)

Adds an entity to be committed to the database.

Parameters:

entities - entity instances

Returns:

this instance for chaining

saving

public SaveContext saving(java.lang.Object entity,
                          @Nullable
                          FetchPlan fetchPlan)

Adds an entity to be committed to the database.

Parameters:

entity - entity instance

fetchPlan - fetch plan which is used in merge operation to ensure all required attributes are loaded in the returned instance

Returns:

this instance for chaining

removing

public SaveContext removing(java.lang.Object... entities)

Adds an entity to be removed from the database.

Parameters:

entities - entity instances

Returns:

this instance for chaining

getEntitiesToSave

public java.util.Collection<java.lang.Object> getEntitiesToSave()

Returns:

direct reference to collection of changed entities that will be committed to the database. The collection is modifiable.

getEntitiesToRemove

public java.util.Collection<java.lang.Object> getEntitiesToRemove()

Returns:

direct reference to collection of entities that will be removed from the database. The collection is modifiable.

getFetchPlans

public java.util.Map<java.lang.Object,FetchPlan> getFetchPlans()

Enables defining a fetchPlan for each committed entity. These fetchPlans are used in merge operation to ensure all required attributes are loaded in returned instances.

Returns:

mutable map of entities to their fetchPlans

getHints

public java.util.Map<java.lang.String,java.io.Serializable> getHints()

Returns:

custom hints which are used by the query

setHint

public SaveContext setHint(java.lang.String hintName,
                           java.io.Serializable value)

Sets custom hint that should be used by the query.

setHints

public SaveContext setHints(java.util.Map<java.lang.String,java.io.Serializable> hints)

Sets custom hints that should be used by the query.

isDiscardSaved

public boolean isDiscardSaved()

Returns:

true if calling code does not need committed instances, which allows for performance optimization

setDiscardSaved

public SaveContext setDiscardSaved(boolean discardSaved)

Set to true if calling code does not need saved instances, which allows for performance optimization.

getAccessConstraints

public java.util.List<AccessConstraint<?>> getAccessConstraints()

Returns the list of access constraints.

setAccessConstraints

public SaveContext setAccessConstraints(java.util.List<AccessConstraint<?>> accessConstraints)

Sets the list of access constraints.

isJoinTransaction

public boolean isJoinTransaction()

Returns:

whether to join existing transaction or always start a new one

setJoinTransaction

public SaveContext setJoinTransaction(boolean joinTransaction)

Sets whether to join existing transaction or always start a new one.