org.nuiton.topia.persistence

Class HqlAndParametersBuilder<E extends TopiaEntity>

java.lang.Object

org.nuiton.topia.persistence.HqlAndParametersBuilder<E>

public class HqlAndParametersBuilder<E extends TopiaEntity>
extends Object

A builder to create syntactically correct HQL and associated parameters given properties or after various constraint adds.

It may be used in a Dao to ease dynamic construction of queries.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
protected String	alias
protected Class<E>	entityClass
protected Set<String>	orderByArguments
protected Map<String,Object>	parameters
protected Set<String>	whereClauses

Constructor Summary

Constructors

Constructor and Description
HqlAndParametersBuilder(Class<E> entityClass)

Method Summary

Methods

Modifier and Type	Method and Description
void	addContains(String property, Object value)
void	addEquals(String property, Object value)
void	addIn(String property, Iterable<?> values)
protected void	addInOrNotIn(String property, Iterable<?> values, boolean in)
void	addNotContains(String property, Object value)
void	addNotEquals(String property, Object value)
void	addNotIn(String property, Iterable<?> values)
void	addNotNull(String property)
void	addNull(String property)
void	addTopiaIdEquals(String property, String topiaId)
void	addTopiaIdIn(String property, Iterable<String> topiaIds)
void	addTopiaIdNotEquals(String property, String topiaId)
void	addTopiaIdNotIn(String property, Iterable<String> topiaIds)
void	addWhereClause(String whereClause)
void	addWhereClause(String whereClause, Map<String,Object> hqlParameters)
String	getHql()
Map<String,Object>	getHqlParameters()
protected String	getParameterName(String propertyName) Converts a (nested) property name to an HQL argument name.
Set<String>	getWhereClauses()
boolean	isOrderByClausePresent()
protected String	putHqlParameterWithAvailableName(String propertyName, Object value) Add a parameter in the parameters map searching with the suitable parameter name in order to prevent conflicts.
void	setAlias(String alias)
void	setOrderByArguments(Set<String> orderByArguments)
void	setOrderByArguments(String... orderByArguments)
void	setParameters(Map<String,Object> parameters)
void	setWhereClauses(Set<String> whereClauses)

Methods inherited from class java.lang.Object

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

Field Detail

entityClass

protected Class<E extends TopiaEntity> entityClass

whereClauses

protected Set<String> whereClauses

parameters

protected Map<String,Object> parameters

orderByArguments

protected Set<String> orderByArguments

alias

protected String alias

Constructor Detail

HqlAndParametersBuilder

public HqlAndParametersBuilder(Class<E> entityClass)

Method Detail

setAlias

public void setAlias(String alias)

addNull

public void addNull(String property)

addNotNull

public void addNotNull(String property)

addEquals

public void addEquals(String property,
             Object value)

addNotEquals

public void addNotEquals(String property,
                Object value)

addIn

public void addIn(String property,
         Iterable<?> values)

addNotIn

public void addNotIn(String property,
            Iterable<?> values)

addInOrNotIn

protected void addInOrNotIn(String property,
                Iterable<?> values,
                boolean in)

Parameters:

in - true if property value must be in given collection, false if value must not be in given collection

addTopiaIdEquals

public void addTopiaIdEquals(String property,
                    String topiaId)

addTopiaIdIn

public void addTopiaIdIn(String property,
                Iterable<String> topiaIds)

addTopiaIdNotEquals

public void addTopiaIdNotEquals(String property,
                       String topiaId)

addTopiaIdNotIn

public void addTopiaIdNotIn(String property,
                   Iterable<String> topiaIds)

addContains

public void addContains(String property,
               Object value)

addNotContains

public void addNotContains(String property,
                  Object value)

addWhereClause

public void addWhereClause(String whereClause)

addWhereClause

public void addWhereClause(String whereClause,
                  Map<String,Object> hqlParameters)

setWhereClauses

public void setWhereClauses(Set<String> whereClauses)

getWhereClauses

public Set<String> getWhereClauses()

setParameters

public void setParameters(Map<String,Object> parameters)

setOrderByArguments

public void setOrderByArguments(Set<String> orderByArguments)

setOrderByArguments

public void setOrderByArguments(String... orderByArguments)

getHql

public String getHql()

getParameterName

protected String getParameterName(String propertyName)

Converts a (nested) property name to an HQL argument name.

For example getParameterName("yearlyDeclaration.survey.topiaId") → "yearlyDeclarationSurveyTopiaId"

Parameters:

propertyName - the name of a property, can be a path to a nested property

Returns:

a string that can syntactically be used as an HQL parameter name, not prefixed by ':'

putHqlParameterWithAvailableName

protected String putHqlParameterWithAvailableName(String propertyName,
                                      Object value)

Add a parameter in the parameters map searching with the suitable parameter name in order to prevent conflicts.

Returns:

the found key where the parameter has been added, suitable to use in the where clause

getHqlParameters

public Map<String,Object> getHqlParameters()

isOrderByClausePresent

public boolean isOrderByClausePresent()