com.mysema.query.hql.hibernate
Class AbstractHibernateQuery<SubType extends AbstractHibernateQuery<SubType>>

java.lang.Object
  com.mysema.query.QueryBase<SubType>
      com.mysema.query.support.QueryBaseWithProjection<SubType>
          com.mysema.query.hql.HQLQueryBase<SubType>
              com.mysema.query.hql.hibernate.AbstractHibernateQuery<SubType>

Type Parameters:

SubType -

All Implemented Interfaces:

Projectable

Direct Known Subclasses:

HibernateQuery

public abstract class AbstractHibernateQuery<SubType extends AbstractHibernateQuery<SubType>>
extends HQLQueryBase<SubType>

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

Author:

tiwe

Field Summary

Fields inherited from class com.mysema.query.QueryBase

_this

Constructor Summary

AbstractHibernateQuery(QueryMetadata md, org.hibernate.Session session, HQLTemplates patterns)

Method Summary

long	count() return the amount of matched rows
long	count(Expr<?> expr)
org.hibernate.Query	createQuery(Expr<?> expr) Expose the original Hibernate query for the given projection
org.hibernate.Query	createQuery(Expr<?> expr1, Expr<?> expr2, Expr<?>... rest) Expose the original Hibernate query for the given projection
Iterator<Object[]>	iterate(Expr<?> e1, Expr<?> e2, Expr<?>... rest) Return the query results as an Iterator.
<RT> Iterator<RT>	iterate(Expr<RT> projection) Return the query results as an Iterator.
List<Object[]>	list(Expr<?> expr1, Expr<?> expr2, Expr<?>... rest) list the results for the given projection
<RT> List<RT>	list(Expr<RT> expr) list the results for the given projection
<RT> SearchResults<RT>	listResults(Expr<RT> expr) list the results for the given projection
protected void	logQuery(String queryString)
org.hibernate.ScrollableResults	scroll(org.hibernate.ScrollMode mode, Expr<?> expr) Return the query results as ScrollableResults.
org.hibernate.ScrollableResults	scroll(org.hibernate.ScrollMode mode, Expr<?> expr1, Expr<?> expr2, Expr<?>... rest) Return the query results as ScrollableResults.
SubType	setCacheable(boolean cacheable) Enable caching of this query result set.
SubType	setCacheRegion(String cacheRegion) Set the name of the cache region.
SubType	setFetchSize(int fetchSize) Set a fetch size for the underlying JDBC query.
SubType	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.
SubType	setTimeout(int timeout) Set a timeout for the underlying JDBC query.
<RT> RT	uniqueResult(Expr<RT> expr) return a unique result for the given projection

Methods inherited from class com.mysema.query.hql.HQLQueryBase

createQBECondition, fetch, fetchAll, from, fullJoin, fullJoin, fullJoin, fullJoin, fullJoin, fullJoin, getConstants, innerJoin, innerJoin, innerJoin, innerJoin, innerJoin, innerJoin, join, join, join, join, join, join, leftJoin, leftJoin, leftJoin, leftJoin, leftJoin, leftJoin, toCountRowsString, toQueryString, toString, with

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

asArray, countDistinct, iterateDistinct, iterateDistinct, listDistinct, listDistinct, listDistinctResults, map, uniqueResult

Methods inherited from class com.mysema.query.QueryBase

addToProjection, getMetadata, groupBy, having, limit, offset, orderBy, restrict, where

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHibernateQuery

public AbstractHibernateQuery(QueryMetadata md,
                              org.hibernate.Session session,
                              HQLTemplates patterns)

Method Detail

count

public long count()

Description copied from interface: Projectable

return the amount of matched rows

count

public long count(Expr<?> expr)

createQuery

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

Expose the original Hibernate query for the given projection

Parameters:

expr -

Returns:

createQuery

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

Expose the original Hibernate query for the given projection

Parameters:

expr1 -

expr2 -

rest -

Returns:

iterate

public Iterator<Object[]> iterate(Expr<?> e1,
                                  Expr<?> e2,
                                  Expr<?>... rest)

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:

an Iterator over the projection

iterate

public <RT> Iterator<RT> iterate(Expr<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 Iteratpr

Returns:

an Iterator over the projection

list

public List<Object[]> list(Expr<?> expr1,
                           Expr<?> expr2,
                           Expr<?>... rest)

Description copied from interface: Projectable

list the results for the given projection

Specified by:

list in interface Projectable

Overrides:

list in class QueryBaseWithProjection<SubType extends AbstractHibernateQuery<SubType>>

rest - rest

Returns:

a List over the projection

list

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

Description copied from interface: Projectable

list the results for the given projection

Specified by:

list in interface Projectable

Overrides:

list in class QueryBaseWithProjection<SubType extends AbstractHibernateQuery<SubType>>

Type Parameters:

RT - generic type of the List

Returns:

a List over the projection

listResults

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

Description copied from interface: Projectable

list the results for the given projection

Returns:

logQuery

protected void logQuery(String queryString)

scroll

public org.hibernate.ScrollableResults scroll(org.hibernate.ScrollMode mode,
                                              Expr<?> 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,
                                              Expr<?> expr1,
                                              Expr<?> expr2,
                                              Expr<?>... rest)

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

Parameters:

mode -

expr1 -

expr2 -

rest -

Returns:

setCacheable

public SubType setCacheable(boolean cacheable)

Enable caching of this query result set.

Parameters:

cacheable - Should the query results be cacheable?

setCacheRegion

public SubType 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 SubType setFetchSize(int fetchSize)

Set a fetch size for the underlying JDBC query.

Parameters:

fetchSize - the fetch size

setReadOnly

public SubType 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 SubType setTimeout(int timeout)

Set a timeout for the underlying JDBC query.

Parameters:

timeout - the timeout in seconds

uniqueResult

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

Description copied from interface: Projectable

return a unique result for the given projection

Specified by:

uniqueResult in interface Projectable

Overrides:

uniqueResult in class QueryBaseWithProjection<SubType extends AbstractHibernateQuery<SubType>>

Type Parameters:

RT - return type

Returns:

the result or null for an empty result