public abstract class

SimpleProjection

extends Object
implements EnhancedProjection
java.lang.Object
   ↳ org.hibernate.criterion.SimpleProjection
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

A single-column projection that may be aliased

Summary

Public Constructors
SimpleProjection()
Public Methods
Projection as(String alias)
String[] getAliases()
Get the criteria-level aliases for this projection (ie.
String[] getColumnAliases(int loc)
Get the SQL column aliases used by this projection for the columns it writes for inclusion into the SELECT clause (toSqlString(Criteria, int, CriteriaQuery).
String[] getColumnAliases(String alias, int loc)
Get the SQL column aliases used by this projection for the columns it writes for inclusion into the SELECT clause (toSqlString(Criteria, int, CriteriaQuery) for a particular criteria-level alias.
String[] getColumnAliases(int loc, Criteria criteria, CriteriaQuery criteriaQuery)
Get the SQL column aliases used by this projection for the columns it writes for inclusion into the SELECT clause (toSqlString(Criteria, int, CriteriaQuery).
String[] getColumnAliases(String alias, int loc, Criteria criteria, CriteriaQuery criteriaQuery)
Get the SQL column aliases used by this projection for the columns it writes for inclusion into the SELECT clause (toSqlString(Criteria, int, CriteriaQuery) for a particular criteria-level alias.
int getColumnCount(Criteria criteria, CriteriaQuery criteriaQuery)
Type[] getTypes(String alias, Criteria criteria, CriteriaQuery criteriaQuery)
Get the return types for a particular user-visible alias.
boolean isGrouped()
Is this projection fragment (SELECT clause) also part of the GROUP BY
String toGroupSqlString(Criteria criteria, CriteriaQuery criteriaQuery)
Render the SQL fragment to be used in the GROUP BY clause
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.hibernate.criterion.EnhancedProjection
From interface org.hibernate.criterion.Projection

Public Constructors

public SimpleProjection ()

Public Methods

public Projection as (String alias)

public String[] getAliases ()

Get the criteria-level aliases for this projection (ie. the ones that will be passed to the ResultTransformer)

Returns
  • The aliases

public String[] getColumnAliases (int loc)

Get the SQL column aliases used by this projection for the columns it writes for inclusion into the SELECT clause (toSqlString(Criteria, int, CriteriaQuery). Hibernate always uses column aliases to extract data from the JDBC java.sql.ResultSet, so it is important that these be implemented correctly in order for Hibernate to be able to extract these val;ues correctly.

Parameters
loc Just as in toSqlString(Criteria, int, CriteriaQuery), represents the number of columns rendered prior to this projection.
Returns
  • The columns aliases.

public String[] getColumnAliases (String alias, int loc)

Get the SQL column aliases used by this projection for the columns it writes for inclusion into the SELECT clause (toSqlString(Criteria, int, CriteriaQuery) for a particular criteria-level alias.

Parameters
alias The criteria-level alias
loc Just as in toSqlString(Criteria, int, CriteriaQuery), represents the number of columns rendered prior to this projection.
Returns
  • The columns aliases pertaining to a particular criteria-level alias; expected to return null if this projection does not understand this alias.

public String[] getColumnAliases (int loc, Criteria criteria, CriteriaQuery criteriaQuery)

Get the SQL column aliases used by this projection for the columns it writes for inclusion into the SELECT clause (toSqlString(Criteria, int, CriteriaQuery). Hibernate always uses column aliases to extract data from the JDBC java.sql.ResultSet, so it is important that these be implemented correctly in order for Hibernate to be able to extract these val;ues correctly.

Parameters
loc Just as in toSqlString(Criteria, int, CriteriaQuery), represents the number of columns rendered prior to this projection.
criteria The local criteria to which this project is attached (for resolution).
criteriaQuery The overall criteria query instance.
Returns
  • The columns aliases.

public String[] getColumnAliases (String alias, int loc, Criteria criteria, CriteriaQuery criteriaQuery)

Get the SQL column aliases used by this projection for the columns it writes for inclusion into the SELECT clause (toSqlString(Criteria, int, CriteriaQuery) for a particular criteria-level alias.

Parameters
alias The criteria-level alias
loc Just as in toSqlString(Criteria, int, CriteriaQuery), represents the number of columns rendered prior to this projection.
criteria The local criteria to which this project is attached (for resolution).
criteriaQuery The overall criteria query instance.
Returns
  • The columns aliases pertaining to a particular criteria-level alias; expected to return null if this projection does not understand this alias.

public int getColumnCount (Criteria criteria, CriteriaQuery criteriaQuery)

public Type[] getTypes (String alias, Criteria criteria, CriteriaQuery criteriaQuery)

Get the return types for a particular user-visible alias.

Differs from getTypes(org.hibernate.Criteria, CriteriaQuery) in that here we are only interested in the types related to the given criteria-level alias.

Parameters
alias The criteria-level alias for which to find types.
criteria The local criteria to which this project is attached (for resolution).
criteriaQuery The overall criteria query instance.
Returns
  • The return types; expected to return null if this projection does not understand this alias.
Throws
HibernateException

public boolean isGrouped ()

Is this projection fragment (SELECT clause) also part of the GROUP BY

Returns
  • True if the projection is also part of the GROUP BY; false otherwise.

public String toGroupSqlString (Criteria criteria, CriteriaQuery criteriaQuery)

Render the SQL fragment to be used in the GROUP BY clause

Parameters
criteria The local criteria to which this project is attached (for resolution).
criteriaQuery The overall criteria query instance.
Returns
  • The SQL fragment to plug into the GROUP BY
Throws
HibernateException