public class EclipseLinkJPQLQueryHelper
extends AbstractJPQLQueryHelper

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

• Calculates the result type of a query: AbstractJPQLQueryHelper.getResultType();
• Calculates the type of an input parameter: AbstractJPQLQueryHelper.getParameterType(String).
• Calculates the possible choices to complete the query from a given position (used for content assist): AbstractJPQLQueryHelper.buildContentAssistProposals(int).
• Validates the query by introspecting it grammatically and semantically:
  • AbstractJPQLQueryHelper.validate(),
  • AbstractJPQLQueryHelper.validateGrammar(),
  • AbstractJPQLQueryHelper.validateSemantic().
• Refactoring support:
  • buildBasicRefactoringTool() provides support for generating the delta of the refactoring operation through a collection of TextEdit objects.
  • buildRefactoringTool() provides support for refactoring the JPQL query through the editable StateObject and once all refactoring operations have been executed, the IJPQLQueryFormatter will generate a new string representation of the JPQL query.

This helper should be used when the JPQL query is written using the JPQL grammar defined in the Java Persistence functional specification 2.1 and it contains the additional support provided by EclipseLink.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.