Package org.springframework.data.jpa.repository.query

Class JSqlParserQueryEnhancer

java.lang.Object

org.springframework.data.jpa.repository.query.JSqlParserQueryEnhancer

All Implemented Interfaces:

QueryEnhancer

public class JSqlParserQueryEnhancer
extends Object
implements QueryEnhancer

The implementation of QueryEnhancer using JSqlParser.

Since:

2.7.0

Author:

Diego Krupitza, Greg Turnquist, Geoffrey Deremetz

Constructor Summary

Constructors

Constructor	Description
JSqlParserQueryEnhancer(org.springframework.data.jpa.repository.query.DeclaredQuery query)

Method Summary

Modifier and Type	Method	Description
String	applySorting(Sort sort, String alias)	Adds order by clause to the JPQL query.
String	createCountQueryFor(String countProjection)	Creates a count projected query from the given original query using the provided countProjection.
String	detectAlias()	Resolves the alias for the entity to be retrieved from the given JPA query.
Set<String>	getJoinAliases()
String	getProjection()	Returns the projection part of the query, i.e. everything between select and from.
org.springframework.data.jpa.repository.query.DeclaredQuery	getQuery()	Gets the query we want to use for enhancements.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.jpa.repository.query.QueryEnhancer

applySorting, createCountQueryFor, hasConstructorExpression

Constructor Details

JSqlParserQueryEnhancer

public JSqlParserQueryEnhancer(org.springframework.data.jpa.repository.query.DeclaredQuery query)

Parameters:

query - the query we want to enhance. Must not be null.

Method Details

applySorting

public String applySorting(Sort sort,
 @Nullable
 String alias)

Description copied from interface: QueryEnhancer

Adds order by clause to the JPQL query.

Specified by:

applySorting in interface QueryEnhancer

Parameters:

sort - the sort specification to apply.

alias - the alias to be used in the order by clause. May be null or empty.

Returns:

the modified query string.

detectAlias

public String detectAlias()

Description copied from interface: QueryEnhancer

Resolves the alias for the entity to be retrieved from the given JPA query.

Specified by:

detectAlias in interface QueryEnhancer

Returns:

Might return null.

createCountQueryFor

public String createCountQueryFor(@Nullable
 String countProjection)

Description copied from interface: QueryEnhancer

Creates a count projected query from the given original query using the provided countProjection.

Specified by:

createCountQueryFor in interface QueryEnhancer

Parameters:

countProjection - may be null.

Returns:

a query String to be used a count query for pagination. Guaranteed to be not null.

getProjection

public String getProjection()

Description copied from interface: QueryEnhancer

Returns the projection part of the query, i.e. everything between select and from.

Specified by:

getProjection in interface QueryEnhancer

Returns:

the projection part of the query.

getJoinAliases

public Set<String> getJoinAliases()

Specified by:

getJoinAliases in interface QueryEnhancer

getQuery

public org.springframework.data.jpa.repository.query.DeclaredQuery getQuery()

Description copied from interface: QueryEnhancer

Gets the query we want to use for enhancements.

Specified by:

getQuery in interface QueryEnhancer

Returns:

non-null DeclaredQuery that wraps the query