FileDocCategorySizeDatePackage
CustomQuery.javaAPI DocHibernate 3.2.51633Thu Jun 15 00:21:06 BST 2006org.hibernate.loader.custom

CustomQuery

public interface CustomQuery
Extension point allowing any SQL query with named and positional parameters to be executed by Hibernate, returning managed entities, collections and simple scalar values.
author
Gavin King
author
Steve Ebersole

Fields Summary
Constructors Summary
Methods Summary
public java.util.ListgetCustomQueryReturns()
A collection of {@link Return descriptors} describing the JDBC result set to be expected and how to map this result set.

return
List of return descriptors.

public java.util.MapgetNamedParameterBindPoints()
A map representing positions within the supplied {@link #getSQL 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 {@link Integer} if the parameter occurs only once in the query; or a List of Integers if the parameter occurs more than once

public java.util.SetgetQuerySpaces()
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.

return
The query spaces

public java.lang.StringgetSQL()
The SQL query string to be performed.

return
The SQL statement string.