AbstractQueryImpl (Red Hat JBoss Enterprise Application Platform 7.0.0.GA public API)

java.lang.Object
- org.hibernate.internal.AbstractQueryImpl

All Implemented Interfaces:

BasicQueryContract, Query

Direct Known Subclasses:

FullTextQueryImpl, QueryImpl, SQLQueryImpl
```
public abstract class AbstractQueryImpl
extends Object
implements Query
```
Abstract implementation of the Query interface.

Author:

Gavin King, Max Andersen

Field Summary

Fields
Modifier and Type Field and Description

protected ParameterMetadata parameterMetadata

protected SessionImplementor session

Fields
Modifier and Type	Field and Description
`protected ParameterMetadata`	`parameterMetadata`
`protected SessionImplementor`	`session`

Constructor Summary

Constructors
Constructor and Description
`AbstractQueryImpl(String queryString, FlushMode flushMode, SessionImplementor session, ParameterMetadata parameterMetadata)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Query`	`addQueryHint(String queryHint)` Add a DB query hint to the SQL.
`protected void`	`after()`
`void`	`applyEntityGraphQueryHint(EntityGraphQueryHint hint)` Used from HEM code as a (hopefully temporary) means to apply a custom query plan in regards to a JPA entity graph.
`protected void`	`before()`
`protected Type`	`determineType(int paramPosition, Object paramValue)`
`protected Type`	`determineType(int paramPosition, Object paramValue, Type defaultType)`
`protected Type`	`determineType(String paramName, Class clazz)`
`protected Type`	`determineType(String paramName, Object paramValue)`
`protected Type`	`determineType(String paramName, Object paramValue, Type defaultType)`
`protected String`	`expandParameterLists(Map namedParamsCopy)` Warning: adds new parameters to the argument by side-effect, as well as mutating the query string!
`CacheMode`	`getCacheMode()` Obtain the CacheMode in effect for this query.
`String`	`getCacheRegion()` Obtain the name of the second level query cache region in which query results will be stored (if they are cached, see the discussion on `BasicQueryContract.isCacheable()` for more information).
`String`	`getComment()` Obtain the comment currently associated with this query.
`Integer`	`getFetchSize()` Obtain the JDBC fetch size hint in effect for this query.
`Integer`	`getFirstResult()` Obtain the value specified (if any) for the first row to be returned from the query results; zero-based.
`FlushMode`	`getFlushMode()` Obtain the FlushMode in effect for this query.
`abstract LockOptions`	`getLockOptions()` Obtains the LockOptions in effect for this query.
`Integer`	`getMaxResults()` Obtains the limit set on the maximum number of rows to retrieve.
`protected Map<String,TypedValue>`	`getNamedParameterLists()` Retreive the value map for any named parameter lists (i.e., for auto-expansion) bound to this query.
`String[]`	`getNamedParameters()` Returns an array representing all named parameter names encountered during (intial) parsing of the query.
`protected Map<String,TypedValue>`	`getNamedParams()` Returns a shallow copy of the named parameter value map.
`ParameterMetadata`	`getParameterMetadata()`
`QueryParameters`	`getQueryParameters(Map namedParams)`
`String`	`getQueryString()` Get the query string.
`String[]`	`getReturnAliases()` Return the HQL select clause aliases, if any.
`Type[]`	`getReturnTypes()` Return the Hibernate types of the query results.
`protected RowSelection`	`getRowSelection()`
`Integer`	`getTimeout()` Obtain the query timeout in seconds.
`protected List`	`getTypes()` Retreives the list of parameter `type`s bound to this query for ordinal parameters.
`protected List`	`getValues()` Retreives the list of parameter values bound to this query for ordinal parameters.
`Type`	`guessType(Class clazz)`
`boolean`	`hasNamedParameters()` Does this query contain named parameters?
`boolean`	`isCacheable()` Are the results of this query eligible for second level query caching? This is different that second level caching of any returned entities and collections.
`boolean`	`isReadOnly()` Should entities and proxies loaded by this Query be put in read-only mode? If the read-only/modifiable setting was not initialized, then the default read-only/modifiable setting for the persistence context is returned instead.
`Query`	`setBigDecimal(int position, BigDecimal number)` Bind a positional BigDecimal-valued parameter.
`Query`	`setBigDecimal(String name, BigDecimal number)` Bind a named BigDecimal-valued parameter.
`Query`	`setBigInteger(int position, BigInteger number)` Bind a positional BigDecimal-valued parameter.
`Query`	`setBigInteger(String name, BigInteger number)` Bind a named BigInteger-valued parameter.
`Query`	`setBinary(int position, byte[] val)` Bind a positional binary-valued parameter.
`Query`	`setBinary(String name, byte[] val)` Bind a named binary-valued parameter.
`Query`	`setBoolean(int position, boolean val)` Bind a positional boolean-valued parameter.
`Query`	`setBoolean(String name, boolean val)` Bind a named boolean-valued parameter.
`Query`	`setByte(int position, byte val)` Bind a positional byte-valued parameter.
`Query`	`setByte(String name, byte val)` Bind a named byte-valued parameter.
`Query`	`setCacheable(boolean cacheable)` Enable/disable second level query (result) caching for this query.
`Query`	`setCacheMode(CacheMode cacheMode)` (Re)set the current CacheMode in effect for this query.
`Query`	`setCacheRegion(String cacheRegion)` Set the name of the cache region where query results should be cached (if cached at all).
`Query`	`setCalendar(int position, Calendar calendar)` Bind a positional Calendar-valued parameter using the full Timestamp portion.
`Query`	`setCalendar(String name, Calendar calendar)` Bind a named Calendar-valued parameter using the full Timestamp.
`Query`	`setCalendarDate(int position, Calendar calendar)` Bind a positional Calendar-valued parameter using just the Date portion.
`Query`	`setCalendarDate(String name, Calendar calendar)` Bind a named Calendar-valued parameter using just the Date portion.
`Query`	`setCharacter(int position, char val)` Bind a positional char-valued parameter.
`Query`	`setCharacter(String name, char val)` Bind a named char-valued parameter.
`Query`	`setCollectionKey(Serializable collectionKey)`
`Query`	`setComment(String comment)` Set the comment for this query.
`Query`	`setDate(int position, Date date)` Bind a positional Date-valued parameter using just the Date portion.
`Query`	`setDate(String name, Date date)` Bind the date (time is truncated) of a given Date object to a named query parameter.
`Query`	`setDouble(int position, double val)` Bind a positional double-valued parameter.
`Query`	`setDouble(String name, double val)` Bind a named double-valued parameter.
`Query`	`setEntity(int position, Object val)` Bind an instance of a mapped persistent class to a JDBC-style query parameter.
`Query`	`setEntity(String name, Object val)` Bind an instance of a mapped persistent class to a named query parameter.
`Query`	`setFetchSize(int fetchSize)` Sets a JDBC fetch size hint for the query.
`Query`	`setFirstResult(int firstResult)` Set the first row to retrieve.
`Query`	`setFloat(int position, float val)` Bind a positional float-valued parameter.
`Query`	`setFloat(String name, float val)` Bind a named float-valued parameter.
`Query`	`setFlushMode(FlushMode flushMode)` (Re)set the current FlushMode in effect for this query.
`Query`	`setInteger(int position, int val)` Bind a positional int-valued parameter.
`Query`	`setInteger(String name, int val)` Bind a named int-valued parameter.
`Query`	`setLocale(int position, Locale locale)` Bind a positional Locale-valued parameter.
`Query`	`setLocale(String name, Locale locale)` Bind a named Locale-valued parameter.
`Query`	`setLong(int position, long val)` Bind a positional long-valued parameter.
`Query`	`setLong(String name, long val)` Bind a named long-valued parameter.
`Query`	`setMaxResults(int maxResults)` Set the maximum number of rows to retrieve.
`void`	`setOptionalEntityName(String optionalEntityName)`
`void`	`setOptionalId(Serializable optionalId)`
`void`	`setOptionalObject(Object optionalObject)`
`Query`	`setParameter(int position, Object val)` Bind a value to a JDBC-style query parameter.
`Query`	`setParameter(int position, Object val, Type type)` Bind a value to a JDBC-style query parameter.
`Query`	`setParameter(String name, Object val)` Bind a value to a named query parameter.
`Query`	`setParameter(String name, Object val, Type type)` Bind a value to a named query parameter.
`Query`	`setParameterList(String name, Collection vals)` Bind multiple values to a named query parameter.
`Query`	`setParameterList(String name, Collection vals, Type type)` Bind multiple values to a named query parameter.
`Query`	`setParameterList(String name, Object[] values)` Bind multiple values to a named query parameter.
`Query`	`setParameterList(String name, Object[] vals, Type type)` Bind multiple values to a named query parameter.
`Query`	`setParameters(Object[] values, Type[] types)` Bind values and types to positional parameters.
`Query`	`setProperties(Map map)` Bind the values of the given Map for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
`Query`	`setProperties(Object bean)` Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
`Query`	`setReadOnly(boolean readOnly)` Set the read-only/modifiable mode for entities and proxies loaded by this Query.
`Query`	`setResultTransformer(ResultTransformer transformer)` Set a strategy for handling the query results.
`Query`	`setSerializable(int position, Serializable val)` Bind a positional binary-valued parameter using serialization.
`Query`	`setSerializable(String name, Serializable val)` Bind a named binary-valued parameter using serialization.
`Query`	`setShort(int position, short val)` Bind a positional short-valued parameter.
`Query`	`setShort(String name, short val)` Bind a named short-valued parameter.
`Query`	`setString(int position, String val)` Bind a positional String-valued parameter.
`Query`	`setString(String name, String val)` Bind a named String-valued parameter.
`Query`	`setText(int position, String val)` Bind a positional String-valued parameter using streaming.
`Query`	`setText(String name, String val)` Bind a named String-valued parameter using streaming.
`Query`	`setTime(int position, Date date)` Bind a positional Date-valued parameter using just the Time portion.
`Query`	`setTime(String name, Date date)` Bind the time (date is truncated) of a given Date object to a named query parameter.
`Query`	`setTimeout(int timeout)` Set the query timeout in seconds.
`Query`	`setTimestamp(int position, Date date)` Bind a positional Date-valued parameter using the full Timestamp.
`Query`	`setTimestamp(String name, Date date)` Bind the date and the time of a given Date object to a named query parameter.
`String`	`toString()`
`Type[]`	`typeArray()`
`Object`	`uniqueResult()` Convenience method to return a single instance that matches the query, or null if the query returns no results.
`Object[]`	`valueArray()`
`protected void`	`verifyParameters()` Perform parameter validation.
`protected void`	`verifyParameters(boolean reserveFirstParameter)` Perform parameter validation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hibernate.Query
executeUpdate, iterate, list, scroll, scroll, setLockMode, setLockOptions

