com.haulmont.cuba.core.sys

Class EntityManagerImpl

java.lang.Object

com.haulmont.cuba.core.sys.EntityManagerImpl

All Implemented Interfaces:

EntityManager

@Component(value="cuba_EntityManager")
 @Scope(value="prototype")
public class EntityManagerImpl
extends java.lang.Object
implements EntityManager

Field Summary

Fields inherited from interface com.haulmont.cuba.core.EntityManager

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 sql) 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 sql, 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 qlStr) 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> clazz, 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 since v.6.
<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.

Methods inherited from class java.lang.Object

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

Method Detail

getDelegate

public javax.persistence.EntityManager getDelegate()

Specified by:

getDelegate in interface EntityManager

Returns:

underlying implementation provided by ORM

isSoftDeletion

public boolean isSoftDeletion()

Specified by:

isSoftDeletion in interface EntityManager

Returns:

true if the EntityManager is in SoftDeletion mode

setSoftDeletion

public void setSoftDeletion(boolean softDeletion)

Description copied from interface: EntityManager

Set SoftDeletion mode for this EntityManager.

Specified by:

setSoftDeletion in interface EntityManager

Parameters:

softDeletion - mode

persist

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

Description copied from interface: EntityManager

Make an instance managed and persistent.

Specified by:

persist in interface EntityManager

Parameters:

entity - entity instance

merge

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

Description copied from interface: EntityManager

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.

Specified by:

merge in interface EntityManager

Parameters:

entity - entity instance

Returns:

the instance that the state was merged to

See Also:

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

merge

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

Deprecated.

Description copied from interface: EntityManager

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

Specified by:

merge in interface EntityManager

merge

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

Deprecated.

Description copied from interface: EntityManager

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

Specified by:

merge in interface EntityManager

remove

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

Description copied from interface: EntityManager

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

Specified by:

remove in interface EntityManager

Parameters:

entity - entity instance

find

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

Description copied from interface: EntityManager

Find by primary key.

Specified by:

find in interface EntityManager

Parameters:

entityClass - entity class

id - entity id

Returns:

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

find

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

Description copied from interface: EntityManager

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.

Specified by:

find in interface EntityManager

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

find

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

Description copied from interface: EntityManager

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.

Specified by:

find in interface EntityManager

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

getReference

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

Description copied from interface: EntityManager

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.

Specified by:

getReference in interface EntityManager

Parameters:

clazz - entity class

id - entity id

Returns:

the found entity instance

createQuery

public Query createQuery()

Description copied from interface: EntityManager

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

Specified by:

createQuery in interface EntityManager

Returns:

the new query instance

createQuery

public Query createQuery(java.lang.String qlStr)

Description copied from interface: EntityManager

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

Specified by:

createQuery in interface EntityManager

Parameters:

qlStr - a Java Persistence query string

Returns:

the new query instance

createQuery

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

Description copied from interface: EntityManager

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.

Specified by:

createQuery in interface EntityManager

Parameters:

qlString - a Java Persistence query string

resultClass - expected result class

Returns:

the new query instance

createNativeQuery

public Query createNativeQuery()

Description copied from interface: EntityManager

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

Specified by:

createNativeQuery in interface EntityManager

Returns:

the new query instance

createNativeQuery

public Query createNativeQuery(java.lang.String sql)

Description copied from interface: EntityManager

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

Specified by:

createNativeQuery in interface EntityManager

Parameters:

sql - a native SQL query string

Returns:

the new query instance

createNativeQuery

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

Description copied from interface: EntityManager

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

Specified by:

createNativeQuery in interface EntityManager

Parameters:

sql - a native SQL query string

resultClass - expected result class

Returns:

the new query instance

fetch

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

Deprecated.

Description copied from interface: EntityManager

DEPRECATED since v.6

Specified by:

fetch in interface EntityManager

reload

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

Description copied from interface: EntityManager

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

Specified by:

reload in interface EntityManager

reload

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

Description copied from interface: EntityManager

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.

Specified by:

reload in interface EntityManager

Parameters:

entity - entity instance to reload

fetchPlanNames - array of fetch plan names

Returns:

reloaded entity instance, or null if it has been deleted

reloadNN

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

Description copied from interface: EntityManager

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.

Specified by:

reloadNN in interface EntityManager

Parameters:

entity - entity instance to reload

fetchPlanNames - array of fetch plan names

Returns:

reloaded entity instance

flush

public void flush()

Description copied from interface: EntityManager

Synchronize the persistence context to the underlying database.

Specified by:

flush in interface EntityManager

detach

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

Specified by:

detach in interface EntityManager

getConnection

public java.sql.Connection getConnection()

Specified by:

getConnection in interface EntityManager

Returns:

database connection associated with the current transaction.

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