Package io.jmix.data.impl.jpql.transform

Class QueryTransformerAstBased

java.lang.Object

io.jmix.data.impl.jpql.transform.QueryTransformerAstBased

All Implemented Interfaces:

QueryTransformer

@Scope("prototype")
@Component("data_QueryTransformer")
public class QueryTransformerAstBased
extends Object
implements QueryTransformer

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	addedParams
protected DomainModel	model
protected String	query
protected QueryTreeAnalyzer	queryAnalyzer
protected QueryTreeTransformer	queryTransformer
protected QueryTree	queryTree

Fields inherited from interface io.jmix.data.QueryTransformer

ALIAS_PLACEHOLDER

Constructor Summary

Constructors

Constructor	Description
QueryTransformerAstBased(DomainModel model, String query)

Method Summary

Modifier and Type	Method	Description
void	addDistinct()	Replaces 'select' with 'select distinct'.
void	addEntityInGroupBy(String entityAlias)	Adds @param entityAlias to 'group by' clause
void	addFirstSelectionSource(String selection)
void	addJoin(String join)	Adds 'join' clause
void	addJoinAndWhere(String join, String where)	Adds 'join' and 'where' clauses.
protected void	addJoinInternal(String join, EntityVariable entityReference)
void	addOrderByIdIfNotExists(String pkName)	Adds 'order by' clause if it doesn't exists
void	addWhere(String where)	Adds 'where' clause replacing entity alias
void	addWhereAsIs(String where)	Adds 'where' clause
protected void	addWhereInternal(org.antlr.runtime.tree.CommonTree whereTree)
protected EntityVariable	createMainIdentificationVariableNN()
protected EntityVariable	createMainSelectedPathNodeVariableNN()
Set<String>	getAddedParams()	Get parameter names found during transformation
protected QueryTreeAnalyzer	getAnalyzer()
String	getResult()	Get buffer
protected QueryTreeTransformer	getTransformer()
protected QueryTree	getTree()
void	handleCaseInsensitiveParam(String parameterName)
protected List<JoinVariableNode>	parseJoinCondition(String joinCondition)
protected OrderByFieldNode	parseOrderByItem(String sortExpression)
protected org.antlr.runtime.tree.CommonTree	parseSelectionSource(String selectionSource)
protected org.antlr.runtime.tree.CommonTree	parseWhereCondition(String whereCondition)
boolean	removeDistinct()	Replaces 'select distinct' with 'select'.
void	removeOrderBy()	Removes 'order by' clause
void	replaceEntityName(String newName)	Replace main entity name, e.g.
protected String	replaceEntityPlaceholder(String value, String variableName)
void	replaceInCondition(String parameterName)
boolean	replaceIsNullStatements(String parameterName, boolean isNullValue)	Replace all is null and is not null statements with provided parameter
void	replaceOrderByExpressions(boolean directionDesc, String... sortExpressions)	DEPRECATED.
void	replaceOrderByExpressions(Map<String,Sort.Direction> sortExpressions)	Adds or replaces 'order by' clause
void	replaceWithCount()	Replaces select e.f1, e.f2, ... clause with select count(e) ...
void	replaceWithSelectEntityVariable(String selectEntityVariable)	Replaces select e from ... clause with select 'selectEntityVariable' from ...
void	replaceWithSelectId(String pkName)	Replaces select e from ... clause with select e.pkName from ...
void	reset()	Reset internal buffer

Methods inherited from class java.lang.Object

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

Field Details

model

protected DomainModel model

query

protected String query

queryTree

protected QueryTree queryTree

queryTransformer

protected QueryTreeTransformer queryTransformer

queryAnalyzer

protected QueryTreeAnalyzer queryAnalyzer

addedParams

protected Set<String> addedParams

Constructor Details

QueryTransformerAstBased

public QueryTransformerAstBased(DomainModel model,
 String query)

Method Details

getTransformer

protected QueryTreeTransformer getTransformer()

getAnalyzer

protected QueryTreeAnalyzer getAnalyzer()

getTree

protected QueryTree getTree()

getResult

public String getResult()

Description copied from interface: QueryTransformer

Get buffer

Specified by:

getResult in interface QueryTransformer

getAddedParams

public Set<String> getAddedParams()

Description copied from interface: QueryTransformer

Get parameter names found during transformation

Specified by:

getAddedParams in interface QueryTransformer

handleCaseInsensitiveParam

public void handleCaseInsensitiveParam(String parameterName)

Specified by:

handleCaseInsensitiveParam in interface QueryTransformer

addWhere

public void addWhere(String where)

Description copied from interface: QueryTransformer

Adds 'where' clause replacing entity alias

Specified by:

