oracle.toplink.essentials.internal.ejb.cmp3

Class EntityManagerImpl

java.lang.Object

oracle.toplink.essentials.internal.ejb.cmp3.base.EntityManagerImpl

oracle.toplink.essentials.internal.ejb.cmp3.EntityManagerImpl

All Implemented Interfaces:

javax.persistence.EntityManager

public class EntityManagerImpl
extends EntityManagerImpl
implements EntityManager

Purpose: Contains the implementation of the EntityManager.

Description: This class provides the implementation for the combined TopLink and EJB3.0 EntityManager class.

Responsibilities:It is responcible for tracking transaction state and the objects within that transaction.

See Also:

EntityManager, EntityManager

Field Summary

Fields inherited from class oracle.toplink.essentials.internal.ejb.cmp3.base.EntityManagerImpl

extended, extendedPersistenceContext, factory, isOpen, propagatePersistenceContext, serverSession, transaction

Constructor Summary

Constructors

Constructor and Description
EntityManagerImpl(EntityManagerFactoryImpl factory, java.util.Map properties, boolean propagePersistenceContext, boolean extended) Constructor called from the EntityManagerFactory to create an EntityManager
EntityManagerImpl(ServerSession serverSession, boolean propagatePersistenceContext, boolean extended) Constructor called from the EntityManagerFactory to create an EntityManager
EntityManagerImpl(ServerSession serverSession, java.util.Map properties, boolean propagePersistenceContext, boolean extended) Constructor called from the EntityManagerFactory to create an EntityManager
EntityManagerImpl(java.lang.String sessionName, boolean propagatePersistenceContext, boolean extended) Constructor returns an EntityManager assigned to the a particular ServerSession.

Method Summary

Modifier and Type	Method and Description
javax.persistence.Query	createNamedQuery(java.lang.String name) Create an instance of Query for executing a named query (in EJBQL or native SQL).
javax.persistence.Query	createNativeQuery(java.lang.String sqlString) Create an instance of Query for executing a native SQL query.
javax.persistence.Query	createNativeQuery(java.lang.String sqlString, java.lang.Class resultType) This method is used to create a query using SQL.
javax.persistence.Query	createNativeQuery(java.lang.String sqlString, java.lang.String resultSetMapping) Create an instance of Query for executing a native SQL query.
javax.persistence.Query	createQuery(Expression expression, java.lang.Class resultType) This method is used to create a query using a Toplink Expression and the return type.
javax.persistence.Query	createQuery(java.lang.String ejbqlString) Create an instance of Query for executing an EJBQL query.
<T> T	find(java.lang.Class<T> entityClass, java.lang.Object primaryKey) Find by primary key.
javax.persistence.FlushModeType	getFlushMode() Get the flush mode that applies to all objects contained in the persistence context.
<T> T	getReference(java.lang.Class<T> entityClass, java.lang.Object primaryKey) Get an instance, whose state may be lazily fetched.
javax.persistence.EntityTransaction	getTransaction() Returns the resource-level transaction object.
boolean	isFlushModeAUTO() Internal method.
<T> T	merge(T entity) Merge the state of the given entity into the current persistence context, using the unqualified class name as the entity name.
protected void	setEntityTransactionWrapper()
void	setFlushMode(javax.persistence.FlushModeType flushMode) Set the flush mode that applies to all objects contained in the persistence context.
protected void	setJTATransactionWrapper()

Methods inherited from class oracle.toplink.essentials.internal.ejb.cmp3.base.EntityManagerImpl

checkForTransaction, clear, close, contains, contains, createNativeQueryInternal, createQueryInternal, detectTransactionWrapper, find, findInternal, findInternal, flush, getActivePersistenceContext, getActiveSession, getDelegate, getServerSession, getSession, getTransactionalUnitOfWork_new, getUnitOfWork, isExtended, isOpen, joinTransaction, lock, mergeInternal, persist, refresh, remove, removeExtendedPersistenceContext, setRollbackOnly, shouldFlushBeforeQuery, shouldPropagatePersistenceContext, verifyOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.toplink.essentials.ejb.cmp3.EntityManager

getActiveSession, getServerSession, getSession, getUnitOfWork

Methods inherited from interface javax.persistence.EntityManager

clear, close, contains, flush, getDelegate, isOpen, joinTransaction, lock, persist, refresh, remove

Constructor Detail

EntityManagerImpl

public EntityManagerImpl(java.lang.String sessionName,
                         boolean propagatePersistenceContext,
                         boolean extended)

Constructor returns an EntityManager assigned to the a particular ServerSession.

Parameters:

sessionName - the ServerSession name that should be used. This constructor can potentially throw TopLink exceptions regarding the existence, or errors with the specified session.

EntityManagerImpl

public EntityManagerImpl(ServerSession serverSession,
                         boolean propagatePersistenceContext,
                         boolean extended)

Constructor called from the EntityManagerFactory to create an EntityManager

Parameters:

