public class

SQLCustomQuery

extends Object
implements CustomQuery
java.lang.Object
   ↳ org.hibernate.loader.custom.sql.SQLCustomQuery

Class Overview

Implements Hibernate's built-in support for native SQL queries.

This support is built on top of the notion of "custom queries"...

Summary

Fields
public static final Logger log
Public Constructors
SQLCustomQuery(String sqlQuery, NativeSQLQueryReturn[] queryReturns, Collection additionalQuerySpaces, SessionFactoryImplementor factory)
Public Methods
List getCustomQueryReturns()
A collection of descriptors describing the JDBC result set to be expected and how to map this result set.
Map getNamedParameterBindPoints()
A map representing positions within the supplied query to which we need to bind named parameters.
Set getQuerySpaces()
Any query spaces to apply to the query execution.
String getSQL()
The SQL query string to be performed.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.hibernate.loader.custom.CustomQuery

Fields

public static final Logger log

Public Constructors

public SQLCustomQuery (String sqlQuery, NativeSQLQueryReturn[] queryReturns, Collection additionalQuerySpaces, SessionFactoryImplementor factory)

Throws
HibernateException

Public Methods

public List getCustomQueryReturns ()

A collection of descriptors describing the JDBC result set to be expected and how to map this result set.

Returns
  • List of return descriptors.

public Map getNamedParameterBindPoints ()

A map representing positions within the supplied query to which we need to bind named parameters.

Optional, may return null if no named parameters.

The structure of the returned map (if one) as follows:

  1. The keys into the map are the named parameter names
  2. The corresponding value is either an Integer if the parameter occurs only once in the query; or a List of Integers if the parameter occurs more than once

public Set getQuerySpaces ()

Any query spaces to apply to the query execution. Query spaces are used in Hibernate's auto-flushing mechanism to determine which entities need to be checked for pending changes.

Returns
  • The query spaces

public String getSQL ()

The SQL query string to be performed.

Returns
  • The SQL statement string.