Skip navigation links

org.eclipse.persistence.jpa.internal.jpql
Class AbstractJPQLQueryHelper

java.lang.Object
org.eclipse.persistence.jpa.internal.jpql.AbstractJPQLQueryHelper

Direct Known Subclasses:

JPQLQueryHelper

public abstract class AbstractJPQLQueryHelper

extends java.lang.Object

This helper can perform the following operations over a JPQL query:

• Calculates the result type of a query: getResultType();
• Calculates the type of an input parameter: getParameterType(String).
• Calculates the possible choices to complete the query from a given position (used for content assist): #buildContentAssistItems(int).
• Validates the query by introspecting it grammatically and semantically:
  • validate(),
  • validateGrammar(),
  • validateSemantic().

• Since:

  2.3

  Version:

  2.3

  Author:

  Pascal Filion

  Field Summary

  private ContentAssistVisitor	contentAssistVisitor This visitor is responsible to gather the possible proposals based on the position of the caret within the JPQL query.
  private GrammarValidator	grammarValidator This visitor is responsible to visit the entire parsed tree representation of the JPQL query and to validate its content based on the JPQL grammar.
  private JPQLQueryContext	queryContext The context used to query information about the JPQL query.
  private SemanticValidator	semanticValidator This visitor is responsible to visit the entire parsed tree representation of the JPQL query and to validate the semantic of the information.

  Constructor Summary

  protected	AbstractJPQLQueryHelper() Creates a new AbstractJPQLQueryHelper.
  protected	AbstractJPQLQueryHelper(JPQLQueryContext queryContext) Creates a new AbstractJPQLQueryHelper.

  Method Summary

  protected ContentAssistProposals	buildContentAssistProposals(int position) Retrieves the possibles choices that can complete the query from the given position within the query.
  private java.util.Comparator<IType>	buildNumericTypeComparator()
  private ContentAssistVisitor	contentAssistVisitor()
  protected void	dispose() Disposes of the internal data.
  private JPQLExpression	getJPQLExpression()
  protected IType	getParameterType(java.lang.String parameterName) Retrieves, if it can be determined, the type of the given input parameter with the given name.
  protected java.lang.String	getParsedJPQLQuery() Returns the string representation of the parsed tree.
  protected IManagedTypeProvider	getProvider() Returns the provider for managed types (entities, embeddables, mapped superclasses).
  protected IQuery	getQuery() Returns the external form representing a named query.
  protected JPQLQueryContext	getQueryContext() Returns the JPQLQueryContext that contains information about the JPQL query.
  protected IType	getResultType() Calculates the type of the query result of the JPQL query.
  protected IType	getType(java.lang.Class<?> type) Returns the IType representing the given Java type.
  protected TypeHelper	getTypeHelper() Returns a helper that gives access to the most common types.
  protected ITypeRepository	getTypeRepository() Returns the repository that gives access to the application's types.
  private GrammarValidator	grammarValidator()
  private SemanticValidator	semanticValidator()
  void	setJPQLExpression(JPQLExpression jpqlExpression) Sets
  protected void	setQuery(IQuery query) Sets the external form of the JPQL query, which will be parsed and information will be extracted for later access.
  protected java.util.List<JPQLQueryProblem>	validate() Validates the query by introspecting it grammatically and semantically.
  void	validate(Expression expression, java.util.List<JPQLQueryProblem> problems) Validates the query by introspecting it grammatically and semantically.
  protected java.util.List<JPQLQueryProblem>	validateGrammar() Validates the query by only introspecting it grammatically.
  void	validateGrammar(Expression expression, java.util.List<JPQLQueryProblem> problems) Validates the query by only introspecting it grammatically.
  protected java.util.List<JPQLQueryProblem>	validateSemantic() Validates the query by only introspecting it semantically.
  void	validateSemantic(Expression expression, java.util.List<JPQLQueryProblem> problems) Validates the query by only introspecting it semantically.

  Methods inherited from class java.lang.Object

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

  Field Detail

  contentAssistVisitor

  private ContentAssistVisitor contentAssistVisitor
  

  This visitor is responsible to gather the possible proposals based on the position of the caret within the JPQL query.

  grammarValidator

  private GrammarValidator grammarValidator
  

  This visitor is responsible to visit the entire parsed tree representation of the JPQL query and to validate its content based on the JPQL grammar.

  queryContext

  private final JPQLQueryContext queryContext
  

  The context used to query information about the JPQL query.

  semanticValidator

  private SemanticValidator semanticValidator
  

  This visitor is responsible to visit the entire parsed tree representation of the JPQL query and to validate the semantic of the information.

  Constructor Detail

  AbstractJPQLQueryHelper

  protected AbstractJPQLQueryHelper()
  

  Creates a new AbstractJPQLQueryHelper.

  AbstractJPQLQueryHelper

  protected AbstractJPQLQueryHelper(JPQLQueryContext queryContext)
  

  Creates a new AbstractJPQLQueryHelper.

  Parameters:

  queryContext - The context used to query information about the JPQL query

  Method Detail

  buildContentAssistProposals

  protected ContentAssistProposals buildContentAssistProposals(int position)
  

  Retrieves the possibles choices that can complete the query from the given position within the query.

  Note: Disposing of the internal data is not done automatically.

  Parameters:

  position - The position within the query for which a list of possible choices are created for completing the query

  Returns:

  The list of valid proposals regrouped by categories

  contentAssistVisitor

  private ContentAssistVisitor contentAssistVisitor()
  

  dispose

  protected void dispose()
  

  Disposes of the internal data.

  getJPQLExpression

  private JPQLExpression getJPQLExpression()
  

  getParameterType

  protected IType getParameterType(java.lang.String parameterName)
  

  Retrieves, if it can be determined, the type of the given input parameter with the given name. The type will be guessed based on its location within expression.

  Note: Both named and positional input parameter can be used.

  Parameters:

  parameterName - The name of the input parameter to retrieve its type, which needs to be prepended by ':' or '?'

  Returns:

  Either the closest type of the input parameter or null if the type couldn't be determined

  buildNumericTypeComparator

  private java.util.Comparator<IType> buildNumericTypeComparator()
  

  getParsedJPQLQuery

  protected java.lang.String getParsedJPQLQuery()
  

  Returns the string representation of the parsed tree.

  Returns:

  The string created from the parsed tree representation of the original JPQL query

  getProvider

  protected IManagedTypeProvider getProvider()
  

  Returns the provider for managed types (entities, embeddables, mapped superclasses).

  Returns:

  The container of managed types

  getQuery

  protected IQuery getQuery()
  

  Returns the external form representing a named query.

  Returns:

  The external form representing a named query

  getQueryContext

  protected JPQLQueryContext getQueryContext()
  

  Returns the JPQLQueryContext that contains information about the JPQL query.

  Returns:

  The JPQLQueryContext that contains information contained in the JPQL query

  getResultType

  protected IType getResultType()
  

  Calculates the type of the query result of the JPQL query.

  See TypeVisitor to understand how the type is calculated.

  Returns:

  The result type of the JPQL query if it could accurately be calculated or the IClass for Object if it could not be calculated

  getType

  protected IType getType(java.lang.Class<?> type)
  

  Returns the IType representing the given Java type.

  Parameters:

  type - The Java type for which its external form is requested

  Returns:

  The external form for the given Java type

  getTypeHelper

  protected TypeHelper getTypeHelper()
  

  Returns a helper that gives access to the most common types.

  Returns:

  A helper containing a collection of methods related to IType

  getTypeRepository

  protected ITypeRepository getTypeRepository()
  

  Returns the repository that gives access to the application's types.

  Returns:

  The repository for classes, interfaces, enum types and annotations

  grammarValidator

  private GrammarValidator grammarValidator()
  

  semanticValidator

  private SemanticValidator semanticValidator()
  

  setJPQLExpression

  public final void setJPQLExpression(JPQLExpression jpqlExpression)
  

  Sets

  Parameters:

  jpqlExpression -

  setQuery

  protected void setQuery(IQuery query)
  

  Sets the external form of the JPQL query, which will be parsed and information will be extracted for later access.

  Parameters:

  query - The external form of the JPQL query

  validate

  protected java.util.List<JPQLQueryProblem> validate()
  

  Validates the query by introspecting it grammatically and semantically.

  Returns:

  The non-null list that will be used to store the problems if any was found

  validate

  public void validate(Expression expression,
                       java.util.List<JPQLQueryProblem> problems)
  

  Validates the query by introspecting it grammatically and semantically.

  Parameters:

  jpqlExpression - The parsed tree representation of the query

  problems - A non-null list that will be used to store the problems if any was found

  validateGrammar

  protected java.util.List<JPQLQueryProblem> validateGrammar()
  

  Validates the query by only introspecting it grammatically.

  Returns:

  The non-null list that will be used to store the problems if any was found

  validateGrammar

  public void validateGrammar(Expression expression,
                              java.util.List<JPQLQueryProblem> problems)
  

  Validates the query by only introspecting it grammatically.

  Parameters:

  expression - The parsed tree representation of the query

  problems - A non-null list that will be used to store the problems if any was found

  validateSemantic

  protected java.util.List<JPQLQueryProblem> validateSemantic()
  

  Validates the query by only introspecting it semantically.

  Returns:

  The non-null list that will be used to store the problems if any was found

  validateSemantic

  public void validateSemantic(Expression expression,
                               java.util.List<JPQLQueryProblem> problems)
  

  Validates the query by only introspecting it semantically.

  Parameters:

  expression - The parsed tree representation of the query

  problems - A non-null list that will be used to store the problems if any was found