org.hibernate.internal

Class QueryImpl

java.lang.Object

org.hibernate.internal.AbstractQueryImpl

org.hibernate.internal.QueryImpl

All Implemented Interfaces:

BasicQueryContract, Query

Direct Known Subclasses:

CollectionFilterImpl

public class QueryImpl
extends AbstractQueryImpl

default implementation of the Query interface, for "ordinary" HQL queries (not collection filters)

Author:

Gavin King

See Also:

CollectionFilterImpl

Field Summary

Fields inherited from class org.hibernate.internal.AbstractQueryImpl

parameterMetadata, session

Constructor Summary

Constructors

Constructor and Description
QueryImpl(String queryString, FlushMode flushMode, SessionImplementor session, ParameterMetadata parameterMetadata)
QueryImpl(String queryString, SessionImplementor session, ParameterMetadata parameterMetadata)

Method Summary

Modifier and Type	Method and Description
int	executeUpdate() Execute the update or delete statement.
LockOptions	getLockOptions() Obtains the LockOptions in effect for this query.
boolean	isSelect()
Iterator	iterate() Return the query results as an Iterator.
List	list() Return the query results as a List.
ScrollableResults	scroll() Return the query results as ScrollableResults.
ScrollableResults	scroll(ScrollMode scrollMode) Return the query results as ScrollableResults.
Query	setLockMode(String alias, LockMode lockMode) Set the LockMode to use for specific alias (as defined in the query's FROM clause).
Query	setLockOptions(LockOptions lockOption) Set the lock options for the query.

Methods inherited from class org.hibernate.internal.AbstractQueryImpl

addQueryHint, after, applyEntityGraphQueryHint, before, determineType, determineType, determineType, determineType, determineType, expandParameterLists, getCacheMode, getCacheRegion, getComment, getFetchSize, getFirstResult, getFlushMode, getMaxResults, getNamedParameterLists, getNamedParameters, getNamedParams, getParameterMetadata, getQueryParameters, getQueryString, getReturnAliases, getReturnTypes, getRowSelection, getTimeout, getTypes, getValues, guessType, hasNamedParameters, isCacheable, isReadOnly, setBigDecimal, setBigDecimal, setBigInteger, setBigInteger, setBinary, setBinary, setBoolean, setBoolean, setByte, setByte, setCacheable, setCacheMode, setCacheRegion, setCalendar, setCalendar, setCalendarDate, setCalendarDate, setCharacter, setCharacter, setCollectionKey, setComment, setDate, setDate, setDouble, setDouble, setEntity, setEntity, setFetchSize, setFirstResult, setFloat, setFloat, setFlushMode, setInteger, setInteger, setLocale, setLocale, setLong, setLong, setMaxResults, setOptionalEntityName, setOptionalId, setOptionalObject, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameters, setProperties, setProperties, setReadOnly, setResultTransformer, setSerializable, setSerializable, setShort, setShort, setString, setString, setText, setText, setTime, setTime, setTimeout, setTimestamp, setTimestamp, toString, typeArray, uniqueResult, valueArray, verifyParameters, verifyParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryImpl

public QueryImpl(String queryString,
                 FlushMode flushMode,
                 SessionImplementor session,
                 ParameterMetadata parameterMetadata)

QueryImpl

public QueryImpl(String queryString,
                 SessionImplementor session,
                 ParameterMetadata parameterMetadata)

Method Detail

iterate

public Iterator iterate()
                 throws HibernateException

Description copied from interface: Query

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:

the result iterator

Throws:

HibernateException

scroll

public ScrollableResults scroll()
                         throws HibernateException

Description copied from interface: Query

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

Returns:

the result iterator

Throws:

HibernateException

See Also:

ScrollableResults

scroll

public ScrollableResults scroll(ScrollMode scrollMode)
                         throws HibernateException

Description copied from interface: Query

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

Parameters:

scrollMode - The scroll mode

Returns:

the result iterator

Throws:

HibernateException

See Also:

ScrollableResults, ScrollMode

list

public List list()
          throws HibernateException

Description copied from interface: Query

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

Returns:

the result list

Throws:

HibernateException

executeUpdate

public int executeUpdate()
                  throws HibernateException

Description copied from interface: Query

Execute the update or delete statement. The semantics are compliant with the ejb3 Query.executeUpdate() method.

Returns:

The number of entities updated or deleted.

Throws:

HibernateException

setLockMode

public Query setLockMode(String alias,
                         LockMode lockMode)

Description copied from interface: Query

Set the LockMode to use for specific alias (as defined in the query's FROM clause). The alias-specific lock modes specified here are added to the query's internal LockOptions. The effect of these alias-specific LockModes is somewhat dependent on the driver/database in use. Generally speaking, for maximum portability, this method should only be used to mark that the rows corresponding to the given alias should be included in pessimistic locking (LockMode.PESSIMISTIC_WRITE).

Parameters:

alias - a query alias, or "this" for a collection filter

lockMode - The lock mode to apply.

Returns:

this, for method chaining

See Also:

Query.getLockOptions()

setLockOptions

public Query setLockOptions(LockOptions lockOption)

Description copied from interface: Query

Set the lock options for the query. Specifically only the following are taken into consideration:

1. LockOptions.getLockMode()
2. LockOptions.getScope()
3. LockOptions.getTimeOut()

For alias-specific locking, use Query.setLockMode(String, LockMode).

Parameters:

lockOption - The lock options to apply to the query.

Returns:

this, for method chaining

See Also:

Query.getLockOptions()

getLockOptions

public LockOptions getLockOptions()

Description copied from interface: Query

Obtains the LockOptions in effect for this query.

Specified by:

getLockOptions in interface Query

Specified by:

getLockOptions in class AbstractQueryImpl

Returns:

The LockOptions

See Also:

LockOptions

isSelect

public boolean isSelect()