com.haulmont.cuba.core

Interface EntityManager

All Known Implementing Classes:

EntityManagerImpl

public interface EntityManager

Interface used to interact with the persistence context.

Mostly mimics the javax.persistence.EntityManager interface and adds methods for working with fetch plans and soft deletion.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
Query	createNativeQuery() Create an instance of Query for executing a native SQL statement, e.g., for update or delete.
Query	createNativeQuery(java.lang.String sqlString) Create an instance of Query for executing a native SQL statement, e.g., for update or delete.
<T extends io.jmix.core.Entity> TypedQuery<T>	createNativeQuery(java.lang.String sqlString, java.lang.Class<T> resultClass) Create an instance of Query for executing a native SQL statement and map its result to an entity.
Query	createQuery() Create an instance of Query for executing a Java Persistence query language statement.
Query	createQuery(java.lang.String qlString) Create an instance of Query for executing a Java Persistence query language statement.
<T> TypedQuery<T>	createQuery(java.lang.String qlString, java.lang.Class<T> resultClass) Create a type-safe instance of Query for executing a Java Persistence query language statement.
void	detach(io.jmix.core.Entity entity)
void	fetch(io.jmix.core.Entity entity, io.jmix.core.FetchPlan fetchPlan) Deprecated.
<T extends io.jmix.core.Entity,K> T	find(java.lang.Class<T> entityClass, K id) Find by primary key.
<T extends io.jmix.core.Entity,K> T	find(java.lang.Class<T> entityClass, K id, io.jmix.core.FetchPlan... fetchPlans) Find by primary key.
<T extends io.jmix.core.Entity,K> T	find(java.lang.Class<T> entityClass, K id, java.lang.String... fetchPlanNames) Find by primary key.
void	flush() Synchronize the persistence context to the underlying database.
java.sql.Connection	getConnection()
javax.persistence.EntityManager	getDelegate()
<T extends io.jmix.core.Entity,K> T	getReference(java.lang.Class<T> entityClass, K id) Get an instance, whose state may be lazily fetched. If the requested instance does not exist in the database, the EntityNotFoundException is thrown when the instance state is first accessed. The application should not expect that the instance state will be available upon detachment, unless it was accessed by the application while the entity manager was open.
boolean	isSoftDeletion()
<T extends io.jmix.core.Entity> T	merge(T entity) Merge the state of the given entity into the current persistence context.
<T extends io.jmix.core.Entity> T	merge(T entity, io.jmix.core.FetchPlan fetchPlan) Deprecated.
<T extends io.jmix.core.Entity> T	merge(T entity, java.lang.String fetchPlanName) Deprecated.
void	persist(io.jmix.core.Entity entity) Make an instance managed and persistent.
<T extends io.jmix.core.Entity,K> T	reload(java.lang.Class<T> entityClass, K id, java.lang.String... fetchPlanNames) Deprecated.
<T extends io.jmix.core.Entity> T	reload(T entity, java.lang.String... fetchPlanNames) Reload an entity from DB according to a combined fetch plan defined by the given array of fetch plans.
<T extends io.jmix.core.Entity> T	reloadNN(T entity, java.lang.String... fetchPlanNames) Reload an entity from DB according to a combined fetch plan defined by the given array of fetch plans.
void	remove(io.jmix.core.Entity entity) Remove the entity instance.
void	setSoftDeletion(boolean softDeletion) Set SoftDeletion mode for this EntityManager.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

persist

void persist(io.jmix.core.Entity entity)

Make an instance managed and persistent.

Parameters:

entity - entity instance

Throws:

java.lang.IllegalArgumentException - if not an entity

merge

<T extends io.jmix.core.Entity> T merge(T entity)

Merge the state of the given entity into the current persistence context.

If a new or patch entity (see PersistenceHelper methods) with non-null ID is passed to merge, EntityManager loads the corresponding object from the database and updates it with non-null values of attributes of the passed entity. If the object does not exist in the database, the passed entity is persisted and returned.

Parameters:

entity - entity instance

Returns:

the instance that the state was merged to

Throws:

java.lang.IllegalArgumentException - if instance is not an entity or is a removed entity

See Also:

EntityStates.isNew(Object), EntityStates.makePatch(Object)

merge

@Deprecated
<T extends io.jmix.core.Entity> T merge(T entity,
                                                    @Nullable
                                                    io.jmix.core.FetchPlan fetchPlan)

Deprecated.

DEPRECATED. Use io.jmix.core.sys.EntityFetcher#fetch(Entity, FetchPlan) if needed.

merge

@Deprecated
<T extends io.jmix.core.Entity> T merge(T entity,
                                                    @Nullable
                                                    java.lang.String fetchPlanName)

Deprecated.

DEPRECATED. Use io.jmix.core.sys.EntityFetcher#fetch(Entity, String) if needed.

remove

void remove(io.jmix.core.Entity entity)

Remove the entity instance. What actually happens depends on isSoftDeletion() flag.

Parameters:

entity - entity instance

Throws:

java.lang.IllegalArgumentException - if not an entity

find

@Nullable
<T extends io.jmix.core.Entity,K> T find(java.lang.Class<T> entityClass,
                                                   K id)

Find by primary key.

Parameters:

entityClass - entity class

id - entity id

Returns:

the found entity instance or null if the entity does not exist

Throws:

java.lang.IllegalArgumentException - if the first argument does not denote an entity type or the second argument is not a valid type for that entity's primary key

find

