org.hibernate.internal

Class AbstractSharedSessionContract

java.lang.Object

org.hibernate.internal.AbstractSharedSessionContract

All Implemented Interfaces:

Serializable, LobCreationContext, SharedSessionContractImplementor, QueryProducer, QueryProducerImplementor, JdbcSessionOwner, TransactionCoordinatorBuilder.Options, SharedSessionContract, WrapperOptions

Direct Known Subclasses:

AbstractSessionImpl, StatelessSessionImpl

public abstract class AbstractSharedSessionContract
extends Object
implements SharedSessionContractImplementor

Base class for SharedSessionContract/SharedSessionContractImplementor implementations. Intended for Session and StatelessSession implementations

NOTE: This implementation defines access to a number of instance state values in a manner that is not exactly concurrent-access safe. However, a Session/EntityManager is never intended to be used concurrently; therefore the condition is not expected and so a more synchronized/concurrency-safe is not defined to be as negligent (performance-wise) as possible. Some of these methods include:

• getEventListenerManager()
• getJdbcConnectionAccess()
• getJdbcServices()
• getTransaction() (and therefore related methods such as beginTransaction(), etc)

Author:

Steve Ebersole

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.engine.jdbc.LobCreationContext

LobCreationContext.Callback<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed
protected ExceptionConverter	exceptionConverter
protected boolean	waitingForAutoClose

Constructor Summary

Constructors

Constructor and Description
AbstractSharedSessionContract(SessionFactoryImpl factory, SessionCreationOptions options)

Method Summary

