Module spring.data.jpa
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, Yanming Zhou, Christoph Strobl

  • 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

    • hasConstructorExpression

      public boolean hasConstructorExpression()
      Description copied from interface: QueryEnhancer
      Returns whether the given JPQL query contains a constructor expression.
      Specified by:
      hasConstructorExpression in interface QueryEnhancer
      Returns:
      whether the given JPQL query contains a constructor expression.

    • 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.

    • 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()
      Description copied from interface: QueryEnhancer
      Returns the join aliases of the query.
      Specified by:
      getJoinAliases in interface QueryEnhancer
      Returns:
      the join aliases of the query.

    • getSelectionAliases

      public Set<String> getSelectionAliases()

    • 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.

    • applySorting

      public String applySorting(Sort sort)
      Description copied from interface: QueryEnhancer
      Adds order by clause to the JPQL query. Uses the first alias to bind the sorting property to.
      Specified by:
      applySorting in interface QueryEnhancer
      Parameters:
      sort - the sort specification to apply.
      Returns:
      the modified query string.

    • 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.

    • 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.