addWhere in interface QueryTransformer

Parameters:

where - - "{E}" may be used as a replaceable entity placeholder. No such value should be used as a string constant

addWhereAsIs

public void addWhereAsIs(String where)

Description copied from interface: QueryTransformer

Adds 'where' clause

Specified by:

addWhereAsIs in interface QueryTransformer

addJoin

public void addJoin(String join)

Description copied from interface: QueryTransformer

Adds 'join' clause

Specified by:

addJoin in interface QueryTransformer

addJoinAndWhere

public void addJoinAndWhere(String join,
 String where)

Description copied from interface: QueryTransformer

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

Specified by:

addJoinAndWhere in interface QueryTransformer

addFirstSelectionSource

public void addFirstSelectionSource(String selection)

Specified by:

addFirstSelectionSource in interface QueryTransformer

replaceWithCount

public void replaceWithCount()

Description copied from interface: QueryTransformer

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

Specified by:

replaceWithCount in interface QueryTransformer

replaceWithSelectId

public void replaceWithSelectId(String pkName)

Description copied from interface: QueryTransformer

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

Specified by:

replaceWithSelectId in interface QueryTransformer

replaceWithSelectEntityVariable

public void replaceWithSelectEntityVariable(String selectEntityVariable)

Description copied from interface: QueryTransformer

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

Specified by:

replaceWithSelectEntityVariable in interface QueryTransformer

removeDistinct

public boolean removeDistinct()

Description copied from interface: QueryTransformer

Replaces 'select distinct' with 'select'.

Specified by:

removeDistinct in interface QueryTransformer

Returns:

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

addDistinct

public void addDistinct()

Description copied from interface: QueryTransformer

Replaces 'select' with 'select distinct'.

Specified by:

addDistinct in interface QueryTransformer

replaceOrderByExpressions

public void replaceOrderByExpressions(boolean directionDesc,
 String... sortExpressions)

Description copied from interface: QueryTransformer

DEPRECATED. Use QueryTransformer.replaceOrderByExpressions(Map)

Specified by:

replaceOrderByExpressions in interface QueryTransformer

replaceOrderByExpressions

public void replaceOrderByExpressions(Map<String,Sort.Direction> sortExpressions)

Description copied from interface: QueryTransformer

Adds or replaces 'order by' clause

Specified by:

replaceOrderByExpressions in interface QueryTransformer

addOrderByIdIfNotExists

public void addOrderByIdIfNotExists(String pkName)

Description copied from interface: QueryTransformer

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

Specified by:

addOrderByIdIfNotExists in interface QueryTransformer

addEntityInGroupBy

public void addEntityInGroupBy(String entityAlias)

Description copied from interface: QueryTransformer

Adds @param entityAlias to 'group by' clause

Specified by:

addEntityInGroupBy in interface QueryTransformer

removeOrderBy

public void removeOrderBy()

Description copied from interface: QueryTransformer

Removes 'order by' clause

Specified by:

removeOrderBy in interface QueryTransformer

replaceEntityName

public void replaceEntityName(String newName)

Description copied from interface: QueryTransformer

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

Specified by:

replaceEntityName in interface QueryTransformer

reset

public void reset()

Description copied from interface: QueryTransformer

Reset internal buffer

Specified by:

reset in interface QueryTransformer

replaceInCondition

public void replaceInCondition(String parameterName)

Specified by:

replaceInCondition in interface QueryTransformer

replaceIsNullStatements

public boolean replaceIsNullStatements(String parameterName,
 boolean isNullValue)

Description copied from interface: QueryTransformer

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

Specified by:

replaceIsNullStatements in interface QueryTransformer

Parameters:

parameterName - name of the parameter

isNullValue - is parameter value null

Returns:

true if at least one statement was replaced, false otherwise

parseWhereCondition

protected org.antlr.runtime.tree.CommonTree parseWhereCondition(String whereCondition)

parseJoinCondition

protected List<JoinVariableNode> parseJoinCondition(String joinCondition)

parseSelectionSource

protected org.antlr.runtime.tree.CommonTree parseSelectionSource(String selectionSource)

parseOrderByItem

protected OrderByFieldNode parseOrderByItem(String sortExpression)

replaceEntityPlaceholder

protected String replaceEntityPlaceholder(String value,
 String variableName)

addWhereInternal

protected void addWhereInternal(org.antlr.runtime.tree.CommonTree whereTree)

addJoinInternal

protected void addJoinInternal(String join,
 EntityVariable entityReference)

createMainIdentificationVariableNN

protected EntityVariable createMainIdentificationVariableNN()

createMainSelectedPathNodeVariableNN

protected EntityVariable createMainSelectedPathNodeVariableNN()