com.mysema.query.jpa.hibernate

Class AbstractHibernateQuery<Q extends AbstractHibernateQuery<Q>>

java.lang.Object

com.mysema.query.support.QueryBase<Q>

com.mysema.query.support.ProjectableQuery<Q>

com.mysema.query.jpa.JPAQueryBase<Q>

com.mysema.query.jpa.hibernate.AbstractHibernateQuery<Q>

Type Parameters:

Q -

All Implemented Interfaces:

FilteredClause<JPQLQuery>, JPACommonQuery<JPQLQuery>, JPQLQuery, Projectable, Query<JPQLQuery>, SimpleQuery<JPQLQuery>

Direct Known Subclasses:

HibernateQuery

public abstract class AbstractHibernateQuery<Q extends AbstractHibernateQuery<Q>>
extends JPAQueryBase<Q>

Abstract base class for Hibernate API based implementations of the JPQL interface

Author:

tiwe

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	cacheable
protected String	cacheRegion
protected String	comment
protected int	fetchSize
protected org.hibernate.FlushMode	flushMode
protected Map<Path<?>,org.hibernate.LockMode>	lockModes
protected Boolean	readOnly
protected int	timeout

Fields inherited from class com.mysema.query.jpa.JPAQueryBase

queryMixin

Fields inherited from class com.mysema.query.support.QueryBase

MDC_PARAMETERS, MDC_QUERY

Constructor Summary

Constructors

Constructor and Description
AbstractHibernateQuery(org.hibernate.Session session)
AbstractHibernateQuery(SessionHolder session, JPQLTemplates patterns, QueryMetadata metadata)

Method Summary

Modifier and Type	Method and Description
protected void	cleanupMDC()
Q	clone() Clone the state of this query to a new instance
protected void	clone(Q query)
Q	clone(org.hibernate.Session session) Clone the state of this query to a new instance with the given Session
protected abstract Q	clone(SessionHolder sessionHolder)
Q	clone(org.hibernate.StatelessSession session) Clone the state of this query to a new instance with the given StatelessSession
long	count() return the amount of matched rows
org.hibernate.Query	createQuery(Expression<?> expr) Expose the original Hibernate query for the given projection
org.hibernate.Query	createQuery(Expression<?>[] args) Expose the original Hibernate query for the given projection
org.hibernate.Query	createQuery(Expression<?> expr1, Expression<?> expr2, Expression<?>... rest) Expose the original Hibernate query for the given projection
protected JPQLSerializer	createSerializer()
com.mysema.commons.lang.CloseableIterator<Tuple>	iterate(Expression<?>... args) Return the query results as an Iterator. Entities returned as results are initialized on demand.
<RT> com.mysema.commons.lang.CloseableIterator<RT>	iterate(Expression<RT> projection) Return the query results as an Iterator.
List<Tuple>	list(Expression<?>... args) list the results for the given projection An empty list is returned for no results.
<RT> List<RT>	list(Expression<RT> expr) list the results for the given projection An empty list is returned for no results.
SearchResults<Tuple>	listResults(Expression<?>... args) list the results for the given projection
<RT> SearchResults<RT>	listResults(Expression<RT> expr) list the results for the given projection
protected void	logQuery(String queryString, Map<Object,String> parameters)
protected void	reset()
org.hibernate.ScrollableResults	scroll(org.hibernate.ScrollMode mode, Expression<?>... args) Return the query results as ScrollableResults.
org.hibernate.ScrollableResults	scroll(org.hibernate.ScrollMode mode, Expression<?> expr) Return the query results as ScrollableResults.
Q	setCacheable(boolean cacheable) Enable caching of this query result set.
Q	setCacheRegion(String cacheRegion) Set the name of the cache region.
Q	setComment(String comment) Add a comment to the generated SQL.
Q	setFetchSize(int fetchSize) Set a fetch size for the underlying JDBC query.
Q	setFlushMode(org.hibernate.FlushMode flushMode) Override the current session flush mode, just for this query.
Q	setLockMode(Path<?> path, org.hibernate.LockMode lockMode) Set the lock mode for the given path.
Q	setReadOnly(boolean readOnly) Entities retrieved by this query will be loaded in a read-only mode where Hibernate will never dirty-check them or make changes persistent.
Q	setTimeout(int timeout) Set a timeout for the underlying JDBC query.
Tuple	uniqueResult(Expression<?>... args) return a unique result for the given projection or null if no result is found
<RT> RT	uniqueResult(Expression<RT> expr) return a unique result for the given projection or null if no result is found