Modifier and Type	Method and Description
Transaction	accessTransaction() Provides access to the underlying transaction or creates a new transaction if one does not already exist or is active.
protected void	addSharedSessionTransactionObserver(TransactionCoordinator transactionCoordinator)
void	afterTransactionCompletion(boolean successful, boolean delayed) An after-completion callback to the owner.
protected void	applyQuerySettingsAndHints(Query query)
void	beforeTransactionCompletion() A before-completion callback to the owner.
Transaction	beginTransaction() Begin a unit of work and return the associated Transaction object.
protected <T> QueryImplementor<T>	buildQueryFromName(String name, Class<T> resultType)
void	checkOpen(boolean markForRollbackIfClosed) Performs a check whether the Session is open, and if not: if markForRollbackIfClosed is true, marks current transaction (if one) for rollback only throws an IllegalStateException (JPA defines the exception type)
protected void	checkOpenOrWaitingForAutoClose()
protected void	checkTransactionSynchStatus()
protected void	cleanupOnClose()
void	close() End the session by releasing the JDBC connection and cleaning up.
QueryImplementor	createNamedQuery(String name) The JPA-defined named query creation method.
<R> QueryImplementor<R>	createNamedQuery(String name, Class<R> resultClass) The JPA-defined named, typed query creation method.
protected <T> NativeQueryImplementor	createNativeQuery(NamedSQLQueryDefinition queryDefinition, Class<T> resultType)
NativeQueryImplementor	createNativeQuery(String sqlString) Create a NativeQuery instance for the given native (SQL) query
NativeQueryImplementor	createNativeQuery(String sqlString, Class resultClass) Create a NativeQuery instance for the given native (SQL) query using implicit mapping to the specified Java type.
NativeQueryImplementor	createNativeQuery(String sqlString, String resultSetMapping) Create a NativeQuery instance for the given native (SQL) query using implicit mapping to the specified Java type.
protected QueryImplementor	createQuery(NamedQueryDefinition queryDefinition)
protected <T> QueryImplementor<T>	createQuery(NamedQueryDefinition namedQueryDefinition, Class<T> resultType)
QueryImplementor	createQuery(String queryString) Create a Query instance for the given HQL/JPQL query string.
<T> QueryImplementor<T>	createQuery(String queryString, Class<T> resultClass) Create a typed Query instance for the given HQL/JPQL query string.
NativeQueryImplementor	createSQLQuery(String queryString) Create a NativeQuery instance for the given SQL query string.
ProcedureCall	createStoredProcedureCall(String procedureName) Creates a call to a stored procedure.
ProcedureCall	createStoredProcedureCall(String procedureName, Class... resultClasses) Creates a call to a stored procedure with specific result set entity mappings.
ProcedureCall	createStoredProcedureCall(String procedureName, String... resultSetMappings) Creates a call to a stored procedure with specific result set entity mappings.
protected void	delayedAfterCompletion()
protected void	errorIfClosed() Deprecated. (since 5.2) use SharedSessionContractImplementor.checkOpen() instead
<T> T	execute(LobCreationContext.Callback<T> callback) Execute the given callback, making sure it has access to a viable JDBC Connection.
EntityKey	generateEntityKey(Serializable id, EntityPersister persister) Hide the changing requirements of entity key creation
CacheMode	getCacheMode()
CacheTransactionSynchronization	getCacheTransactionSynchronization() The current CacheTransactionContext associated with the Session.
protected TransactionImplementor	getCurrentTransaction()
EntityNameResolver	getEntityNameResolver()
SessionEventListenerManager	getEventListenerManager()
ExceptionConverter	getExceptionConverter()
SessionFactoryImplementor	getFactory() Get the creating SessionFactoryImplementor
FlushModeType	getFlushMode() Get the flush mode for this session.
FlushMode	getHibernateFlushMode() Get the current flush mode for this session.
Interceptor	getInterceptor() Retrieves the interceptor currently in use by this event source.
Integer	getJdbcBatchSize() Get the Session-level JDBC batch size for the current Session.
JdbcConnectionAccess	getJdbcConnectionAccess()
JdbcCoordinator	getJdbcCoordinator()
JdbcServices	getJdbcServices()
JdbcSessionContext	getJdbcSessionContext()
TimeZone	getJdbcTimeZone() The JDBC TimeZone used when persisting Timestamp and DateTime properties into the database.
LobCreator	getLobCreator() Obtain access to the LobCreator
NativeQueryImplementor	getNamedNativeQuery(String name) Get a NativeQuery instance for a named native SQL query
ProcedureCall	getNamedProcedureCall(String name) Gets a ProcedureCall based on a named template
QueryImplementor	getNamedQuery(String name) Create a Query instance for the named query.
NativeQueryImplementor	getNamedSQLQuery(String name) Get a NativeQuery instance for a named native SQL query
protected NativeQueryImplementor	getNativeQueryImplementor(String queryString, boolean isOrdinalParameterZeroBased)
protected NativeSQLQueryPlan	getNativeQueryPlan(NativeSQLQuerySpecification spec)
protected HQLQueryPlan	getQueryPlan(String query, boolean shallow)
UUID	getSessionIdentifier() A UUID associated with each Session.
String	getTenantIdentifier() The multi-tenancy tenant identifier, if one.
Transaction	getTransaction() Get the Transaction instance associated with this session.
TransactionCoordinator	getTransactionCoordinator() Obtain the builder for TransactionCoordinator instances
long	getTransactionStartTimestamp() A "timestamp" at or before the start of the current transaction.
protected void	initQueryFromNamedDefinition(Query query, NamedQueryDefinition nqd)
boolean	isClosed() Checks whether the session is closed.
boolean	isConnected() Check if the session is currently connected.
boolean	isOpen() Check if the session is still open.
boolean	isOpenOrWaitingForAutoClose() Checks whether the session is open or is waiting for auto-close
boolean	isTransactionInProgress() Does this Session have an active Hibernate transaction or is there a JTA transaction in progress?
List	list(NativeSQLQuerySpecification spec, QueryParameters queryParameters) Execute a native SQL query, and return the results as a fully built list.
protected abstract Object	load(String entityName, Serializable identifier)
void	markForRollbackOnly() Marks current transaction (if one) for rollback only
protected void	pulseTransactionCoordinator()
SqlTypeDescriptor	remapSqlTypeDescriptor(SqlTypeDescriptor sqlTypeDescriptor) Allow remapping of descriptors for dealing with sql type.
protected void	removeSharedSessionTransactionObserver(TransactionCoordinator transactionCoordinator)
protected void	resultClassChecking(Class resultType, NamedSQLQueryDefinition namedQueryDefinition)
protected void	resultClassChecking(Class resultClass, Query hqlQuery)
ScrollableResultsImplementor	scroll(NativeSQLQuerySpecification spec, QueryParameters queryParameters) Execute a native SQL query, and return the results as a scrollable result.
void	setCacheMode(CacheMode cacheMode)
protected void	setClosed()
void	setFlushMode(FlushMode flushMode) Set the flush mode for this session.
void	setHibernateFlushMode(FlushMode flushMode) Set the flush mode for this session.
void	setJdbcBatchSize(Integer jdbcBatchSize) Set the Session-level JDBC batch size.
boolean	shouldAutoJoinTransaction() Indicates whether an active transaction should be automatically joined.
protected boolean	shouldCloseJdbcCoordinatorOnClose(boolean isTransactionCoordinatorShared)
void	startTransactionBoundary() Callback indicating recognition of entering into a transactional context whether that is explicitly via the Hibernate Transaction API or via registration of Hibernate's JTA Synchronization impl with a JTA Transaction
boolean	useStreamForLobBinding() Should streams be used for binding LOB values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.engine.spi.SharedSessionContractImplementor