@Nullable
<T extends io.jmix.core.Entity,K> T find(java.lang.Class<T> entityClass,
                                                   K id,
                                                   io.jmix.core.FetchPlan... fetchPlans)

Find by primary key.

Due to accepting fetch plans, this method actually executes a Query which may lead to flushing of the persistence context and invoking listeners on modified entities.

Parameters:

entityClass - entity class

id - entity id

fetchPlans - array of fetch plans

Returns:

the found entity instance or null if the entity does not exist

Throws:

java.lang.IllegalArgumentException - if the first argument does not denote an entity type or the second argument is not a valid type for that entity's primary key

find

@Nullable
<T extends io.jmix.core.Entity,K> T find(java.lang.Class<T> entityClass,
                                                   K id,
                                                   java.lang.String... fetchPlanNames)

Find by primary key.

Due to accepting fetch plans, this method actually executes a Query which may lead to flushing of the persistence context and invoking listeners on modified entities.

Parameters:

entityClass - entity class

id - entity id

fetchPlanNames - array of fetch plan names for this entity

Returns:

the found entity instance or null if the entity does not exist

Throws:

java.lang.IllegalArgumentException - if the first argument does not denote an entity type or the second argument is not a valid type for that entity's primary key

getReference

<T extends io.jmix.core.Entity,K> T getReference(java.lang.Class<T> entityClass,
                                                 K id)

Get an instance, whose state may be lazily fetched.
If the requested instance does not exist in the database, the EntityNotFoundException is thrown when the instance state is first accessed.
The application should not expect that the instance state will be available upon detachment, unless it was accessed by the application while the entity manager was open.

Parameters:

entityClass - entity class

id - entity id

Returns:

the found entity instance

Throws:

java.lang.IllegalArgumentException - if the first argument does not denote an entity type or the second argument is not a valid type for that entity's primary key

javax.persistence.EntityNotFoundException - if the entity state cannot be accessed

createQuery

Query createQuery()

Create an instance of Query for executing a Java Persistence query language statement.

Returns:

the new query instance

createQuery

Query createQuery(java.lang.String qlString)

Create an instance of Query for executing a Java Persistence query language statement.

Parameters:

qlString - a Java Persistence query string

Returns:

the new query instance

createQuery

<T> TypedQuery<T> createQuery(java.lang.String qlString,
                              java.lang.Class<T> resultClass)

Create a type-safe instance of Query for executing a Java Persistence query language statement. Can be used to conveniently perform select queries with runtime result type check.

Parameters:

qlString - a Java Persistence query string

resultClass - expected result class

Returns:

the new query instance

createNativeQuery

Query createNativeQuery()

Create an instance of Query for executing a native SQL statement, e.g., for update or delete.

Returns:

the new query instance

createNativeQuery

Query createNativeQuery(java.lang.String sqlString)

Create an instance of Query for executing a native SQL statement, e.g., for update or delete.

Parameters:

sqlString - a native SQL query string

Returns:

the new query instance

createNativeQuery

<T extends io.jmix.core.Entity> TypedQuery<T> createNativeQuery(java.lang.String sqlString,
                                                                java.lang.Class<T> resultClass)

Create an instance of Query for executing a native SQL statement and map its result to an entity.

Parameters:

sqlString - a native SQL query string

resultClass - expected result class

Returns:

the new query instance

reload

@Nullable
<T extends io.jmix.core.Entity> T reload(T entity,
                                                   java.lang.String... fetchPlanNames)

Reload an entity from DB according to a combined fetch plan defined by the given array of fetch plans.
Ensures all combined fetch plan attributes are loaded.
If the given entity is in managed state, the method returns the same object instance. If the entity is detached, the method returns a new object instance.

Parameters:

entity - entity instance to reload

fetchPlanNames - array of fetch plan names

Returns:

reloaded entity instance, or null if it has been deleted

reloadNN

<T extends io.jmix.core.Entity> T reloadNN(T entity,
                                           java.lang.String... fetchPlanNames)

Reload an entity from DB according to a combined fetch plan defined by the given array of fetch plans.
Ensures all combined fetch plan attributes are loaded.
If the given entity is in managed state, the method returns the same object instance. If the entity is detached, the method returns a new object instance.

Parameters:

entity - entity instance to reload

fetchPlanNames - array of fetch plan names

Returns:

reloaded entity instance

Throws:

javax.persistence.EntityNotFoundException - if the entity has been deleted

flush

void flush()

Synchronize the persistence context to the underlying database.

detach

void detach(io.jmix.core.Entity entity)

isSoftDeletion

boolean isSoftDeletion()

Returns:

true if the EntityManager is in SoftDeletion mode

setSoftDeletion

void setSoftDeletion(boolean softDeletion)

Set SoftDeletion mode for this EntityManager.

Parameters:

softDeletion - mode

getConnection

java.sql.Connection getConnection()

Returns:

database connection associated with the current transaction.

Don't close this connection after use, it will be automatically closed on transaction end.

getDelegate

javax.persistence.EntityManager getDelegate()

Returns:

underlying implementation provided by ORM

fetch

@Deprecated
void fetch(io.jmix.core.Entity entity,
                       io.jmix.core.FetchPlan fetchPlan)

Deprecated.

DEPRECATED since v.6

reload

@Deprecated
 @Nullable
<T extends io.jmix.core.Entity,K> T reload(java.lang.Class<T> entityClass,
                                                                  K id,
                                                                  java.lang.String... fetchPlanNames)

Deprecated.

DEPRECATED since v.6. Use find(Class, Object, String...)