Methods inherited from class com.mysema.query.jpa.JPAQueryBase

exists, fetch, fetchAll, from, from, fullJoin, fullJoin, fullJoin, fullJoin, fullJoin, fullJoin, getMetadata, getTemplates, innerJoin, innerJoin, innerJoin, innerJoin, innerJoin, innerJoin, join, join, join, join, join, join, leftJoin, leftJoin, leftJoin, leftJoin, leftJoin, leftJoin, on, on, rightJoin, rightJoin, rightJoin, rightJoin, rightJoin, rightJoin, serialize, serialize, toString

Methods inherited from class com.mysema.query.support.ProjectableQuery

map, notExists, singleResult, singleResult, transform, uniqueResult

Methods inherited from class com.mysema.query.support.QueryBase

distinct, equals, groupBy, groupBy, hashCode, having, having, limit, offset, orderBy, orderBy, restrict, set, where, where

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.mysema.query.Query

groupBy, having

Methods inherited from interface com.mysema.query.SimpleQuery

distinct, limit, offset, orderBy, restrict, set

Methods inherited from interface com.mysema.query.FilteredClause

where

Methods inherited from interface com.mysema.query.Projectable

map, notExists, singleResult, singleResult, transform

Field Detail

cacheable

@Nullable
protected Boolean cacheable

readOnly

@Nullable
protected Boolean readOnly

cacheRegion

@Nullable
protected String cacheRegion

comment

@Nullable
protected String comment

fetchSize

protected int fetchSize

lockModes

protected final Map<Path<?>,org.hibernate.LockMode> lockModes

flushMode

@Nullable
protected org.hibernate.FlushMode flushMode

timeout

protected int timeout

Constructor Detail

AbstractHibernateQuery

public AbstractHibernateQuery(org.hibernate.Session session)

AbstractHibernateQuery

public AbstractHibernateQuery(SessionHolder session,
                              JPQLTemplates patterns,
                              QueryMetadata metadata)

Method Detail

count

public long count()

Description copied from interface: Projectable

return the amount of matched rows

createQuery

public org.hibernate.Query createQuery(Expression<?> expr)

Expose the original Hibernate query for the given projection

Parameters:

expr -

Returns:

createQuery

public org.hibernate.Query createQuery(Expression<?> expr1,
                                       Expression<?> expr2,
                                       Expression<?>... rest)

Expose the original Hibernate query for the given projection

Parameters:

expr1 -

expr2 -

rest -

Returns:

createQuery

public org.hibernate.Query createQuery(Expression<?>[] args)

Expose the original Hibernate query for the given projection

Parameters:

args -

Returns:

iterate

public com.mysema.commons.lang.CloseableIterator<Tuple> iterate(Expression<?>... args)

Return the query results as an Iterator.

Entities returned as results are initialized on demand. The first SQL query returns identifiers only.

Returns:

iterate

public <RT> com.mysema.commons.lang.CloseableIterator<RT> iterate(Expression<RT> projection)

Return the query results as an Iterator. If the query contains multiple results pre row, the results are returned in an instance of Object[].

Entities returned as results are initialized on demand. The first SQL query returns identifiers only.

Type Parameters:

RT - generic type of the Iterator

Returns:

an Iterator over the projection

list

public List<Tuple> list(Expression<?>... args)

Description copied from interface: Projectable

list the results for the given projection An empty list is returned for no results.

Specified by:

list in interface Projectable

Overrides:

list in class ProjectableQuery<Q extends AbstractHibernateQuery<Q>>

Returns:

list

public <RT> List<RT> list(Expression<RT> expr)

Description copied from interface: Projectable

