FileDocCategorySizeDatePackage
NamedSQLQueryDefinition.javaAPI DocHibernate 3.2.55632Tue Feb 13 14:04:24 GMT 2007org.hibernate.engine

NamedSQLQueryDefinition

public class NamedSQLQueryDefinition extends NamedQueryDefinition
Definition of a named native SQL query, defined in the mapping metadata.
author
Max Andersen

Fields Summary
private org.hibernate.engine.query.sql.NativeSQLQueryReturn[]
queryReturns
private final List
querySpaces
private final boolean
callable
private String
resultSetRef
Constructors Summary
public NamedSQLQueryDefinition(String query, org.hibernate.engine.query.sql.NativeSQLQueryReturn[] queryReturns, List querySpaces, boolean cacheable, String cacheRegion, Integer timeout, Integer fetchSize, org.hibernate.FlushMode flushMode, org.hibernate.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)

param
query The sql query string
param
queryReturns The in-lined query return definitions
param
querySpaces Any specified query spaces (used for auto-flushing)
param
cacheable Whether the query results are cacheable
param
cacheRegion If cacheable, the region into which to store the results
param
timeout A JDBC-level timeout to be applied
param
fetchSize A JDBC-level fetch-size to be applied
param
flushMode The flush mode to use for this query
param
cacheMode The cache mode to use during execution and subsequent result loading
param
readOnly Whether returned entities should be marked as read-only in the session
param
comment Any sql comment to be applied to the query
param
parameterTypes parameter type map
param
callable Does the query string represent a callable object (i.e., proc)

		super(
				query.trim(), /* trim done to workaround stupid oracle bug that cant handle whitespaces before a { in a sp */
				cacheable,
				cacheRegion,
				timeout,
				fetchSize,
				flushMode,
				cacheMode,
				readOnly,
				comment,
				parameterTypes
		);
		this.queryReturns = queryReturns;
		this.querySpaces = querySpaces;
		this.callable = callable;
	
public NamedSQLQueryDefinition(String query, String resultSetRef, List querySpaces, boolean cacheable, String cacheRegion, Integer timeout, Integer fetchSize, org.hibernate.FlushMode flushMode, org.hibernate.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.

param
query The sql query string
param
resultSetRef The resultset-mapping name
param
querySpaces Any specified query spaces (used for auto-flushing)
param
cacheable Whether the query results are cacheable
param
cacheRegion If cacheable, the region into which to store the results
param
timeout A JDBC-level timeout to be applied
param
fetchSize A JDBC-level fetch-size to be applied
param
flushMode The flush mode to use for this query
param
cacheMode The cache mode to use during execution and subsequent result loading
param
readOnly Whether returned entities should be marked as read-only in the session
param
comment Any sql comment to be applied to the query
param
parameterTypes parameter type map
param
callable Does the query string represent a callable object (i.e., proc)

		super(
				query.trim(), /* trim done to workaround stupid oracle bug that cant handle whitespaces before a { in a sp */
				cacheable,
				cacheRegion,
				timeout,
				fetchSize,
				flushMode,
				cacheMode,
				readOnly,
				comment,
				parameterTypes
		);
		this.resultSetRef = resultSetRef;
		this.querySpaces = querySpaces;
		this.callable = callable;
	
public NamedSQLQueryDefinition(String query, String resultSetRef, List querySpaces, boolean cacheable, String cacheRegion, Integer timeout, Integer fetchSize, org.hibernate.FlushMode flushMode, Map parameterTypes, boolean callable)
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

deprecated
param
query The sql query string
param
resultSetRef The result-set-mapping name
param
querySpaces Any specified query spaces (used for auto-flushing)
param
cacheable Whether the query results are cacheable
param
cacheRegion If cacheable, the region into which to store the results
param
timeout A JDBC-level timeout to be applied
param
fetchSize A JDBC-level fetch-size to be applied
param
flushMode The flush mode to use for this query
param
parameterTypes parameter type map
param
callable Does the query string represent a callable object (i.e., proc)

		this(
				query,
				resultSetRef,
				querySpaces,
				cacheable,
				cacheRegion,
				timeout,
				fetchSize,
				flushMode,
				null,
				false,
				null,
				parameterTypes,
				callable
		);
	
Methods Summary
public org.hibernate.engine.query.sql.NativeSQLQueryReturn[]getQueryReturns()

		return queryReturns;
	
public java.util.ListgetQuerySpaces()

		return querySpaces;
	
public java.lang.StringgetResultSetRef()

		return resultSetRef;
	
public booleanisCallable()

		return callable;