org.hibernate.envers.internal.tools.query

Class QueryBuilder

java.lang.Object

org.hibernate.envers.internal.tools.query.QueryBuilder

public class QueryBuilder
extends java.lang.Object

A class for incrementally building a HQL query.

Constructor Summary

Constructors

Constructor and Description
QueryBuilder(java.lang.String entityName, java.lang.String alias)

Method Summary

Modifier and Type	Method and Description
void	addFrom(java.lang.String entityName, java.lang.String alias, boolean select) Add an entity from which to select.
Parameters	addJoin(javax.persistence.criteria.JoinType joinType, java.lang.String entityName, java.lang.String alias, boolean select)
void	addOrder(java.lang.String alias, java.lang.String propertyName, boolean ascending)
Parameters	addParameters(java.lang.String alias)
void	addProjection(java.lang.String function, java.lang.String alias, java.lang.String propertyName, boolean distinct)
void	build(java.lang.StringBuilder sb, java.util.Map<java.lang.String,java.lang.Object> queryParamValues) Builds the given query, appending results to the given string buffer, and adding all query parameter values that are used to the map provided.
QueryBuilder	deepCopy()
java.lang.String	generateAlias()
java.lang.String	getAlias()
java.lang.String	getRootAlias()
Parameters	getRootParameters()
QueryBuilder	newSubQueryBuilder(java.lang.String entityName, java.lang.String alias)
Query	toQuery(Session session)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryBuilder

public QueryBuilder(java.lang.String entityName,
                    java.lang.String alias)

Parameters:

entityName - Main entity which should be selected.

alias - Alias of the entity

Method Detail

deepCopy

public QueryBuilder deepCopy()

getAlias

public java.lang.String getAlias()

Returns:

the main alias of this query builder

addFrom

public void addFrom(java.lang.String entityName,
                    java.lang.String alias,
                    boolean select)

Add an entity from which to select.

Parameters:

entityName - Name of the entity from which to select.

alias - Alias of the entity. Should be different than all other aliases.

select - whether the entity should be selected

addJoin

public Parameters addJoin(javax.persistence.criteria.JoinType joinType,
                          java.lang.String entityName,
                          java.lang.String alias,
                          boolean select)

generateAlias

public java.lang.String generateAlias()

newSubQueryBuilder

public QueryBuilder newSubQueryBuilder(java.lang.String entityName,
                                       java.lang.String alias)

Parameters:

entityName - Entity name, which will be the main entity for the sub-query.

alias - Alias of the entity, which can later be used in parameters.

Returns:

A sub-query builder for the given entity, with the given alias. The sub-query can be later used as a value of a parameter.

getRootParameters

public Parameters getRootParameters()

addParameters

public Parameters addParameters(java.lang.String alias)

addOrder

public void addOrder(java.lang.String alias,
                     java.lang.String propertyName,
                     boolean ascending)

addProjection

public void addProjection(java.lang.String function,
                          java.lang.String alias,
                          java.lang.String propertyName,
                          boolean distinct)

build

public void build(java.lang.StringBuilder sb,
                  java.util.Map<java.lang.String,java.lang.Object> queryParamValues)

Builds the given query, appending results to the given string buffer, and adding all query parameter values that are used to the map provided.

Parameters:

sb - String builder to which the query will be appended.

queryParamValues - Map to which name and values of parameters used in the query should be added.

getRootAlias

public java.lang.String getRootAlias()

toQuery

public Query toQuery(Session session)