org.eclipse.jpt.jpa.core.jpql
Class JpaJpqlQueryHelper

java.lang.Object
  AbstractJPQLQueryHelper
      org.eclipse.jpt.jpa.core.jpql.JpaJpqlQueryHelper

public abstract class JpaJpqlQueryHelper
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 its grammar and semantic:
  • #validate(),
  • #validateGrammar(),
  • #validateSemantic().
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.

Since:

3.0

Nested Class Summary

static class

JpaJpqlQueryHelper.EscapeType Constants used to determine how to escape the JPQL query.

Constructor Summary

protected

JpaJpqlQueryHelper(JPQLGrammar jpqlGrammar) Creates a new JpaQueryHelper.

Method Summary

ContentAssistProposals	buildContentAssistProposals(int position)
protected ContentAssistExtension	buildContentAssistProposalsHelper() Creates the helper that will be used to extend the support for JPQL content assist.
protected abstract IManagedTypeBuilder	buildManagedTypeBuilder() Create the builder that will create the right implementation of {@link org.eclipse.persistence.
protected abstract	buildMappingBuilder() Create the builder that will create the right implementation of {@link org.eclipse.persistence.
int[]	buildPositions(JPQLQueryProblem problem, String parsedJpqlQuery, String jpqlQuery, String actualJpqlQuery, int offset, JpaJpqlQueryHelper.EscapeType escapeType) Calculates the start and end positions by adjusting them to be at the same position within jpqlQuery, which may differ from parsedJpqlQuery since the parsed tree does not keep track of multiple whitespace.
protected List<IMessage>	buildProblems(NamedQuery namedQuery, List<TextRange> textRanges, JPQLQueryProblem problem, String parsedJpqlQuery, String jpqlQuery, String actualJpqlQuery, int offset, JpaJpqlQueryHelper.EscapeType escapeType) Creates a new IMessage for the given JPQLQueryProblem.
protected JpaManagedTypeProvider	buildProvider(JpaProject jpaProject, PersistenceUnit persistenceUnit) Creates a new JpaManagedTypeProvider which will provide access to the application's JPA metadata information.
protected String	getValidationPreference(NamedQuery namedQuery)
void	setQuery(NamedQuery namedQuery, String actualQuery) Sets the given named query and string representation of the JPQL query.
protected boolean	shouldValidate(NamedQuery namedQuery)
void	validate(NamedQuery namedQuery, String jpqlQuery, String actualJpqlQuery, List<TextRange> textRanges, int offset, JpaJpqlQueryHelper.EscapeType escapeType, List<IMessage> messages) Validates the given NamedQuery by validating the JPQL query.

Methods inherited from class java.lang.Object

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

Constructor Detail

JpaJpqlQueryHelper

protected JpaJpqlQueryHelper(JPQLGrammar jpqlGrammar)

Creates a new JpaQueryHelper.

Parameters:

jpqlGrammar - The grammar that defines how to parse a JPQL query

Method Detail

buildContentAssistProposals

public ContentAssistProposals buildContentAssistProposals(int position)

buildContentAssistProposalsHelper

protected ContentAssistExtension buildContentAssistProposalsHelper()

Creates the helper that will be used to extend the support for JPQL content assist.

Returns:

A new instance of GenericContentAssistProposalHelper

buildManagedTypeBuilder

protected abstract IManagedTypeBuilder buildManagedTypeBuilder()

Create the builder that will create the right implementation of jpa.jpql.spi.IManagedType IManagedType.

Returns:

A new IMappingBuilder

buildMappingBuilder

protected abstract  buildMappingBuilder()

Create the builder that will create the right implementation of jpa.jpql.spi.IMapping IMapping.

Returns:

A new IMappingBuilder

buildPositions

public int[] buildPositions(JPQLQueryProblem problem,
                            String parsedJpqlQuery,
                            String jpqlQuery,
                            String actualJpqlQuery,
                            int offset,
                            JpaJpqlQueryHelper.EscapeType escapeType)

Calculates the start and end positions by adjusting them to be at the same position within jpqlQuery, which may differ from parsedJpqlQuery since the parsed tree does not keep track of multiple whitespace. The range is also increased if the start and end positions are the same.

Parameters:

problem - The problem that was found in the JPQL query, which is either a grammatical or semantic problem

parsedJpqlQuery - The generated string from parser.JPQLExpression JPQLExpression

jpqlQuery - The actual JPQL query that was parsed and validated

actualJpqlQuery - The actual string that is not escaped and found in the document (either in an XML file or in a Java annotation)

offset - This offset is used to move the start position

escapeType - Determines how to escape the JPQL query, if required

Returns:

The start and end positions, which may have been adjusted

buildProblems

protected List<IMessage> buildProblems(NamedQuery namedQuery,
                                       List<TextRange> textRanges,
                                       JPQLQueryProblem problem,
                                       String parsedJpqlQuery,
                                       String jpqlQuery,
                                       String actualJpqlQuery,
                                       int offset,
                                       JpaJpqlQueryHelper.EscapeType escapeType)

Creates a new IMessage for the given JPQLQueryProblem.

Parameters:

namedQuery - The model object for which a new IMessage is creating describing the problem

problem - The problem that was found in the JPQL query, which is either a grammatical or semantic problem

textRanges - The list of TextRange objects that represents the JPQL query string within the document. The list should contain either one TextRange if the JPQL query is a single string or many if the JPQL query is split into multiple strings

parsedJpqlQuery - The generated string from parser.JPQLExpression JPQLExpression

jpqlQuery - The actual JPQL query that was parsed and validated

actualJpqlQuery - The actual string that is not escaped and found in the document (either in an XML file or in a Java annotation)

offset - This offset is used to move the start position

escapeType - Determines how to escape the JPQL query, if required

Returns:

The list IMessage objects that has the required information to display the problem, which support split locations (i.e. for a split strings)

buildProvider

protected JpaManagedTypeProvider buildProvider(JpaProject jpaProject,
                                               PersistenceUnit persistenceUnit)

Creates a new JpaManagedTypeProvider which will provide access to the application's JPA metadata information.

Parameters:

jpaProject - The JPA project associated with the Eclipse project

persistenceUnit - The persistence unit model

Returns:

A new JpaManagedTypeProvider

getValidationPreference

protected String getValidationPreference(NamedQuery namedQuery)

setQuery

public void setQuery(NamedQuery namedQuery,
                     String actualQuery)

Sets the given named query and string representation of the JPQL query.

Parameters:

namedQuery - The model object where the JPQL query is stored

actualQuery - The actual JPQL query, which can differ from the one owned by the model object, which happens when the model is out of sync because it has not been updated yet

shouldValidate

protected boolean shouldValidate(NamedQuery namedQuery)

validate

public void validate(NamedQuery namedQuery,
                     String jpqlQuery,
                     String actualJpqlQuery,
                     List<TextRange> textRanges,
                     int offset,
                     JpaJpqlQueryHelper.EscapeType escapeType,
                     List<IMessage> messages)

Validates the given NamedQuery by validating the JPQL query.

Parameters:

namedQuery - The JPQL query to validate

jpqlQuery - The JPQL query, which might be different from what the model object since the escape characters should not be in their literal forms (should have '\r' and not '\\r')

textRanges - The list of TextRange objects that represents the JPQL query string within the document. The list should contain either one TextRange if the JPQL query is a single string or many if the JPQL query is split into multiple strings

offset - This offset is used to move the start position

messages - The list of IMessages that will be used to add validation problems

escapeCharacters - Determines whether the special characters (\n, \r for instance) should be escaped or not