org.hibernate.criterion

Class Distinct

java.lang.Object

org.hibernate.criterion.Distinct

All Implemented Interfaces:

Serializable, EnhancedProjection, Projection

public class Distinct
extends Object
implements EnhancedProjection

A wrappedProjection that is a wrapper around other projections to apply distinction.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Distinct(Projection wrappedProjection) Constructs a Distinct

Method Summary

Modifier and Type	Method and Description
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 <tt>SELECT</tt> clause (Projection.toSqlString(org.hibernate.Criteria, int, org.hibernate.criterion.CriteriaQuery).
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 <tt>SELECT</tt> clause (Projection.toSqlString(org.hibernate.Criteria, int, org.hibernate.criterion.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 <tt>SELECT</tt> clause (Projection.toSqlString(org.hibernate.Criteria, int, org.hibernate.criterion.CriteriaQuery) <i>for a particular criteria-level alias</i>.
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 <tt>SELECT</tt> clause (Projection.toSqlString(org.hibernate.Criteria, int, org.hibernate.criterion.CriteriaQuery) <i>for a particular criteria-level alias</i>.
Type[]	getTypes(Criteria criteria, CriteriaQuery criteriaQuery) Types returned by the rendered SQL fragment.
Type[]	getTypes(String alias, Criteria criteria, CriteriaQuery criteriaQuery) Get the return types for a particular user-visible alias.
boolean	isGrouped() Is this projection fragment (<tt>SELECT</tt> clause) also part of the <tt>GROUP BY</tt>
String	toGroupSqlString(Criteria criteria, CriteriaQuery criteriaQuery) Render the SQL fragment to be used in the <tt>GROUP BY</tt> clause
String	toSqlString(Criteria criteria, int position, CriteriaQuery criteriaQuery) Render the SQL fragment to be used in the <tt>SELECT</tt> clause.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Distinct

public Distinct(Projection wrappedProjection)

Constructs a Distinct

Parameters:

wrappedProjection - The wrapped projection

Method Detail

toSqlString

public String toSqlString(Criteria criteria,
                          int position,
                          CriteriaQuery criteriaQuery)

Description copied from interface: Projection

Render the SQL fragment to be used in the <tt>SELECT</tt> clause.

Specified by:

toSqlString in interface Projection

Parameters:

criteria - The local criteria to which this project is attached (for resolution).

position - The number of columns rendered in the <tt>SELECT</tt> clause before this projection. Generally speaking this is useful to ensure uniqueness of the individual columns aliases.

criteriaQuery - The overall criteria query instance.

Returns:

The SQL fragment to plug into the <tt>SELECT</tt>

toGroupSqlString

public String toGroupSqlString(Criteria criteria,
                               CriteriaQuery criteriaQuery)

Description copied from interface: Projection

Render the SQL fragment to be used in the <tt>GROUP BY</tt> clause

Specified by:

toGroupSqlString in interface Projection

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 <tt>GROUP BY</tt>

getTypes

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

Description copied from interface: Projection

Types returned by the rendered SQL fragment. In other words what are the types that would represent the values this projection asked to be pulled into the result set?

Specified by:

getTypes in interface Projection

Parameters:

criteria - The local criteria to which this project is attached (for resolution).

criteriaQuery - The overall criteria query instance.

Returns:

The return types.

getTypes

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

Description copied from interface: Projection

Get the return types for a particular user-visible alias. <p/> Differs from Projection.getTypes(org.hibernate.Criteria, CriteriaQuery) in that here we are only interested in the types related to the given criteria-level alias.

Specified by:

getTypes in interface Projection

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.

getColumnAliases

public String[] getColumnAliases(int loc)

Description copied from interface: Projection

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

Specified by:

getColumnAliases in interface Projection

Parameters:

loc - Just as in Projection.toSqlString(org.hibernate.Criteria, int, org.hibernate.criterion.CriteriaQuery), represents the number of <b>columns</b> rendered prior to this projection.

Returns:

The columns aliases.

getColumnAliases

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

Description copied from interface: EnhancedProjection

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

Specified by:

getColumnAliases in interface EnhancedProjection

Parameters:

loc - Just as in Projection.toSqlString(org.hibernate.Criteria, int, org.hibernate.criterion.CriteriaQuery), represents the number of <b>columns</b> 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.

getColumnAliases

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

Description copied from interface: Projection

Get the SQL column aliases used by this projection for the columns it writes for inclusion into the <tt>SELECT</tt> clause (Projection.toSqlString(org.hibernate.Criteria, int, org.hibernate.criterion.CriteriaQuery) <i>for a particular criteria-level alias</i>.

Specified by:

getColumnAliases in interface Projection

Parameters:

alias - The criteria-level alias

loc - Just as in Projection.toSqlString(org.hibernate.Criteria, int, org.hibernate.criterion.CriteriaQuery), represents the number of <b>columns</b> 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.

getColumnAliases

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

Description copied from interface: EnhancedProjection

Get the SQL column aliases used by this projection for the columns it writes for inclusion into the <tt>SELECT</tt> clause (Projection.toSqlString(org.hibernate.Criteria, int, org.hibernate.criterion.CriteriaQuery) <i>for a particular criteria-level alias</i>.

Specified by:

getColumnAliases in interface EnhancedProjection

Parameters:

alias - The criteria-level alias

loc - Just as in Projection.toSqlString(org.hibernate.Criteria, int, org.hibernate.criterion.CriteriaQuery), represents the number of <b>columns</b> 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.

getAliases

public String[] getAliases()

Description copied from interface: Projection

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

Specified by:

getAliases in interface Projection

Returns:

The aliases

isGrouped

public boolean isGrouped()

Description copied from interface: Projection

Is this projection fragment (<tt>SELECT</tt> clause) also part of the <tt>GROUP BY</tt>

Specified by:

isGrouped in interface Projection

Returns:

True if the projection is also part of the <tt>GROUP BY</tt>; false otherwise.

toString

public String toString()

Overrides:

toString in class Object