com.haulmont.cuba.core.global

Interface QueryTransformer

All Known Implementing Classes:

QueryTransformerAstBased, QueryTransformerRegex

public interface QueryTransformer

Transforms JPQL query

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALIAS_PLACEHOLDER Main entity alias placeholder
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	addDistinct() Replaces 'select' with 'select distinct'.
void	addEntityInGroupBy(java.lang.String entityAlias) Adds @param entityAlias to 'group by' clause
void	addFirstSelectionSource(java.lang.String selection)
void	addJoinAndWhere(java.lang.String join, java.lang.String where) Adds 'join' and 'where' clauses.
void	addJoinAsIs(java.lang.String join) Adds 'join' clause
void	addOrderByIdIfNotExists(java.lang.String idProperty) Adds 'order by' clause if it doesn't exists
void	addWhere(java.lang.String where) Adds 'where' clause replacing entity alias
void	addWhereAsIs(java.lang.String where) Adds 'where' clause
java.util.Set<java.lang.String>	getAddedParams() Get parameter names found during transformation
java.lang.String	getResult() Get buffer
void	handleCaseInsensitiveParam(java.lang.String paramName)
void	mergeWhere(java.lang.String query) Deprecated.
boolean	removeDistinct() Replaces 'select distinct' with 'select'.
void	removeOrderBy() Removes 'order by' clause
void	replaceEntityName(java.lang.String newName) Replace main entity name, e.g.
void	replaceInCondition(java.lang.String paramName)
default boolean	replaceIsNullStatements(java.lang.String paramName, boolean isNullValue) Replace all is null and is not null statements with provided parameter
void	replaceOrderBy(boolean desc, java.lang.String... properties) Adds or replaces 'order by' clause
void	replaceWithCount() Replaces select e.f1, e.f2, ... clause with select count(e) ...
void	replaceWithSelectEntityVariable(java.lang.String selectEntityVariable) Replaces select e from ... clause with select 'selectEntityVariable' from ...
void	replaceWithSelectId() Replaces select e from ... clause with select e.id from ...
void	replaceWithSelectId(java.lang.String pkName) Replaces select e from ... clause with select e.pkName from ...
void	reset() Reset internal buffer

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

ALIAS_PLACEHOLDER

static final java.lang.String ALIAS_PLACEHOLDER

Main entity alias placeholder

See Also:

Constant Field Values

Method Detail

addWhere

void addWhere(java.lang.String where)

Adds 'where' clause replacing entity alias

addWhereAsIs

void addWhereAsIs(java.lang.String where)

Adds 'where' clause

addJoinAsIs

void addJoinAsIs(java.lang.String join)

Adds 'join' clause

addJoinAndWhere

void addJoinAndWhere(java.lang.String join,
                     java.lang.String where)

Adds 'join' and 'where' clauses. Replaces alias in 'join' but doesn't replace it in 'where'

addFirstSelectionSource

void addFirstSelectionSource(java.lang.String selection)

mergeWhere

@Deprecated
void mergeWhere(java.lang.String query)

Deprecated.

Adds 'where' clause from the query provided. Replaces entity alias

replaceWithCount

void replaceWithCount()

Replaces select e.f1, e.f2, ... clause with select count(e) ...

replaceWithSelectId

void replaceWithSelectId()

Replaces select e from ... clause with select e.id from ...

replaceWithSelectId

void replaceWithSelectId(java.lang.String pkName)

Replaces select e from ... clause with select e.pkName from ...

replaceWithSelectEntityVariable

void replaceWithSelectEntityVariable(java.lang.String selectEntityVariable)

Replaces select e from ... clause with select 'selectEntityVariable' from ...

removeDistinct

boolean removeDistinct()

Replaces 'select distinct' with 'select'.

Returns:

true if 'distinct' was really removed, false if there was no 'distinct' in the query

addDistinct

void addDistinct()

Replaces 'select' with 'select distinct'.

replaceOrderBy

void replaceOrderBy(boolean desc,
                    java.lang.String... properties)

Adds or replaces 'order by' clause

addOrderByIdIfNotExists

void addOrderByIdIfNotExists(java.lang.String idProperty)

Adds 'order by' clause if it doesn't exists

addEntityInGroupBy

void addEntityInGroupBy(java.lang.String entityAlias)

Adds @param entityAlias to 'group by' clause

removeOrderBy

void removeOrderBy()

Removes 'order by' clause

replaceEntityName

void replaceEntityName(java.lang.String newName)

Replace main entity name, e.g. "select d ref$Driver d" with "select d ref$ExtDriver d"

reset

void reset()

Reset internal buffer

getResult

java.lang.String getResult()

Get buffer

getAddedParams

java.util.Set<java.lang.String> getAddedParams()

Get parameter names found during transformation

handleCaseInsensitiveParam

void handleCaseInsensitiveParam(java.lang.String paramName)

replaceInCondition

void replaceInCondition(java.lang.String paramName)

replaceIsNullStatements

default boolean replaceIsNullStatements(java.lang.String paramName,
                                        boolean isNullValue)

Replace all is null and is not null statements with provided parameter

Parameters:

paramName - name of the parameter

isNullValue - is parameter value null

Returns:

true if at least one statement was replaced, false otherwise