- Field Detail
  - session
```
protected final SessionImplementor session
```
  - parameterMetadata
```
protected final ParameterMetadata parameterMetadata
```
- Constructor Detail
  - AbstractQueryImpl
```
public AbstractQueryImpl(String queryString,
                         FlushMode flushMode,
                         SessionImplementor session,
                         ParameterMetadata parameterMetadata)
```
- Method Detail
  - getParameterMetadata
```
public ParameterMetadata getParameterMetadata()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getQueryString
```
public final String getQueryString()
```
    Description copied from interface: Query
    
    Get the query string.
    
    Specified by:
    
    getQueryString in interface Query
    
    Returns:
    
    the query string
  - isCacheable
```
public boolean isCacheable()
```
    Description copied from interface: BasicQueryContract
    
    Are the results of this query eligible for second level query caching? This is different that second level caching of any returned entities and collections. NOTE: the query being "eligible" for caching does not necessarily mean its results will be cached. Second level query caching still has to be enabled on the SessionFactory for this to happen. Usually that is controlled by the hibernate.cache.use_query_cache configuration setting.
    
    Specified by:
    
    isCacheable in interface BasicQueryContract
    
    Returns:
    
    true if the query results are eligible for caching, false otherwise.
    
    See Also:
    
    AvailableSettings.USE_QUERY_CACHE
  - setCacheable
```
public Query setCacheable(boolean cacheable)
```
    Description copied from interface: BasicQueryContract
    
    Enable/disable second level query (result) caching for this query.
    
    Specified by:
    
    setCacheable in interface BasicQueryContract
    
    Specified by:
    
    setCacheable in interface Query
    
    Parameters:
    
    cacheable - Should the query results be cacheable?
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.isCacheable()
  - getCacheRegion
```
public String getCacheRegion()
```
    Description copied from interface: BasicQueryContract
    
    Obtain the name of the second level query cache region in which query results will be stored (if they are cached, see the discussion on BasicQueryContract.isCacheable() for more information). null indicates that the default region should be used.
    
    Specified by:
    
    getCacheRegion in interface BasicQueryContract
    
    Returns:
    
    The specified cache region name into which query results should be placed; null indicates the default region.
  - setCacheRegion
```
public Query setCacheRegion(String cacheRegion)
```
    Description copied from interface: BasicQueryContract
    
    Set the name of the cache region where query results should be cached (if cached at all).
    
    Specified by:
    
    setCacheRegion in interface BasicQueryContract
    
    Specified by:
    
    setCacheRegion in interface Query
    
    Parameters:
    
    cacheRegion - the name of a query cache region, or null to indicate that the default region should be used.
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.getCacheRegion()
  - getFlushMode
```
public FlushMode getFlushMode()
```
    Description copied from interface: BasicQueryContract
    
    Obtain the FlushMode in effect for this query. By default, the query inherits the FlushMode of the Session from which is originates.
    
    Specified by:
    
    getFlushMode in interface BasicQueryContract
    
    Returns:
    
    The query FlushMode.
    
    See Also:
    
    Session.getFlushMode(), FlushMode
  - setFlushMode
```
public Query setFlushMode(FlushMode flushMode)
```
    Description copied from interface: BasicQueryContract
    
    (Re)set the current FlushMode in effect for this query.
    
    Specified by:
    
    setFlushMode in interface BasicQueryContract
    
    Specified by:
    
    setFlushMode in interface Query
    
    Parameters:
    
    flushMode - The new FlushMode to use.
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.getFlushMode()
  - getCacheMode
```
public CacheMode getCacheMode()
```
    Description copied from interface: BasicQueryContract
    
    Obtain the CacheMode in effect for this query. By default, the query inherits the CacheMode of the Session from which is originates. NOTE: The CacheMode here only effects reading/writing of the query cache, not the entity/collection caches.
    
    Specified by:
    
    getCacheMode in interface BasicQueryContract
    
    Returns:
    
    The query CacheMode.
    
    See Also:
    
    Session.getCacheMode(), CacheMode
  - setCacheMode
```
public Query setCacheMode(CacheMode cacheMode)
```
    Description copied from interface: BasicQueryContract
    
    (Re)set the current CacheMode in effect for this query.
    
    Specified by:
    
    setCacheMode in interface BasicQueryContract
    
    Specified by:
    
    setCacheMode in interface Query
    
    Parameters:
    
    cacheMode - The new CacheMode to use.
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.getCacheMode()
  - getComment
```
public String getComment()
```
    Description copied from interface: Query
    
    Obtain the comment currently associated with this query. Provided SQL commenting is enabled (generally by enabling the hibernate.use_sql_comments config setting), this comment will also be added to the SQL query sent to the database. Often useful for identifying the source of troublesome queries on the database side.
    
    Specified by:
    
    getComment in interface Query
    
    Returns:
    
    The comment.
  - setComment
```
public Query setComment(String comment)
```
    Description copied from interface: Query
    
    Set the comment for this query.
    
    Specified by:
    
    setComment in interface Query
    
    Parameters:
    
    comment - The human-readable comment
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    Query.getComment()
  - addQueryHint
```
public Query addQueryHint(String queryHint)
```
    Description copied from interface: Query
    
    Add a DB query hint to the SQL. These differ from JPA's QueryHint, which is specific to the JPA implementation and ignores DB vendor-specific hints. Instead, these are intended solely for the vendor-specific hints, such as Oracle's optimizers. Multiple query hints are supported; the Dialect will determine concatenation and placement.
    
    Specified by:
    
    addQueryHint in interface Query
    
    Parameters:
    
    queryHint - The database specific query hint to add.
  - getFirstResult
```
public Integer getFirstResult()
```
    Description copied from interface: Query
    
    Obtain the value specified (if any) for the first row to be returned from the query results; zero-based. Used, in conjunction with Query.getMaxResults() in "paginated queries". No value specified means the first result is returned. Zero and negative numbers are the same as no setting.
    
    Specified by:
    
    getFirstResult in interface Query
    
    Returns:
    
    The first result number.
  - setFirstResult
```
public Query setFirstResult(int firstResult)
```
    Description copied from interface: Query
    
    Set the first row to retrieve.
    
    Specified by:
    
    setFirstResult in interface Query
    
    Parameters:
    
    firstResult - a row number, numbered from 0
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    Query.getFirstResult()
  - getMaxResults
```
public Integer getMaxResults()
```
    Description copied from interface: Query
    
    Obtains the limit set on the maximum number of rows to retrieve. No set limit means there is no limit set on the number of rows returned. Technically both null and any negative values are interpreted as no limit; however, this method should always return null in such case.
    
    Specified by:
    
    getMaxResults in interface Query
    
    Returns:
    
    The
  - setMaxResults
```
public Query setMaxResults(int maxResults)
```
    Description copied from interface: Query
    
    Set the maximum number of rows to retrieve.
    
    Specified by:
    
    setMaxResults in interface Query
    
    Parameters:
    
    maxResults - the maximum number of rows
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    Query.getMaxResults()
  - getTimeout
```
public Integer getTimeout()
```
    Description copied from interface: BasicQueryContract
    
    Obtain the query timeout in seconds. This value is eventually passed along to the JDBC query via Statement.setQueryTimeout(int). Zero indicates no timeout.
    
    Specified by:
    
    getTimeout in interface BasicQueryContract
    
    Returns:
    
    The timeout in seconds
    
    See Also:
    
    Statement.getQueryTimeout(), Statement.setQueryTimeout(int)
  - setTimeout
```
public Query setTimeout(int timeout)
```
    Description copied from interface: BasicQueryContract
    
    Set the query timeout in seconds. NOTE it is important to understand that any value set here is eventually passed directly through to the JDBC Statement which expressly disallows negative values. So negative values should be avoided as a general rule.
    
    Specified by:
    
    setTimeout in interface BasicQueryContract
    
    Specified by:
    
    setTimeout in interface Query
    
    Parameters:
    
    timeout - the timeout in seconds
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.getTimeout()
  - getFetchSize
```
public Integer getFetchSize()
```
    Description copied from interface: BasicQueryContract
    
    Obtain the JDBC fetch size hint in effect for this query. This value is eventually passed along to the JDBC query via Statement.setFetchSize(int). As defined b y JDBC, this value is a hint to the driver to indicate how many rows to fetch from the database when more rows are needed. NOTE : JDBC expressly defines this value as a hint. It may or may not have any effect on the actual query execution and ResultSet processing depending on the driver.
    
    Specified by:
    
    getFetchSize in interface BasicQueryContract
    
    Returns:
    
    The timeout in seconds
    
    See Also:
    
    Statement.getFetchSize(), Statement.setFetchSize(int)
  - setFetchSize
```
public Query setFetchSize(int fetchSize)
```
    Description copied from interface: BasicQueryContract
    
    Sets a JDBC fetch size hint for the query.
    
    Specified by:
    
    setFetchSize in interface BasicQueryContract
    
    Specified by:
    
    setFetchSize in interface Query
    
    Parameters:
    
    fetchSize - the fetch size hint
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.getFetchSize()
  - getReturnTypes
```
public Type[] getReturnTypes()
                      throws HibernateException
```
    Description copied from interface: BasicQueryContract
    
    Return the Hibernate types of the query results.
    
    Specified by:
    
    getReturnTypes in interface BasicQueryContract
    
    Returns:
    
    an array of types
    
    Throws:
    
    HibernateException
  - getReturnAliases
```
public String[] getReturnAliases()
                          throws HibernateException
```
    Description copied from interface: Query
    
    Return the HQL select clause aliases, if any.
    
    Specified by:
    
    getReturnAliases in interface Query
    
    Returns:
    
    an array of aliases as strings
    
    Throws:
    
    HibernateException
  - setCollectionKey
```
public Query setCollectionKey(Serializable collectionKey)
```
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from interface: BasicQueryContract
    
    Should entities and proxies loaded by this Query be put in read-only mode? If the read-only/modifiable setting was not initialized, then the default read-only/modifiable setting for the persistence context is returned instead.
    
    Specified by:
    
    isReadOnly in interface BasicQueryContract
    
    Returns:
    
    true, entities and proxies loaded by the query will be put in read-only mode false, entities and proxies loaded by the query will be put in modifiable mode
    
    See Also:
    
    Query.setReadOnly(boolean), The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session before the query was executed.
  - setReadOnly
```
public Query setReadOnly(boolean readOnly)
```
    Description copied from interface: BasicQueryContract
    
    Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context.
    
    Specified by:
    
    setReadOnly in interface BasicQueryContract
    
    Specified by:
    
    setReadOnly in interface Query
    
    Parameters:
    
    readOnly - true, entities and proxies loaded by the query will be put in read-only mode false, entities and proxies loaded by the query will be put in modifiable mode
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session:, PersistenceContext.setDefaultReadOnly(boolean), Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted. When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy has, regardless of the session's current setting. The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session before the query was executed.
  - setResultTransformer
```
public Query setResultTransformer(ResultTransformer transformer)
```
    Description copied from interface: Query
    
    Set a strategy for handling the query results. This can be used to change "shape" of the query result.
    
    Specified by:
    
    setResultTransformer in interface Query
    
    Parameters:
    
    transformer - The transformer to apply
    
    Returns:
    
    this (for method chaining)
  - setOptionalEntityName
```
public void setOptionalEntityName(String optionalEntityName)
```
  - setOptionalId
```
public void setOptionalId(Serializable optionalId)
```
  - setOptionalObject
```
public void setOptionalObject(Object optionalObject)
```
  - getLockOptions
```
public abstract LockOptions getLockOptions()
```
    Description copied from interface: Query
    
    Obtains the LockOptions in effect for this query.
    
    Specified by:
    
    getLockOptions in interface Query
    
    Returns:
    
    The LockOptions
    
    See Also:
    
    LockOptions
  - getNamedParams
```
protected Map<String,TypedValue> getNamedParams()
```
    Returns a shallow copy of the named parameter value map.
    
    Returns:
    
    Shallow copy of the named parameter value map
  - getNamedParameters
```
public String[] getNamedParameters()
                            throws HibernateException
```
    Returns an array representing all named parameter names encountered during (intial) parsing of the query.
    Note initial here means different things depending on whether this is a native-sql query or an HQL/filter query. For native-sql, a precursory inspection of the query string is performed specifically to locate defined parameters. For HQL/filter queries, this is the information returned from the query-translator. This distinction holds true for all parameter metadata exposed here.
    
    Specified by:
    
    getNamedParameters in interface Query
    
    Returns:
    
    Array of named parameter names.
    
    Throws:
    
    HibernateException
  - hasNamedParameters
```
public boolean hasNamedParameters()
```
    Does this query contain named parameters?
    
    Returns:
    
    True if the query was found to contain named parameters; false otherwise;
  - getNamedParameterLists
```
protected Map<String,TypedValue> getNamedParameterLists()
```
    Retreive the value map for any named parameter lists (i.e., for auto-expansion) bound to this query.
    
    Returns:
    
    The parameter list value map.
  - getValues
```
protected List getValues()
```
    Retreives the list of parameter values bound to this query for ordinal parameters.
    
    Returns:
    
    The ordinal parameter values.
  - getTypes
```
protected List getTypes()
```
    Retreives the list of parameter types bound to this query for ordinal parameters.
    
    Returns:
    
    The ordinal parameter types.
  - verifyParameters
```
protected void verifyParameters()
                         throws QueryException
```
    Perform parameter validation. Used prior to executing the encapsulated query.
    
    Throws:
    
    QueryException
  - verifyParameters
```
protected void verifyParameters(boolean reserveFirstParameter)
                         throws HibernateException
```
    Perform parameter validation. Used prior to executing the encapsulated query.
    
    Parameters:
    
    reserveFirstParameter - if true, the first ? will not be verified since its needed for e.g. callable statements returning a out parameter
    
    Throws:
    
    HibernateException
  - setParameter
```
public Query setParameter(int position,
                          Object val,
                          Type type)
```
    Description copied from interface: Query
    
    Bind a value to a JDBC-style query parameter.
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    position - the position of the parameter in the query string, numbered from 0.
    
    val - the possibly-null parameter value
    
    type - the Hibernate type
    
    Returns:
    
    this, for method chaining
  - setParameter
```
public Query setParameter(String name,
                          Object val,
                          Type type)
```
    Description copied from interface: Query
    
    Bind a value to a named query parameter.
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    name - the name of the parameter
    
    val - the possibly-null parameter value
    
    type - the Hibernate type
    
    Returns:
    
    this, for method chaining
  - setParameter
```
public Query setParameter(int position,
                          Object val)
                   throws HibernateException
```
    Description copied from interface: Query
    
    Bind a value to a JDBC-style query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the given object.
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    position - the position of the parameter in the query string, numbered from 0.
    
    val - the non-null parameter value
    
    Returns:
    
    this, for method chaining
    
    Throws:
    
    HibernateException
  - setParameter
```
public Query setParameter(String name,
                          Object val)
                   throws HibernateException
```
    Description copied from interface: Query
    
    Bind a value to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the given object.
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    name - the name of the parameter
    
    val - the non-null parameter value
    
    Returns:
    
    this, for method chaining
    
    Throws:
    
    HibernateException
  - determineType
```
protected Type determineType(int paramPosition,
                             Object paramValue,
                             Type defaultType)
```
  - determineType
```
protected Type determineType(int paramPosition,
                             Object paramValue)
                      throws HibernateException
```
    Throws:
    
    HibernateException
  - determineType
```
protected Type determineType(String paramName,
                             Object paramValue,
                             Type defaultType)
```
  - determineType
```
protected Type determineType(String paramName,
                             Object paramValue)
                      throws HibernateException
```
    Throws:
    
    HibernateException
  - determineType
```
protected Type determineType(String paramName,
                             Class clazz)
                      throws HibernateException
```
    Throws:
    
    HibernateException
  - guessType
```
public Type guessType(Class clazz)
               throws HibernateException
```
    Throws:
    
    HibernateException
  - setString
```
public Query setString(int position,
                       String val)
```
    Description copied from interface: Query
    
    Bind a positional String-valued parameter.
    
    Specified by:
    
    setString in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setCharacter
```
public Query setCharacter(int position,
                          char val)
```
    Description copied from interface: Query
    
    Bind a positional char-valued parameter.
    
    Specified by:
    
    setCharacter in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setBoolean
```
public Query setBoolean(int position,
                        boolean val)
```
    Description copied from interface: Query
    
    Bind a positional boolean-valued parameter.
    
    Specified by:
    
    setBoolean in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setByte
```
public Query setByte(int position,
                     byte val)
```
    Description copied from interface: Query
    
    Bind a positional byte-valued parameter.
    
    Specified by:
    
    setByte in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setShort
```
public Query setShort(int position,
                      short val)
```
    Description copied from interface: Query
    
    Bind a positional short-valued parameter.
    
    Specified by:
    
    setShort in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setInteger
```
public Query setInteger(int position,
                        int val)
```
    Description copied from interface: Query
    
    Bind a positional int-valued parameter.
    
    Specified by:
    
    setInteger in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setLong
```
public Query setLong(int position,
                     long val)
```
    Description copied from interface: Query
    
    Bind a positional long-valued parameter.
    
    Specified by:
    
    setLong in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setFloat
```
public Query setFloat(int position,
                      float val)
```
    Description copied from interface: Query
    
    Bind a positional float-valued parameter.
    
    Specified by:
    
    setFloat in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setDouble
```
public Query setDouble(int position,
                       double val)
```
    Description copied from interface: Query
    
    Bind a positional double-valued parameter.
    
    Specified by:
    
    setDouble in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setBinary
```
public Query setBinary(int position,
                       byte[] val)
```
    Description copied from interface: Query
    
    Bind a positional binary-valued parameter.
    
    Specified by:
    
    setBinary in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setText
```
public Query setText(int position,
                     String val)
```
    Description copied from interface: Query
    
    Bind a positional String-valued parameter using streaming.
    
    Specified by:
    
    setText in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setSerializable
```
public Query setSerializable(int position,
                             Serializable val)
```
    Description copied from interface: Query
    
    Bind a positional binary-valued parameter using serialization.
    
    Specified by:
    
    setSerializable in interface Query
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setDate
```
public Query setDate(int position,
                     Date date)
```
    Description copied from interface: Query
    
    Bind a positional Date-valued parameter using just the Date portion.
    
    Specified by:
    
    setDate in interface Query
    
    Parameters:
    
    position - The parameter position
    
    date - The bind value
    
    Returns:
    
    this, for method chaining
  - setTime
```
public Query setTime(int position,
                     Date date)
```
    Description copied from interface: Query
    
    Bind a positional Date-valued parameter using just the Time portion.
    
    Specified by:
    
    setTime in interface Query
    
    Parameters:
    
    position - The parameter position
    
    date - The bind value
    
    Returns:
    
    this, for method chaining
  - setTimestamp
```
public Query setTimestamp(int position,
                          Date date)
```
    Description copied from interface: Query
    
    Bind a positional Date-valued parameter using the full Timestamp.
    
    Specified by:
    
    setTimestamp in interface Query
    
    Parameters:
    
    position - The parameter position
    
    date - The bind value
    
    Returns:
    
    this, for method chaining
  - setEntity
```
public Query setEntity(int position,
                       Object val)
```
    Description copied from interface: Query
    
    Bind an instance of a mapped persistent class to a JDBC-style query parameter. Use Query.setParameter(int, Object) for null values.
    
    Specified by:
    
    setEntity in interface Query
    
    Parameters:
    
    position - the position of the parameter in the query string, numbered from 0.
    
    val - a non-null instance of a persistent class
    
    Returns:
    
    this, for method chaining
  - setLocale
```
public Query setLocale(int position,
                       Locale locale)
```
    Description copied from interface: Query
    
    Bind a positional Locale-valued parameter.
    
    Specified by:
    
    setLocale in interface Query
    
    Parameters:
    
    position - The parameter position
    
    locale - The bind value
    
    Returns:
    
    this, for method chaining
  - setCalendar
```
public Query setCalendar(int position,
                         Calendar calendar)
```
    Description copied from interface: Query
    
    Bind a positional Calendar-valued parameter using the full Timestamp portion.
    
    Specified by:
    
    setCalendar in interface Query
    
    Parameters:
    
    position - The parameter position
    
    calendar - The bind value
    
    Returns:
    
    this, for method chaining
  - setCalendarDate
```
public Query setCalendarDate(int position,
                             Calendar calendar)
```
    Description copied from interface: Query
    
    Bind a positional Calendar-valued parameter using just the Date portion.
    
    Specified by:
    
    setCalendarDate in interface Query
    
    Parameters:
    
    position - The parameter position
    
    calendar - The bind value
    
    Returns:
    
    this, for method chaining
  - setBinary
```
public Query setBinary(String name,
                       byte[] val)
```
    Description copied from interface: Query
    
    Bind a named binary-valued parameter.
    
    Specified by:
    
    setBinary in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setText
```
public Query setText(String name,
                     String val)
```
    Description copied from interface: Query
    
    Bind a named String-valued parameter using streaming.
    
    Specified by:
    
    setText in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setBoolean
```
public Query setBoolean(String name,
                        boolean val)
```
    Description copied from interface: Query
    
    Bind a named boolean-valued parameter.
    
    Specified by:
    
    setBoolean in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setByte
```
public Query setByte(String name,
                     byte val)
```
    Description copied from interface: Query
    
    Bind a named byte-valued parameter.
    
    Specified by:
    
    setByte in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setCharacter
```
public Query setCharacter(String name,
                          char val)
```
    Description copied from interface: Query
    
    Bind a named char-valued parameter.
    
    Specified by:
    
    setCharacter in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setDate
```
public Query setDate(String name,
                     Date date)
```
    Description copied from interface: Query
    
    Bind the date (time is truncated) of a given Date object to a named query parameter.
    
    Specified by:
    
    setDate in interface Query
    
    Parameters:
    
    name - The name of the parameter
    
    date - The date object
    
    Returns:
    
    this, for method chaining
  - setDouble
```
public Query setDouble(String name,
                       double val)
```
    Description copied from interface: Query
    
    Bind a named double-valued parameter.
    
    Specified by:
    
    setDouble in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setEntity
```
public Query setEntity(String name,
                       Object val)
```
    Description copied from interface: Query
    
    Bind an instance of a mapped persistent class to a named query parameter. Use Query.setParameter(String, Object) for null values.
    
    Specified by:
    
    setEntity in interface Query
    
    Parameters:
    
    name - the name of the parameter
    
    val - a non-null instance of a persistent class
    
    Returns:
    
    this, for method chaining
  - setFloat
```
public Query setFloat(String name,
                      float val)
```
    Description copied from interface: Query
    
    Bind a named float-valued parameter.
    
    Specified by:
    
    setFloat in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setInteger
```
public Query setInteger(String name,
                        int val)
```
    Description copied from interface: Query
    
    Bind a named int-valued parameter.
    
    Specified by:
    
    setInteger in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setLocale
```
public Query setLocale(String name,
                       Locale locale)
```
    Description copied from interface: Query
    
    Bind a named Locale-valued parameter.
    
    Specified by:
    
    setLocale in interface Query
    
    Parameters:
    
    name - The parameter name
    
    locale - The bind value
    
    Returns:
    
    this, for method chaining
  - setCalendar
```
public Query setCalendar(String name,
                         Calendar calendar)
```
    Description copied from interface: Query
    
    Bind a named Calendar-valued parameter using the full Timestamp.
    
    Specified by:
    
    setCalendar in interface Query
    
    Parameters:
    
    name - The parameter name
    
    calendar - The bind value
    
    Returns:
    
    this, for method chaining
  - setCalendarDate
```
public Query setCalendarDate(String name,
                             Calendar calendar)
```
    Description copied from interface: Query
    
    Bind a named Calendar-valued parameter using just the Date portion.
    
    Specified by:
    
    setCalendarDate in interface Query
    
    Parameters:
    
    name - The parameter name
    
    calendar - The bind value
    
    Returns:
    
    this, for method chaining
  - setLong
```
public Query setLong(String name,
                     long val)
```
    Description copied from interface: Query
    
    Bind a named long-valued parameter.
    
    Specified by:
    
    setLong in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setSerializable
```
public Query setSerializable(String name,
                             Serializable val)
```
    Description copied from interface: Query
    
    Bind a named binary-valued parameter using serialization.
    
    Specified by:
    
    setSerializable in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setShort
```
public Query setShort(String name,
                      short val)
```
    Description copied from interface: Query
    
    Bind a named short-valued parameter.
    
    Specified by:
    
    setShort in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setString
```
public Query setString(String name,
                       String val)
```
    Description copied from interface: Query
    
    Bind a named String-valued parameter.
    
    Specified by:
    
    setString in interface Query
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setTime
```
public Query setTime(String name,
                     Date date)
```
    Description copied from interface: Query
    
    Bind the time (date is truncated) of a given Date object to a named query parameter.
    
    Specified by:
    
    setTime in interface Query
    
    Parameters:
    
    name - The name of the parameter
    
    date - The date object
    
    Returns:
    
    this, for method chaining
  - setTimestamp
```
public Query setTimestamp(String name,
                          Date date)
```
    Description copied from interface: Query
    
    Bind the date and the time of a given Date object to a named query parameter.
    
    Specified by:
    
    setTimestamp in interface Query
    
    Parameters:
    
    name - The name of the parameter
    
    date - The date object
    
    Returns:
    
    this, for method chaining
  - setBigDecimal
```
public Query setBigDecimal(int position,
                           BigDecimal number)
```
    Description copied from interface: Query
    
    Bind a positional BigDecimal-valued parameter.
    
    Specified by:
    
    setBigDecimal in interface Query
    
    Parameters:
    
    position - The parameter position
    
    number - The bind value
    
    Returns:
    
    this, for method chaining
  - setBigDecimal
```
public Query setBigDecimal(String name,
                           BigDecimal number)
```
    Description copied from interface: Query
    
    Bind a named BigDecimal-valued parameter.
    
    Specified by:
    
    setBigDecimal in interface Query
    
    Parameters:
    
    name - The parameter name
    
    number - The bind value
    
    Returns:
    
    this, for method chaining
  - setBigInteger
```
public Query setBigInteger(int position,
                           BigInteger number)
```
    Description copied from interface: Query
    
    Bind a positional BigDecimal-valued parameter.
    
    Specified by:
    
    setBigInteger in interface Query
    
    Parameters:
    
    position - The parameter position
    
    number - The bind value
    
    Returns:
    
    this, for method chaining
  - setBigInteger
```
public Query setBigInteger(String name,
                           BigInteger number)
```
    Description copied from interface: Query
    
    Bind a named BigInteger-valued parameter.
    
    Specified by:
    
    setBigInteger in interface Query
    
    Parameters:
    
    name - The parameter name
    
    number - The bind value
    
    Returns:
    
    this, for method chaining
  - setParameterList
```
public Query setParameterList(String name,
                              Collection vals,
                              Type type)
                       throws HibernateException
```
    Description copied from interface: Query
    
    Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
    
    Specified by:
    
    setParameterList in interface Query
    
    Parameters:
    
    name - the name of the parameter
    
    vals - a collection of values to list
    
    type - the Hibernate type of the values
    
    Returns:
    
    this, for method chaining
    
    Throws:
    
    HibernateException
  - expandParameterLists
```
protected String expandParameterLists(Map namedParamsCopy)
```
    Warning: adds new parameters to the argument by side-effect, as well as mutating the query string!
  - setParameterList
```
public Query setParameterList(String name,
                              Collection vals)
                       throws HibernateException
```
    Description copied from interface: Query
    
    Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
    
    Specified by:
    
    setParameterList in interface Query
    
    Parameters:
    
    name - the name of the parameter
    
    vals - a collection of values to list
    
    Returns:
    
    this, for method chaining
    
    Throws:
    
    HibernateException
  - setParameterList
```
public Query setParameterList(String name,
                              Object[] vals,
                              Type type)
                       throws HibernateException
```
    Description copied from interface: Query
    
    Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
    
    Specified by:
    
    setParameterList in interface Query
    
    Parameters:
    
    name - the name of the parameter
    
    vals - a collection of values to list
    
    type - the Hibernate type of the values
    
    Returns:
    
    this, for method chaining
    
    Throws:
    
    HibernateException
  - setParameterList
```
public Query setParameterList(String name,
                              Object[] values)
                       throws HibernateException
```
    Description copied from interface: Query
    
    Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the array. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
    
    Specified by:
    
    setParameterList in interface Query
    
    Parameters:
    
    name - the name of the parameter
    
    values - a collection of values to list
    
    Returns:
    
    this, for method chaining
    
    Throws:
    
    HibernateException
  - setProperties
```
public Query setProperties(Map map)
                    throws HibernateException
```
    Description copied from interface: Query
    
    Bind the values of the given Map for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
    
    Specified by:
    
    setProperties in interface Query
    
    Parameters:
    
    map - a java.util.Map
    
    Returns:
    
    this, for method chaining
    
    Throws:
    
    HibernateException
  - setProperties
```
public Query setProperties(Object bean)
                    throws HibernateException
```
    Description copied from interface: Query
    
    Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
    
    Specified by:
    
    setProperties in interface Query
    
    Parameters:
    
    bean - any JavaBean or POJO
    
    Returns:
    
    this, for method chaining
    
    Throws:
    
    HibernateException
  - setParameters
```
public Query setParameters(Object[] values,
                           Type[] types)
```
    Description copied from interface: Query
    
    Bind values and types to positional parameters. Allows binding more than one at a time; no real performance impact. The number of elements in each array should match. That is, element number-0 in types array corresponds to element-0 in the values array, etc,
    
    Specified by:
    
    setParameters in interface Query
    
    Parameters:
    
    values - The values
    
    types - The types
    
    Returns:
    
    this, for method chaining
  - uniqueResult
```
public Object uniqueResult()
                    throws HibernateException
```
    Description copied from interface: Query
    
    Convenience method to return a single instance that matches the query, or null if the query returns no results.
    
    Specified by:
    
    uniqueResult in interface Query
    
    Returns:
    
    the single result or null
    
    Throws:
    
    NonUniqueResultException - if there is more than one matching result
    
    HibernateException
  - getRowSelection
```
protected RowSelection getRowSelection()
```
  - typeArray
```
public Type[] typeArray()
```
  - valueArray
```
public Object[] valueArray()
```
  - getQueryParameters
```
public QueryParameters getQueryParameters(Map namedParams)
```
  - before
```
protected void before()
```
  - after
```
protected void after()
```
  - applyEntityGraphQueryHint
```
public void applyEntityGraphQueryHint(EntityGraphQueryHint hint)
```
    Used from HEM code as a (hopefully temporary) means to apply a custom query plan in regards to a JPA entity graph.
    
    Parameters:
    
    hint - The entity graph hint object

Class AbstractQueryImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hibernate.Query

Field Detail

session

parameterMetadata

Constructor Detail

AbstractQueryImpl

Method Detail

getParameterMetadata

toString

getQueryString

isCacheable

setCacheable

getCacheRegion

setCacheRegion

getFlushMode

setFlushMode

getCacheMode

setCacheMode

getComment

setComment

addQueryHint

getFirstResult

setFirstResult

getMaxResults

setMaxResults

getTimeout

setTimeout

getFetchSize

setFetchSize

getReturnTypes

getReturnAliases

setCollectionKey

isReadOnly

setReadOnly

setResultTransformer

setOptionalEntityName

setOptionalId

setOptionalObject

getLockOptions

getNamedParams

getNamedParameters

hasNamedParameters

getNamedParameterLists

getValues

getTypes

verifyParameters

verifyParameters

setParameter

setParameter

setParameter

setParameter

determineType

determineType

determineType

determineType

determineType

guessType

setString

setCharacter

setBoolean

setByte

setShort

setInteger

setLong

setFloat

setDouble

setBinary

setText

setSerializable

setDate

setTime

setTimestamp

setEntity

setLocale

setCalendar