org.hibernate.engine.spi

Class NamedSQLQueryDefinition

java.lang.Object

org.hibernate.engine.spi.NamedQueryDefinition

org.hibernate.engine.spi.NamedSQLQueryDefinition

All Implemented Interfaces:

Serializable

public class NamedSQLQueryDefinition
extends NamedQueryDefinition

Definition of a named native SQL query, defined in the mapping metadata.

Author:

Max Andersen, Steve Ebersole

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NamedSQLQueryDefinition(String name, String query, NativeSQLQueryReturn[] queryReturns, List<String> querySpaces, boolean cacheable, String cacheRegion, Integer timeout, Integer fetchSize, FlushMode flushMode, CacheMode cacheMode, boolean readOnly, String comment, Map parameterTypes, boolean callable) Deprecated. Use NamedSQLQueryDefinitionBuilder instead.
NamedSQLQueryDefinition(String name, String query, String resultSetRef, List<String> querySpaces, boolean cacheable, String cacheRegion, Integer timeout, Integer fetchSize, FlushMode flushMode, CacheMode cacheMode, boolean readOnly, String comment, Map parameterTypes, boolean callable) Deprecated. Use NamedSQLQueryDefinitionBuilder instead.

Method Summary

Modifier and Type	Method and Description
void	addQueryReturns(NativeSQLQueryReturn[] queryReturnsToAdd)
NativeSQLQueryReturn[]	getQueryReturns()
List<String>	getQuerySpaces()
String	getResultSetRef()
boolean	isCallable()
NamedSQLQueryDefinition	makeCopy(String name)

Methods inherited from class org.hibernate.engine.spi.NamedQueryDefinition

getCacheMode, getCacheRegion, getComment, getFetchSize, getFirstResult, getFlushMode, getLockOptions, getMaxResults, getName, getParameterTypes, getQuery, getQueryString, getTimeout, isCacheable, isReadOnly, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedSQLQueryDefinition

@Deprecated
public NamedSQLQueryDefinition(String name,
                                           String query,
                                           NativeSQLQueryReturn[] queryReturns,
                                           List<String> querySpaces,
                                           boolean cacheable,
                                           String cacheRegion,
                                           Integer timeout,
                                           Integer fetchSize,
                                           FlushMode flushMode,
                                           CacheMode cacheMode,
                                           boolean readOnly,
                                           String comment,
                                           Map parameterTypes,
                                           boolean callable)

Deprecated. Use NamedSQLQueryDefinitionBuilder instead.

This form was initially used to construct a NamedSQLQueryDefinition from the binder code when a the result-set mapping information is not explicitly provided in the query definition (i.e., no resultset-mapping used).

Parameters:

name - The name of named query

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)

NamedSQLQueryDefinition

@Deprecated
public NamedSQLQueryDefinition(String name,
                                           String query,
                                           String resultSetRef,
                                           List<String> querySpaces,
                                           boolean cacheable,
                                           String cacheRegion,
                                           Integer timeout,
                                           Integer fetchSize,
                                           FlushMode flushMode,
                                           CacheMode cacheMode,
                                           boolean readOnly,
                                           String comment,
                                           Map parameterTypes,
                                           boolean callable)

Deprecated. Use NamedSQLQueryDefinitionBuilder instead.

This form was initially used to construct a NamedSQLQueryDefinition from the binder code when a resultset-mapping reference is used.

Parameters:

name - The name of named query

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)

Method Detail

getQueryReturns

public NativeSQLQueryReturn[] getQueryReturns()

getQuerySpaces

public List<String> getQuerySpaces()

isCallable

public boolean isCallable()

getResultSetRef

public String getResultSetRef()

makeCopy

public NamedSQLQueryDefinition makeCopy(String name)

Overrides:

makeCopy in class NamedQueryDefinition

addQueryReturns

public void addQueryReturns(NativeSQLQueryReturn[] queryReturnsToAdd)