afterScrollOperation, bestGuessEntityName, checkOpen, connection, executeNativeUpdate, executeUpdate, flush, getConfiguredJdbcBatchSize, getContextEntityIdentifier, getDontFlushFromFind, getEntityPersister, getEntityUsingInterceptor, getLoadQueryInfluencers, getPersistenceContext, getTimestamp, guessEntityName, immediateLoad, initializeCollection, instantiate, internalLoad, isAutoCloseSessionEnabled, isEventSource, isQueryParametersValidationEnabled, iterate, iterateFilter, list, list, listCustomQuery, listFilter, scroll, scroll, scrollCustomQuery, setAutoClear, shouldAutoClose

Methods inherited from interface org.hibernate.SharedSessionContract

createCriteria, createCriteria, createCriteria, createCriteria

Methods inherited from interface org.hibernate.resource.jdbc.spi.JdbcSessionOwner

afterTransactionBegin, flushBeforeTransactionCompletion

Field Detail

closed

protected boolean closed

waitingForAutoClose

protected boolean waitingForAutoClose

exceptionConverter

protected transient ExceptionConverter exceptionConverter

Constructor Detail

AbstractSharedSessionContract

public AbstractSharedSessionContract(SessionFactoryImpl factory,
                                     SessionCreationOptions options)

Method Detail

addSharedSessionTransactionObserver

protected void addSharedSessionTransactionObserver(TransactionCoordinator transactionCoordinator)

removeSharedSessionTransactionObserver

protected void removeSharedSessionTransactionObserver(TransactionCoordinator transactionCoordinator)

shouldAutoJoinTransaction

public boolean shouldAutoJoinTransaction()

Description copied from interface: TransactionCoordinatorBuilder.Options

Indicates whether an active transaction should be automatically joined. Only relevant for JTA-based TransactionCoordinator instances.

Specified by:

shouldAutoJoinTransaction in interface TransactionCoordinatorBuilder.Options

Returns:

true indicates the active transaction should be auto joined; false indicates it should not (until TransactionCoordinator.explicitJoin() is called).

getFactory

public SessionFactoryImplementor getFactory()

Description copied from interface: SharedSessionContractImplementor

Get the creating SessionFactoryImplementor

Specified by:

getFactory in interface SharedSessionContractImplementor

Specified by:

getFactory in interface QueryProducerImplementor

getInterceptor

public Interceptor getInterceptor()

Description copied from interface: SharedSessionContractImplementor

Retrieves the interceptor currently in use by this event source.

Specified by:

getInterceptor in interface SharedSessionContractImplementor

Returns:

The interceptor.

getJdbcCoordinator

public JdbcCoordinator getJdbcCoordinator()

Specified by:

getJdbcCoordinator in interface SharedSessionContractImplementor

getTransactionCoordinator

public TransactionCoordinator getTransactionCoordinator()

Description copied from interface: JdbcSessionOwner

Obtain the builder for TransactionCoordinator instances

Specified by:

getTransactionCoordinator in interface JdbcSessionOwner

Returns:

The TransactionCoordinatorBuilder

getJdbcSessionContext

public JdbcSessionContext getJdbcSessionContext()

Specified by:

getJdbcSessionContext in interface JdbcSessionOwner

getEntityNameResolver

public EntityNameResolver getEntityNameResolver()

getEventListenerManager

public SessionEventListenerManager getEventListenerManager()

