com.mysema.query.jpa.hibernate.sql

Class AbstractHibernateSQLQuery<Q extends AbstractHibernateSQLQuery<Q> & Query>

java.lang.Object

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

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

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

com.mysema.query.jpa.hibernate.sql.AbstractHibernateSQLQuery<Q>

Type Parameters:

Q -

All Implemented Interfaces:

Projectable

Direct Known Subclasses:

HibernateSQLQuery

public abstract class AbstractHibernateSQLQuery<Q extends AbstractHibernateSQLQuery<Q> & Query>
extends AbstractSQLQuery<Q>

AbstractHibernateSQLQuery is the base class for Hibernate Native SQL queries

Author:

tiwe

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	cacheable
protected String	cacheRegion
protected int	fetchSize
protected Boolean	readOnly
protected SQLTemplates	templates
protected int	timeout
protected Expression<?>	union

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

queryMixin

Constructor Summary

Constructors

Constructor and Description
AbstractHibernateSQLQuery(SessionHolder session, SQLTemplates sqlTemplates, QueryMetadata metadata)
AbstractHibernateSQLQuery(org.hibernate.Session session, SQLTemplates sqlTemplates)
AbstractHibernateSQLQuery(org.hibernate.StatelessSession session, SQLTemplates sqlTemplates)

Method Summary

Methods

Modifier and Type	Method and Description
org.hibernate.Query	createQuery(Expression<?>... args)
com.mysema.commons.lang.CloseableIterator<Tuple>	iterate(Expression<?>... args) iterate over the results for the given projection
<RT> com.mysema.commons.lang.CloseableIterator<RT>	iterate(Expression<RT> projection) iterate over the results for the given projection
List<Tuple>	list(Expression<?>... projection) list the results for the given projection An empty list is returned for no results.
<RT> List<RT>	list(Expression<RT> projection) 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> projection) list the results for the given projection
protected void	logQuery(String queryString)
protected void	reset()
Q	setCacheable(boolean cacheable) Enable caching of this query result set.
Q	setCacheRegion(String cacheRegion) Set the name of the cache region.
Q	setFetchSize(int fetchSize) Set a fetch size for the underlying JDBC query.
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.
protected String	toCountRowsString()
protected String	toQueryString()
<RT> Union<RT>	union(ListSubQuery<RT>... sq)
<RT> Q	union(Path<?> alias, ListSubQuery<RT>... sq)
<RT> Q	union(Path<?> alias, SubQueryExpression<RT>... sq)
<RT> Union<RT>	union(SubQueryExpression<RT>... sq)
<RT> Union<RT>	unionAll(ListSubQuery<RT>... sq)
<RT> Q	unionAll(Path<?> alias, ListSubQuery<RT>... sq)
<RT> Q	unionAll(Path<?> alias, SubQueryExpression<RT>... sq)
<RT> Union<RT>	unionAll(SubQueryExpression<RT>... sq)
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.AbstractSQLQuery

addFlag, addFlag, addFlag, addJoinFlag, addJoinFlag, count, exists, from, from, from, fullJoin, fullJoin, fullJoin, fullJoin, getMetadata, innerJoin, innerJoin, innerJoin, innerJoin, join, join, join, join, leftJoin, leftJoin, leftJoin, leftJoin, on, on, rightJoin, rightJoin, rightJoin, rightJoin

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

countDistinct, iterateDistinct, iterateDistinct, listDistinct, listDistinct, listDistinctResults, 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, toString, where, where

Methods inherited from class java.lang.Object

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

Field Detail

cacheable

protected Boolean cacheable

readOnly

protected Boolean readOnly

cacheRegion

protected String cacheRegion

fetchSize

protected int fetchSize

templates

protected final SQLTemplates templates

timeout

protected int timeout

union

@Nullable
protected Expression<?> union

Constructor Detail

AbstractHibernateSQLQuery

public AbstractHibernateSQLQuery(org.hibernate.Session session,
                         SQLTemplates sqlTemplates)

AbstractHibernateSQLQuery

public AbstractHibernateSQLQuery(org.hibernate.StatelessSession session,
                         SQLTemplates sqlTemplates)

AbstractHibernateSQLQuery

public AbstractHibernateSQLQuery(SessionHolder session,
                         SQLTemplates sqlTemplates,
                         QueryMetadata metadata)

Method Detail

createQuery

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

list

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

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 AbstractHibernateSQLQuery<Q> & Query>

Returns:

list

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

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 AbstractHibernateSQLQuery<Q> & Query>

Type Parameters:

RT - generic type of the List

Returns:

a List over the projection

iterate

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

Description copied from interface: Projectable

iterate over the results for the given projection

Returns:

iterate

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

Description copied from interface: Projectable

iterate over the results for the given projection

Type Parameters:

RT - generic type of the Iterator

Returns:

an Iterator 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> projection)

Description copied from interface: Projectable

list the results for the given projection

Returns:

logQuery

protected void logQuery(String queryString)

reset

protected void reset()

toCountRowsString

protected String toCountRowsString()

toQueryString

protected String toQueryString()

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.

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

union

public <RT> Union<RT> union(ListSubQuery<RT>... sq)

union

public <RT> Union<RT> union(SubQueryExpression<RT>... sq)

unionAll

public <RT> Union<RT> unionAll(ListSubQuery<RT>... sq)

unionAll

public <RT> Union<RT> unionAll(SubQueryExpression<RT>... sq)

union

public <RT> Q union(Path<?> alias,
           ListSubQuery<RT>... sq)

union

public <RT> Q union(Path<?> alias,
           SubQueryExpression<RT>... sq)

unionAll

public <RT> Q unionAll(Path<?> alias,
              ListSubQuery<RT>... sq)

unionAll

public <RT> Q unionAll(Path<?> alias,
              SubQueryExpression<RT>... sq)

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

setFetchSize

public Q setFetchSize(int fetchSize)

Set a fetch size for the underlying JDBC query.

Parameters:

fetchSize - the fetch size

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