serverSession - the serverSession assigned to this deployment.

EntityManagerImpl

public EntityManagerImpl(ServerSession serverSession,
                         java.util.Map properties,
                         boolean propagePersistenceContext,
                         boolean extended)

Constructor called from the EntityManagerFactory to create an EntityManager

Parameters:

serverSession - the serverSession assigned to this deployment. Note: The properties argument is provided to allow properties to be passed into this EntityManager, but there are currently no such properties implemented

EntityManagerImpl

public EntityManagerImpl(EntityManagerFactoryImpl factory,
                         java.util.Map properties,
                         boolean propagePersistenceContext,
                         boolean extended)

Constructor called from the EntityManagerFactory to create an EntityManager

Parameters:

factory - the EntityMangerFactoryImpl that created this entity manager. Note: The properties argument is provided to allow properties to be passed into this EntityManager, but there are currently no such properties implemented

Method Detail

merge

public <T> T merge(T entity)

Merge the state of the given entity into the current persistence context, using the unqualified class name as the entity name.

Specified by:

merge in interface javax.persistence.EntityManager

Parameters:

entity -

Returns:

the instance that the state was merged to

find

public <T> T find(java.lang.Class<T> entityClass,
                  java.lang.Object primaryKey)

Find by primary key.

Specified by:

find in interface javax.persistence.EntityManager

Parameters:

entityClass -

primaryKey -

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

public <T> T getReference(java.lang.Class<T> entityClass,
                          java.lang.Object primaryKey)

Get an instance, whose state may be lazily fetched. If the requested instance does not exist in the database, throws EntityNotFoundException when the instance state is first accessed. (The container is permitted to throw EntityNotFoundException when get is called.) 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 javax.persistence.EntityManager

Parameters:

entityClass -

primaryKey -

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

EntityNotFoundException - if the entity state cannot be accessed

createQuery

public javax.persistence.Query createQuery(java.lang.String ejbqlString)

Create an instance of Query for executing an EJBQL query.

Specified by:

createQuery in interface javax.persistence.EntityManager

Parameters:

ejbqlString - an EJBQL query string

Returns:

the new query instance

createNamedQuery

public javax.persistence.Query createNamedQuery(java.lang.String name)

Create an instance of Query for executing a named query (in EJBQL or native SQL).

Specified by:

createNamedQuery in interface javax.persistence.EntityManager

Parameters:

name - the name of a query defined in metadata

Returns:

the new query instance

createNativeQuery

public javax.persistence.Query createNativeQuery(java.lang.String sqlString)

Create an instance of Query for executing a native SQL query.

Specified by:

createNativeQuery in interface javax.persistence.EntityManager

Parameters:

sqlString - a native SQL query string

Returns:

the new query instance

createNativeQuery

public javax.persistence.Query createNativeQuery(java.lang.String sqlString,
                                                 java.lang.Class resultType)

This method is used to create a query using SQL. The class, must be the expected return type.

Specified by:

createNativeQuery in interface javax.persistence.EntityManager

createNativeQuery

public javax.persistence.Query createNativeQuery(java.lang.String sqlString,
                                                 java.lang.String resultSetMapping)

Create an instance of Query for executing a native SQL query.

Specified by:

createNativeQuery in interface javax.persistence.EntityManager

Parameters:

sqlString - a native SQL query string

resultSetMapping - the name of the result set mapping

Returns:

the new query instance

Throws:

java.lang.IllegalArgumentException - if query string is not valid

getFlushMode

public javax.persistence.FlushModeType getFlushMode()

Get the flush mode that applies to all objects contained in the persistence context.

Specified by:

getFlushMode in interface javax.persistence.EntityManager

Returns:

flushMode

setFlushMode

public void setFlushMode(javax.persistence.FlushModeType flushMode)

Set the flush mode that applies to all objects contained in the persistence context.

Specified by:

setFlushMode in interface javax.persistence.EntityManager

Parameters:

flushMode -

createQuery

public javax.persistence.Query createQuery(Expression expression,
                                           java.lang.Class resultType)

This method is used to create a query using a Toplink Expression and the return type.

getTransaction

public javax.persistence.EntityTransaction getTransaction()

Returns the resource-level transaction object. The EntityTransaction instance may be used serially to begin and commit multiple transactions.

Specified by:

getTransaction in interface javax.persistence.EntityManager

Returns:

EntityTransaction instance

Throws:

java.lang.IllegalStateException - if invoked on a JTA EntityManager.

isFlushModeAUTO

public boolean isFlushModeAUTO()

Internal method. Indicates whether flushMode is AUTO.

Specified by:

isFlushModeAUTO in class EntityManagerImpl

Returns:

boolean

setJTATransactionWrapper

protected void setJTATransactionWrapper()

Specified by:

setJTATransactionWrapper in class EntityManagerImpl

setEntityTransactionWrapper

protected void setEntityTransactionWrapper()

Specified by:

setEntityTransactionWrapper in class EntityManagerImpl