Specified by:

getEventListenerManager in interface SharedSessionContractImplementor

getSessionIdentifier

public UUID getSessionIdentifier()

Description copied from interface: SharedSessionContractImplementor

A UUID associated with each Session. Useful mainly for logging.

Specified by:

getSessionIdentifier in interface SharedSessionContractImplementor

Returns:

The UUID

getTenantIdentifier

public String getTenantIdentifier()

Description copied from interface: SharedSessionContractImplementor

The multi-tenancy tenant identifier, if one.

Specified by:

getTenantIdentifier in interface SharedSessionContractImplementor

Specified by:

getTenantIdentifier in interface SharedSessionContract

Returns:

The tenant identifier; may be null

isOpen

public boolean isOpen()

Description copied from interface: SharedSessionContract

Check if the session is still open.

Specified by:

isOpen in interface SharedSessionContract

Returns:

boolean

isClosed

public boolean isClosed()

Description copied from interface: SharedSessionContractImplementor

Checks whether the session is closed. Provided separately from SharedSessionContract.isOpen() as this method does not attempt any JTA synchronization registration, where as SharedSessionContract.isOpen() does; which makes this one nicer to use for most internal purposes.

Specified by:

isClosed in interface SharedSessionContractImplementor

Returns:

true if the session is closed; false otherwise.

close

public void close()

Description copied from interface: SharedSessionContract

End the session by releasing the JDBC connection and cleaning up.

Specified by:

close in interface SharedSessionContract

setClosed

protected void setClosed()

shouldCloseJdbcCoordinatorOnClose

protected boolean shouldCloseJdbcCoordinatorOnClose(boolean isTransactionCoordinatorShared)

cleanupOnClose

protected void cleanupOnClose()

isOpenOrWaitingForAutoClose

public boolean isOpenOrWaitingForAutoClose()

Description copied from interface: SharedSessionContractImplementor

Checks whether the session is open or is waiting for auto-close

Specified by:

isOpenOrWaitingForAutoClose in interface SharedSessionContractImplementor

Returns:

true if the session is closed or if it's waiting for auto-close; false otherwise.

checkOpen

public void checkOpen(boolean markForRollbackIfClosed)

Description copied from interface: SharedSessionContractImplementor

Performs a check whether the Session is open, and if not:

• if markForRollbackIfClosed is true, marks current transaction (if one) for rollback only
• throws an IllegalStateException (JPA defines the exception type)

Specified by:

checkOpen in interface SharedSessionContractImplementor

checkOpenOrWaitingForAutoClose

protected void checkOpenOrWaitingForAutoClose()

errorIfClosed

@Deprecated
protected void errorIfClosed()

Deprecated. (since 5.2) use SharedSessionContractImplementor.checkOpen() instead

markForRollbackOnly

public void markForRollbackOnly()

Description copied from interface: SharedSessionContractImplementor

Marks current transaction (if one) for rollback only

Specified by:

markForRollbackOnly in interface SharedSessionContractImplementor

isTransactionInProgress

public boolean isTransactionInProgress()

Description copied from interface: SharedSessionContractImplementor

Does this Session have an active Hibernate transaction or is there a JTA transaction in progress?

Specified by:

isTransactionInProgress in interface SharedSessionContractImplementor

getTransaction

public Transaction getTransaction()
                           throws HibernateException

Description copied from interface: SharedSessionContract

Get the Transaction instance associated with this session. The concrete type of the returned Transaction object is determined by the hibernate.transaction_factory property.

Specified by:

getTransaction in interface SharedSessionContract

Returns:

a Transaction instance

Throws:

HibernateException

accessTransaction

public Transaction accessTransaction()

Description copied from interface: SharedSessionContractImplementor

Provides access to the underlying transaction or creates a new transaction if one does not already exist or is active. This is primarily for internal or integrator use.

Specified by:

accessTransaction in interface SharedSessionContractImplementor

Returns:

the transaction

startTransactionBoundary

public void startTransactionBoundary()

Description copied from interface: JdbcSessionOwner

Callback indicating recognition of entering into a transactional context whether that is explicitly via the Hibernate Transaction API or via registration of Hibernate's JTA Synchronization impl with a JTA Transaction

Specified by:

startTransactionBoundary in interface JdbcSessionOwner