list the results for the given projection An empty list is returned for no results.

Specified by:

list in interface Projectable

Overrides:

list in class ProjectableQuery<Q extends AbstractHibernateQuery<Q>>

Type Parameters:

RT - generic type of the List

Returns:

a List over the projection

listResults

public SearchResults<Tuple> listResults(Expression<?>... args)

Description copied from interface: Projectable

list the results for the given projection

Returns:

listResults

public <RT> SearchResults<RT> listResults(Expression<RT> expr)

Description copied from interface: Projectable

list the results for the given projection

Returns:

logQuery

protected void logQuery(String queryString,
                        Map<Object,String> parameters)

cleanupMDC

protected void cleanupMDC()

reset

protected void reset()

Overrides:

reset in class JPAQueryBase<Q extends AbstractHibernateQuery<Q>>

scroll

public org.hibernate.ScrollableResults scroll(org.hibernate.ScrollMode mode,
                                              Expression<?> expr)

Return the query results as ScrollableResults. The scrollability of the returned results depends upon JDBC driver support for scrollable ResultSets.

Parameters:

mode -

expr -

Returns:

scroll

public org.hibernate.ScrollableResults scroll(org.hibernate.ScrollMode mode,
                                              Expression<?>... args)

Return the query results as ScrollableResults. The scrollability of the returned results depends upon JDBC driver support for scrollable ResultSets.

Parameters:

mode -

args -

Returns:

setCacheable

public Q setCacheable(boolean cacheable)

Enable caching of this query result set.

Parameters:

cacheable - Should the query results be cacheable?

setCacheRegion

public Q setCacheRegion(String cacheRegion)

Set the name of the cache region.

Parameters:

cacheRegion - the name of a query cache region, or null for the default query cache

setComment

public Q setComment(String comment)

Add a comment to the generated SQL.

Parameters:

comment -

Returns:

setFetchSize

public Q setFetchSize(int fetchSize)

Set a fetch size for the underlying JDBC query.

Parameters:

fetchSize - the fetch size

setLockMode

public Q setLockMode(Path<?> path,
                     org.hibernate.LockMode lockMode)

Set the lock mode for the given path.

setFlushMode

public Q setFlushMode(org.hibernate.FlushMode flushMode)

Override the current session flush mode, just for this query.

setReadOnly

public Q setReadOnly(boolean readOnly)

Entities retrieved by this query will be loaded in a read-only mode where Hibernate will never dirty-check them or make changes persistent.

setTimeout

public Q setTimeout(int timeout)

Set a timeout for the underlying JDBC query.

Parameters:

timeout - the timeout in seconds

uniqueResult

public Tuple uniqueResult(Expression<?>... args)

Description copied from interface: Projectable

return a unique result for the given projection or null if no result is found

There is some ambiguity for missing results and null valued results, for disambiguation use the list or iterate methods instead.

Specified by:

uniqueResult in interface Projectable

Overrides:

uniqueResult in class JPAQueryBase<Q extends AbstractHibernateQuery<Q>>

Returns:

uniqueResult

public <RT> RT uniqueResult(Expression<RT> expr)

Description copied from interface: Projectable

return a unique result for the given projection or null if no result is found

There is some ambiguity for missing results and null valued results, for disambiguation use the list or iterate methods instead.

Type Parameters:

RT - return type

Returns:

the result or null for an empty result

createSerializer

protected JPQLSerializer createSerializer()

Specified by:

createSerializer in class JPAQueryBase<Q extends AbstractHibernateQuery<Q>>

clone

protected void clone(Q query)

clone

protected abstract Q clone(SessionHolder sessionHolder)

clone

public Q clone(org.hibernate.Session session)

Clone the state of this query to a new instance with the given Session

Parameters:

session -

Returns:

clone

public Q clone(org.hibernate.StatelessSession session)

Clone the state of this query to a new instance with the given StatelessSession

Parameters:

session -

Returns:

clone

public Q clone()

Clone the state of this query to a new instance

Specified by:

clone in class JPAQueryBase<Q extends AbstractHibernateQuery<Q>>

Returns: