org.hibernate.engine

Class NamedSQLQueryDefinition

Implemented Interfaces:
Serializable

public class NamedSQLQueryDefinition
extends NamedQueryDefinition

Definition of a named native SQL query, defined in the mapping metadata.
Author:
Max Andersen

Constructor Summary

NamedSQLQueryDefinition(String query, String resultSetRef, List querySpaces, boolean cacheable, String cacheRegion, Integer timeout, Integer fetchSize, FlushMode flushMode, Map parameterTypes, boolean callable)
Deprecated.
NamedSQLQueryDefinition(String query, String resultSetRef, List querySpaces, boolean cacheable, String cacheRegion, Integer timeout, Integer fetchSize, FlushMode flushMode, CacheMode cacheMode, boolean readOnly, String comment, Map parameterTypes, boolean callable)
This form used to construct a NamedSQLQueryDefinition from the binder code when a resultset-mapping reference is used.
NamedSQLQueryDefinition(String query, NativeSQLQueryReturn[] queryReturns, List querySpaces, boolean cacheable, String cacheRegion, Integer timeout, Integer fetchSize, FlushMode flushMode, CacheMode cacheMode, boolean readOnly, String comment, Map parameterTypes, boolean callable)
This form used to construct a NamedSQLQueryDefinition from the binder code when a the result-set mapping information is explicitly provided in the query definition (i.e., no resultset-mapping used)

Method Summary

NativeSQLQueryReturn[]
getQueryReturns()
List
getQuerySpaces()
String
getResultSetRef()
boolean
isCallable()

Methods inherited from class org.hibernate.engine.NamedQueryDefinition

getCacheMode, getCacheRegion, getComment, getFetchSize, getFlushMode, getParameterTypes, getQuery, getQueryString, getTimeout, isCacheable, isReadOnly, toString

Constructor Details

NamedSQLQueryDefinition

public NamedSQLQueryDefinition(String query,
                               String resultSetRef,
                               List querySpaces,
                               boolean cacheable,
                               String cacheRegion,
                               Integer timeout,
                               Integer fetchSize,
                               FlushMode flushMode,
                               Map parameterTypes,
                               boolean callable)

Deprecated.

This form used from annotations (?). Essentially the same as the above using a resultset-mapping reference, but without cacheMode, readOnly, and comment. FIXME: annotations do not use it, so it can be remove from my POV
Parameters:
query - The sql query string
resultSetRef - The result-set-mapping name
querySpaces - Any specified query spaces (used for auto-flushing)
cacheable - Whether the query results are cacheable
cacheRegion - If cacheable, the region into which to store the results
timeout - A JDBC-level timeout to be applied
fetchSize - A JDBC-level fetch-size to be applied
flushMode - The flush mode to use for this query
parameterTypes - parameter type map
callable - Does the query string represent a callable object (i.e., proc)

NamedSQLQueryDefinition

public NamedSQLQueryDefinition(String query,
                               String resultSetRef,
                               List querySpaces,
                               boolean cacheable,
                               String cacheRegion,
                               Integer timeout,
                               Integer fetchSize,
                               FlushMode flushMode,
                               CacheMode cacheMode,
                               boolean readOnly,
                               String comment,
                               Map parameterTypes,
                               boolean callable)
This form used to construct a NamedSQLQueryDefinition from the binder code when a resultset-mapping reference is used.
Parameters:
query - The sql query string
resultSetRef - The resultset-mapping name
querySpaces - Any specified query spaces (used for auto-flushing)
cacheable - Whether the query results are cacheable
cacheRegion - If cacheable, the region into which to store the results
timeout - A JDBC-level timeout to be applied
fetchSize - A JDBC-level fetch-size to be applied
flushMode - The flush mode to use for this query
cacheMode - The cache mode to use during execution and subsequent result loading
readOnly - Whether returned entities should be marked as read-only in the session
comment - Any sql comment to be applied to the query
parameterTypes - parameter type map
callable - Does the query string represent a callable object (i.e., proc)

NamedSQLQueryDefinition

public NamedSQLQueryDefinition(String query,
                               NativeSQLQueryReturn[] queryReturns,
                               List querySpaces,
                               boolean cacheable,
                               String cacheRegion,
                               Integer timeout,
                               Integer fetchSize,
                               FlushMode flushMode,
                               CacheMode cacheMode,
                               boolean readOnly,
                               String comment,
                               Map parameterTypes,
                               boolean callable)
This form used to construct a NamedSQLQueryDefinition from the binder code when a the result-set mapping information is explicitly provided in the query definition (i.e., no resultset-mapping used)
Parameters:
query - The sql query string
queryReturns - The in-lined query return definitions
querySpaces - Any specified query spaces (used for auto-flushing)
cacheable - Whether the query results are cacheable
cacheRegion - If cacheable, the region into which to store the results
timeout - A JDBC-level timeout to be applied
fetchSize - A JDBC-level fetch-size to be applied
flushMode - The flush mode to use for this query
cacheMode - The cache mode to use during execution and subsequent result loading
readOnly - Whether returned entities should be marked as read-only in the session
comment - Any sql comment to be applied to the query
parameterTypes - parameter type map
callable - Does the query string represent a callable object (i.e., proc)

Method Details

getQueryReturns

public NativeSQLQueryReturn[] getQueryReturns()

getQuerySpaces

public List getQuerySpaces()

getResultSetRef

public String getResultSetRef()

isCallable

public boolean isCallable()