beforeTransactionCompletion

public void beforeTransactionCompletion()

Description copied from interface: JdbcSessionOwner

A before-completion callback to the owner.

Specified by:

beforeTransactionCompletion in interface JdbcSessionOwner

afterTransactionCompletion

public void afterTransactionCompletion(boolean successful,
                                       boolean delayed)

Description copied from interface: JdbcSessionOwner

An after-completion callback to the owner.

Specified by:

afterTransactionCompletion in interface JdbcSessionOwner

Parameters:

successful - Was the transaction successful?

delayed - Is this a delayed after transaction completion call (aka after a timeout)?

getCacheTransactionSynchronization

public CacheTransactionSynchronization getCacheTransactionSynchronization()

Description copied from interface: SharedSessionContractImplementor

The current CacheTransactionContext associated with the Session. This may return null when the Session is not currently part of a transaction.

Specified by:

getCacheTransactionSynchronization in interface SharedSessionContractImplementor

getTransactionStartTimestamp

public long getTransactionStartTimestamp()

Description copied from interface: SharedSessionContractImplementor

A "timestamp" at or before the start of the current transaction.

Specified by:

getTransactionStartTimestamp in interface SharedSessionContractImplementor

beginTransaction

public Transaction beginTransaction()

Description copied from interface: SharedSessionContract

Begin a unit of work and return the associated Transaction object. If a new underlying transaction is required, begin the transaction. Otherwise continue the new work in the context of the existing underlying transaction.

Specified by:

beginTransaction in interface SharedSessionContract

Returns:

a Transaction instance

See Also:

SharedSessionContract.getTransaction()

checkTransactionSynchStatus

protected void checkTransactionSynchStatus()

pulseTransactionCoordinator

protected void pulseTransactionCoordinator()

delayedAfterCompletion

protected void delayedAfterCompletion()

getCurrentTransaction

protected TransactionImplementor getCurrentTransaction()

isConnected

public boolean isConnected()

Description copied from interface: SharedSessionContract

Check if the session is currently connected.

Specified by:

isConnected in interface SharedSessionContract

Returns:

boolean

getJdbcConnectionAccess

public JdbcConnectionAccess getJdbcConnectionAccess()

Specified by:

getJdbcConnectionAccess in interface JdbcSessionOwner

generateEntityKey

public EntityKey generateEntityKey(Serializable id,
                                   EntityPersister persister)

Description copied from interface: SharedSessionContractImplementor

Hide the changing requirements of entity key creation

Specified by:

generateEntityKey in interface SharedSessionContractImplementor

Parameters:

id - The entity id

persister - The entity persister

Returns:

The entity key

useStreamForLobBinding

public boolean useStreamForLobBinding()

Description copied from interface: WrapperOptions

Should streams be used for binding LOB values.

Specified by:

useStreamForLobBinding in interface WrapperOptions

Returns:

true/false

getLobCreator

public LobCreator getLobCreator()

Description copied from interface: WrapperOptions

Obtain access to the LobCreator

Specified by:

getLobCreator in interface WrapperOptions

Returns:

The LOB creator

execute

public <T> T execute(LobCreationContext.Callback<T> callback)

Description copied from interface: LobCreationContext

Execute the given callback, making sure it has access to a viable JDBC Connection.

Specified by:

execute in interface LobCreationContext

Type Parameters:

T - The Java type of the type of LOB being created. One of Blob, Clob, NClob

Parameters:

callback - The callback to execute .

Returns:

The LOB created by the callback.

remapSqlTypeDescriptor

public SqlTypeDescriptor remapSqlTypeDescriptor(SqlTypeDescriptor sqlTypeDescriptor)

Description copied from interface: WrapperOptions

Allow remapping of descriptors for dealing with sql type.

Specified by:

remapSqlTypeDescriptor in interface WrapperOptions

Parameters:

sqlTypeDescriptor - The known descriptor

Returns:

The remapped descriptor. May be the same as the known descriptor indicating no remapping.

getJdbcTimeZone

public TimeZone getJdbcTimeZone()

Description copied from interface: WrapperOptions

The JDBC TimeZone used when persisting Timestamp and DateTime properties into the database. This setting is used when storing timestamps using the PreparedStatement.setTimestamp(int, Timestamp, Calendar) method. This way, the storage TimeZone can differ from the default JVM TimeZone given by TimeZone.getDefault().

