Skip navigation links

org.eclipse.persistence.jpa.jpql
Class JPQLQueryHelper

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

public class JPQLQueryHelper

extends AbstractJPQLQueryHelper

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

  Constructor Summary

  JPQLQueryHelper()
  Creates a new JPQLQueryHelper.

  JPQLQueryHelper(JPQLQueryContext queryContext)
  Creates a new JPQLQueryHelper.

  Method Summary

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

  Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.AbstractJPQLQueryHelper

  getQueryContext, setJPQLExpression, validate, validateGrammar, validateSemantic

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  JPQLQueryHelper

  public JPQLQueryHelper()
  

  Creates a new JPQLQueryHelper.

  JPQLQueryHelper

  public JPQLQueryHelper(JPQLQueryContext queryContext)
  

  Creates a new JPQLQueryHelper.

  Parameters:

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

  Method Detail

  buildContentAssistProposals

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

  Overrides:

  buildContentAssistProposals in class AbstractJPQLQueryHelper

  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

  dispose

  public void dispose()
  

  Disposes of the internal data.

  Overrides:

  dispose in class AbstractJPQLQueryHelper

  getParameterType

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

  Overrides:

  getParameterType in class AbstractJPQLQueryHelper

  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

  getParsedJPQLQuery

  public java.lang.String getParsedJPQLQuery()
  

  Returns the string representation of the parsed tree.

  Overrides:

  getParsedJPQLQuery in class AbstractJPQLQueryHelper

  Returns:

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

  getProvider

  public IManagedTypeProvider getProvider()
  

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

  Overrides:

  getProvider in class AbstractJPQLQueryHelper

  Returns:

  The container of managed types

  getQuery

  public IQuery getQuery()
  

  Returns the external form representing a named query.

  Overrides:

  getQuery in class AbstractJPQLQueryHelper

  Returns:

  The external form representing a named query

  getResultType

  public IType getResultType()
  

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

  See TypeVisitor to understand how the type is calculated.

  Overrides:

  getResultType in class AbstractJPQLQueryHelper

  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

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

  Returns the IType representing the given Java type.

  Overrides:

  getType in class AbstractJPQLQueryHelper

  Parameters:

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

  Returns:

  The external form for the given Java type

  getTypeHelper

  public TypeHelper getTypeHelper()
  

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

  Overrides:

  getTypeHelper in class AbstractJPQLQueryHelper

  Returns:

  A helper containing a collection of methods related to IType

  getTypeRepository

  public ITypeRepository getTypeRepository()
  

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

  Overrides:

  getTypeRepository in class AbstractJPQLQueryHelper

  Returns:

  The repository for classes, interfaces, enum types and annotations

  setQuery

  public void setQuery(IQuery query)
  

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

  Overrides:

  setQuery in class AbstractJPQLQueryHelper

  Parameters:

  query - The external form of the JPQL query

  validate

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

  Validates the query by introspecting it grammatically and semantically.

  Overrides:

  validate in class AbstractJPQLQueryHelper

  Returns:

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

  validateGrammar

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

  Validates the query by only introspecting it grammatically.

  Overrides:

  validateGrammar in class AbstractJPQLQueryHelper

  Returns:

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

  validateSemantic

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

  Validates the query by only introspecting it semantically.

  Overrides:

  validateSemantic in class AbstractJPQLQueryHelper

  Returns:

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