com.querydsl.jpa.hibernate

Class AbstractHibernateQuery<T,Q extends AbstractHibernateQuery<T,Q>>

java.lang.Object

com.querydsl.core.support.QueryBase<Q>

com.querydsl.core.support.FetchableQueryBase<T,Q>

com.querydsl.core.support.FetchableSubQueryBase<T,Q>

com.querydsl.jpa.JPAQueryBase<T,Q>

com.querydsl.jpa.hibernate.AbstractHibernateQuery<T,Q>

Type Parameters:

T - result type

Q - concrete subtype

All Implemented Interfaces:

Fetchable<T>, FetchableQuery<T,JPQLQuery<T>>, FilteredClause<JPQLQuery<T>>, Query<JPQLQuery<T>>, SimpleQuery<JPQLQuery<T>>, ExtendedSubQuery<T>, Expression<T>, SubQueryExpression<T>, JPQLQuery<T>, Serializable

Direct Known Subclasses:

HibernateQuery

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

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

Author:

tiwe

See Also:

Serialized Form

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.querydsl.jpa.JPAQueryBase

queryMixin

Fields inherited from class com.querydsl.core.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
org.hibernate.Query	createQuery() Expose the original Hibernate query for the given projection
protected JPQLSerializer	createSerializer()
List<T>	fetch() Get the projection as a typed List
long	fetchCount() Get the count of matched elements
T	fetchOne() Get the projection as a unique result or null if no result is found
QueryResults<T>	fetchResults() Get the projection in QueryResults form
com.mysema.commons.lang.CloseableIterator<T>	iterate() Return the query results as an Iterator.
protected void	logQuery(String queryString, Map<Object,String> parameters)
protected void	reset()
org.hibernate.ScrollableResults	scroll(org.hibernate.ScrollMode mode) 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 fetchJoin 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.

Methods inherited from class com.querydsl.jpa.JPAQueryBase

fetchAll, fetchJoin, from, from, from, 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.querydsl.core.support.FetchableSubQueryBase

accept, contains, contains, eq, eq, exists, getMetadata, getType, goe, goe, gt, gt, hashCode, in, in, isNotNull, isNull, loe, loe, lt, lt, ne, ne, notExists

Methods inherited from class com.querydsl.core.support.FetchableQueryBase

equals, fetchFirst, transform, uniqueResult

Methods inherited from class com.querydsl.core.support.QueryBase

distinct, groupBy, groupBy, 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.querydsl.jpa.JPQLQuery

select, select

Methods inherited from interface com.querydsl.core.FetchableQuery

transform

Methods inherited from interface com.querydsl.core.Fetchable

fetchFirst

Methods inherited from interface com.querydsl.core.Query

groupBy, having

Methods inherited from interface com.querydsl.core.SimpleQuery

distinct, limit, offset, orderBy, restrict, set

Methods inherited from interface com.querydsl.core.FilteredClause

where

Methods inherited from interface com.querydsl.core.support.ExtendedSubQuery

contains, contains, eq, eq, exists, goe, goe, gt, gt, in, in, isNotNull, isNull, loe, loe, lt, lt, ne, ne, notExists

Methods inherited from interface com.querydsl.core.types.SubQueryExpression

getMetadata

Methods inherited from interface com.querydsl.core.types.Expression

accept, getType

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

fetchCount

public long fetchCount()

Description copied from interface: Fetchable

Get the count of matched elements

Returns:

row count

createQuery

public org.hibernate.Query createQuery()

Expose the original Hibernate query for the given projection

Returns:

query

iterate

public com.mysema.commons.lang.CloseableIterator<T> iterate()

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.

Returns:

closeable iterator

fetch

public List<T> fetch()

Description copied from interface: Fetchable

Get the projection as a typed List

Specified by:

fetch in interface Fetchable<T>

Overrides:

fetch in class FetchableQueryBase<T,Q extends AbstractHibernateQuery<T,Q>>

Returns:

results in list form

fetchResults

public QueryResults<T> fetchResults()

Description copied from interface: Fetchable

Get the projection in QueryResults form

Returns:

results

logQuery

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

cleanupMDC

protected void cleanupMDC()

reset

protected void reset()

Specified by:

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

scroll

public org.hibernate.ScrollableResults scroll(org.hibernate.ScrollMode mode)

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

Parameters:

mode - scroll mode

Returns:

scrollable results

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 - comment

Returns:

the current object

setFetchSize

public Q setFetchSize(int fetchSize)

Set a fetchJoin size for the underlying JDBC query.

Parameters:

fetchSize - the fetchJoin size

Returns:

the current object

setLockMode

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

Set the lock mode for the given path.

Returns:

the current object

setFlushMode

public Q setFlushMode(org.hibernate.FlushMode flushMode)

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

Returns:

the current object

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.

Returns:

the current object

setTimeout

public Q setTimeout(int timeout)

Set a timeout for the underlying JDBC query.

Parameters:

timeout - the timeout in seconds

Returns:

the current object

fetchOne

public T fetchOne()
           throws NonUniqueResultException

Description copied from interface: Fetchable

Get the projection as a unique result or null if no result is found

Returns:

first result or null

Throws:

NonUniqueResultException - if there is more than one matching result

createSerializer

protected JPQLSerializer createSerializer()

Specified by:

createSerializer in class JPAQueryBase<T,Q extends AbstractHibernateQuery<T,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 - session

Returns:

cloned query

clone

public Q clone(org.hibernate.StatelessSession session)

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

Parameters:

session - session

Returns:

cloned query

clone

public Q clone()

Clone the state of this query to a new instance

Specified by:

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

Returns:

closed query