Specified by:

getJdbcTimeZone in interface WrapperOptions

Returns:

JDBC TimeZone

getJdbcServices

public JdbcServices getJdbcServices()

Specified by:

getJdbcServices in interface SharedSessionContractImplementor

setFlushMode

public void setFlushMode(FlushMode flushMode)

Description copied from interface: SharedSessionContractImplementor

Set the flush mode for this session.

The flush mode determines the points at which the session is flushed. Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory.

For a logically "read only" session, it is reasonable to set the session's flush mode to FlushMode.MANUAL at the start of the session (in order to achieve some extra performance).

Specified by:

setFlushMode in interface SharedSessionContractImplementor

Parameters:

flushMode - the new flush mode

getFlushMode

public FlushModeType getFlushMode()

Description copied from interface: SharedSessionContractImplementor

Get the flush mode for this session.

For users of the Hibernate native APIs, we've had to rename this method as defined by Hibernate historically because the JPA contract defines a method of the same name, but returning the JPA FlushModeType rather than Hibernate's FlushMode. For the former behavior, use SharedSessionContractImplementor.getHibernateFlushMode() instead.

Specified by:

getFlushMode in interface SharedSessionContractImplementor

Returns:

The FlushModeType in effect for this Session.

setHibernateFlushMode

public void setHibernateFlushMode(FlushMode flushMode)

Description copied from interface: SharedSessionContractImplementor

Set the flush mode for this session.

The flush mode determines the points at which the session is flushed. Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory.

For a logically "read only" session, it is reasonable to set the session's flush mode to FlushMode.MANUAL at the start of the session (in order to achieve some extra performance).

Specified by:

setHibernateFlushMode in interface SharedSessionContractImplementor

Parameters:

flushMode - the new flush mode

getHibernateFlushMode

public FlushMode getHibernateFlushMode()

Description copied from interface: SharedSessionContractImplementor

Get the current flush mode for this session.

Specified by:

getHibernateFlushMode in interface SharedSessionContractImplementor

Specified by:

getHibernateFlushMode in interface QueryProducerImplementor

Returns:

The flush mode

getCacheMode

public CacheMode getCacheMode()

Specified by:

getCacheMode in interface SharedSessionContractImplementor

Specified by:

getCacheMode in interface QueryProducerImplementor

setCacheMode

public void setCacheMode(CacheMode cacheMode)

Specified by:

setCacheMode in interface SharedSessionContractImplementor

getQueryPlan

protected HQLQueryPlan getQueryPlan(String query,
                                    boolean shallow)
                             throws HibernateException

Throws:

HibernateException

getNativeQueryPlan

protected NativeSQLQueryPlan getNativeQueryPlan(NativeSQLQuerySpecification spec)
                                         throws HibernateException

Throws:

HibernateException

getNamedQuery

public QueryImplementor getNamedQuery(String name)

Description copied from interface: QueryProducer

Create a Query instance for the named query.

Specified by:

getNamedQuery in interface QueryProducer

Specified by:

getNamedQuery in interface QueryProducerImplementor

Parameters:

name - the name of a pre-defined, named query

Returns:

The Query instance for manipulation and execution

createQuery

protected QueryImplementor createQuery(NamedQueryDefinition queryDefinition)

initQueryFromNamedDefinition

protected void initQueryFromNamedDefinition(Query query,
                                            NamedQueryDefinition nqd)

createQuery

public QueryImplementor createQuery(String queryString)

Description copied from interface: QueryProducer

Create a Query instance for the given HQL/JPQL query string.

Specified by:

createQuery in interface QueryProducer

Specified by:

createQuery in interface QueryProducerImplementor

Parameters:

queryString - The HQL/JPQL query

Returns:

The Query instance for manipulation and execution

See Also:

EntityManager.createQuery(String)

applyQuerySettingsAndHints

protected void applyQuerySettingsAndHints(Query query)

createQuery

public <T> QueryImplementor<T> createQuery(String queryString,
                                           Class<T> resultClass)

Description copied from interface: QueryProducer

Create a typed Query instance for the given HQL/JPQL query string.

Specified by:

createQuery in interface QueryProducer

Specified by:

createQuery in interface QueryProducerImplementor

Parameters:

queryString - The HQL/JPQL query

Returns:

The Query instance for manipulation and execution

See Also:

EntityManager.createQuery(String,Class)

resultClassChecking

protected void resultClassChecking(Class resultClass,
                                   Query hqlQuery)

createNamedQuery

public QueryImplementor createNamedQuery(String name)

Description copied from interface: QueryProducer

The JPA-defined named query creation method. This form can represent an HQL/JPQL query or a native query.

Specified by:

createNamedQuery in interface QueryProducer

Specified by:

createNamedQuery in interface QueryProducerImplementor

Parameters:

name - the name of a pre-defined, named query

Returns:

The Query instance for manipulation and execution

See Also:

EntityManager.createNamedQuery(String)

buildQueryFromName

protected <T> QueryImplementor<T> buildQueryFromName(String name,
                                                     Class<T> resultType)

createQuery

protected <T> QueryImplementor<T> createQuery(NamedQueryDefinition namedQueryDefinition,
                                              Class<T> resultType)

createNativeQuery

protected <T> NativeQueryImplementor createNativeQuery(NamedSQLQueryDefinition queryDefinition,
                                                       Class<T> resultType)

resultClassChecking

protected void resultClassChecking(Class resultType,
                                   NamedSQLQueryDefinition namedQueryDefinition)

createNamedQuery

public <R> QueryImplementor<R> createNamedQuery(String name,
                                                Class<R> resultClass)

Description copied from interface: QueryProducer

The JPA-defined named, typed query creation method. This form can only represent an HQL/JPQL query (not a native query).

Specified by:

createNamedQuery in interface QueryProducer

Specified by:

createNamedQuery in interface QueryProducerImplementor

Parameters:

name - the name of a query defined in metadata

resultClass - the type of the query result

Returns:

The Query instance for manipulation and execution

See Also:

EntityManager.createNamedQuery(String,Class)

createNativeQuery

public NativeQueryImplementor createNativeQuery(String sqlString)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native (SQL) query

Specified by:

createNativeQuery in interface QueryProducer

Specified by:

createNativeQuery in interface QueryProducerImplementor

Parameters:

sqlString - a native SQL query string

Returns:

The NativeQuery instance for manipulation and execution

See Also:

EntityManager.createNativeQuery(String)

createNativeQuery

public NativeQueryImplementor createNativeQuery(String sqlString,
                                                Class resultClass)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native (SQL) query using implicit mapping to the specified Java type.

Specified by:

createNativeQuery in interface QueryProducer

Specified by:

createNativeQuery in interface QueryProducerImplementor

Parameters:

sqlString - Native (SQL) query string

resultClass - The Java type to map results to

Returns:

The NativeQuery instance for manipulation and execution

See Also:

EntityManager.createNativeQuery(String,Class)

createNativeQuery

public NativeQueryImplementor createNativeQuery(String sqlString,
                                                String resultSetMapping)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native (SQL) query using implicit mapping to the specified Java type.

Specified by:

createNativeQuery in interface QueryProducer

Specified by:

createNativeQuery in interface QueryProducerImplementor

Parameters:

sqlString - Native (SQL) query string

resultSetMapping - The explicit (named) result mapping

Returns:

The NativeQuery instance for manipulation and execution

See Also:

EntityManager.createNativeQuery(String,Class), SqlResultSetMapping

getNamedNativeQuery

public NativeQueryImplementor getNamedNativeQuery(String name)

Description copied from interface: QueryProducer

Get a NativeQuery instance for a named native SQL query

Specified by:

getNamedNativeQuery in interface QueryProducer

Specified by:

getNamedNativeQuery in interface QueryProducerImplementor

Parameters:

name - The name of the pre-defined query

Returns:

The NativeQuery instance for manipulation and execution

createSQLQuery

public NativeQueryImplementor createSQLQuery(String queryString)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given SQL query string.

Specified by:

createSQLQuery in interface QueryProducer

Specified by:

createSQLQuery in interface QueryProducerImplementor

Parameters:

queryString - The SQL query

Returns:

The query instance for manipulation and execution

getNativeQueryImplementor

protected NativeQueryImplementor getNativeQueryImplementor(String queryString,
                                                           boolean isOrdinalParameterZeroBased)

getNamedSQLQuery

public NativeQueryImplementor getNamedSQLQuery(String name)

Description copied from interface: QueryProducer

Get a NativeQuery instance for a named native SQL query

Specified by:

getNamedSQLQuery in interface QueryProducer

Specified by:

getNamedSQLQuery in interface QueryProducerImplementor

Parameters:

name - The name of the pre-defined query

Returns:

The NativeQuery instance for manipulation and execution

getNamedProcedureCall

public ProcedureCall getNamedProcedureCall(String name)

Description copied from interface: SharedSessionContract

Gets a ProcedureCall based on a named template

Specified by:

getNamedProcedureCall in interface SharedSessionContract

Parameters:

name - The name given to the template

Returns:

The ProcedureCall

See Also:

NamedStoredProcedureQuery

createStoredProcedureCall

public ProcedureCall createStoredProcedureCall(String procedureName)

Description copied from interface: SharedSessionContract

Creates a call to a stored procedure.

Specified by:

createStoredProcedureCall in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

Returns:

The representation of the procedure call.

createStoredProcedureCall

public ProcedureCall createStoredProcedureCall(String procedureName,
                                               Class... resultClasses)

Description copied from interface: SharedSessionContract

Creates a call to a stored procedure with specific result set entity mappings. Each class named is considered a "root return".

Specified by:

createStoredProcedureCall in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

resultClasses - The entity(s) to map the result on to.

Returns:

The representation of the procedure call.

createStoredProcedureCall

public ProcedureCall createStoredProcedureCall(String procedureName,
                                               String... resultSetMappings)

Description copied from interface: SharedSessionContract

Creates a call to a stored procedure with specific result set entity mappings.

Specified by:

createStoredProcedureCall in interface SharedSessionContract

Parameters:

procedureName - The name of the procedure.

resultSetMappings - The explicit result set mapping(s) to use for mapping the results

Returns:

The representation of the procedure call.

load

protected abstract Object load(String entityName,
                               Serializable identifier)

list

public List list(NativeSQLQuerySpecification spec,
                 QueryParameters queryParameters)

Description copied from interface: SharedSessionContractImplementor

Execute a native SQL query, and return the results as a fully built list.

Specified by:

list in interface SharedSessionContractImplementor

Parameters:

spec - The specification of the native SQL query to execute.

queryParameters - The parameters by which to perform the execution.

Returns:

The result list.

scroll

public ScrollableResultsImplementor scroll(NativeSQLQuerySpecification spec,
                                           QueryParameters queryParameters)

Description copied from interface: SharedSessionContractImplementor

Execute a native SQL query, and return the results as a scrollable result.

Specified by:

scroll in interface SharedSessionContractImplementor

Parameters:

spec - The specification of the native SQL query to execute.

queryParameters - The parameters by which to perform the execution.

Returns:

The resulting scrollable result.

getExceptionConverter

public ExceptionConverter getExceptionConverter()

Specified by:

getExceptionConverter in interface SharedSessionContractImplementor

getJdbcBatchSize

public Integer getJdbcBatchSize()

Description copied from interface: SharedSessionContract

Get the Session-level JDBC batch size for the current Session. Overrides the SessionFactory JDBC batch size defined by the hibernate.default_batch_fetch_size configuration property for the scope of the current Session.

Specified by:

getJdbcBatchSize in interface JdbcSessionOwner

Specified by:

getJdbcBatchSize in interface SharedSessionContract

Returns:

Session-level JDBC batch size

See Also:

SessionFactoryOptions.getJdbcBatchSize(), SessionFactoryBuilder.applyJdbcBatchSize(int)

setJdbcBatchSize

public void setJdbcBatchSize(Integer jdbcBatchSize)

Description copied from interface: SharedSessionContract

Set the Session-level JDBC batch size. Overrides the SessionFactory JDBC batch size defined by the hibernate.default_batch_fetch_size configuration property for the scope of the current Session.

Specified by:

setJdbcBatchSize in interface SharedSessionContract

Parameters:

jdbcBatchSize - Session-level JDBC batch size

See Also:

SessionFactoryOptions.getJdbcBatchSize(), SessionFactoryBuilder.applyJdbcBatchSize(int)