Package org.eclipse.persistence.jpa.jpql.tools
-
Interface Summary Interface Description ContentAssistExtension This extension can be used to provide additional support to JPQL content assist that is outside the scope of providing proposals related to JPA metadata.ContentAssistProposals This object stores the various proposals available for content assist for a certain position within a JPQL query.ContentAssistProposals.EnumProposals Holds onto theIType
of the enum type and the list of possible enum constants.RefactoringDelta A refactoring delta contains an ordered collection ofTextEdit
.ResultQuery This is used to retrieve the new JPQL query when a content assist item needs to be insert at a certain position.TextEdit ATextEdit
contains the information of a change that can be made to the JPQL query after performing a refactoring operation. -
Class Summary Class Description AbstractContentAssistVisitor The visitor provides support for finding the possible proposals within a JPQL query at a certain position.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:AbstractJPQLQueryHelper.buildBasicRefactoringTool()
provides support for generating the delta of the refactoring operation through a collection ofTextEdit
objects.AbstractJPQLQueryHelper.buildRefactoringTool()
provides support for refactoring the JPQL query through the editableStateObject
and once all refactoring operations have been executed, theIJPQLQueryFormatter
will generate a new string representation of the JPQL query.AbstractRefactoringTool The abstract definition of a refactoringBasicRefactoringTool The abstract implementation providing refactoring support for JPQL queries.DefaultBasicRefactoringTool This utility class provides basic refactoring support.DefaultContentAssistProposals The default implementation ofContentAssistProposals
which stores the valid proposals.DefaultContentAssistVisitor This visitor traverses the JPQL parsed tree and gathers the possible proposals at a given position.DefaultGrammarValidator This validator is responsible to validate a JPQL query grammatically purely based on the JPA specification document.DefaultJPQLQueryContext This context is used to store information related to the JPQL query.DefaultJPQLQueryHelper 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:DefaultJPQLQueryHelper.buildBasicRefactoringTool()
provides support for generating the delta of the refactoring operation through a collection ofTextEdit
objects.DefaultJPQLQueryHelper.buildRefactoringTool()
provides support for refactoring the JPQL query through the editableStateObject
and once all refactoring operations have been executed, theIJPQLQueryFormatter
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 1.0 or 2.x.DefaultLiteralVisitor This visitor traverses anExpression
and retrieves the "literal" value.DefaultParameterTypeVisitor This visitor calculates the type of an input parameter.DefaultRefactoringDelta The default implementation ofRefactoringDelta
which contains theTextEdit
that were creating during the refactoring of a JPQL query.DefaultRefactoringTool This utility class provides basic refactoring support.DefaultSemanticValidator This validator is responsible to gather the problems found in a JPQL query by validating the content to make sure it is semantically valid.DefaultTextEdit The default implementation of aTextEdit
, which contains the location of the change within the JPQL query (offset) and the old and new values.EclipseLinkBasicRefactoringTool This utility class provides basic refactoring support.EclipseLinkContentAssistVisitor This extension over the default content assist visitor adds the additional support EclipseLink provides.EclipseLinkJPQLQueryContext This context is used to store information related to the JPQL query.EclipseLinkJPQLQueryHelper 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:EclipseLinkJPQLQueryHelper.buildBasicRefactoringTool()
provides support for generating the delta of the refactoring operation through a collection ofTextEdit
objects.EclipseLinkJPQLQueryHelper.buildRefactoringTool()
provides support for refactoring the JPQL query through the editableStateObject
and once all refactoring operations have been executed, theIJPQLQueryFormatter
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.EclipseLinkParameterTypeVisitor This visitor calculates the type of an input parameter.EclipseLinkRefactoringTool This refactoring tool add support for EclipseLink specific extension over the default implementation of JPQL defined in the Java Persistence functional specification.EclipseLinkResolverBuilder An implementation of aResolverBuilder
that adds support for EclipseLink extension.EclipseLinkSemanticValidator This validator is responsible to gather the problems found in a JPQL query by validating the content to make sure it is semantically valid for EclipseLink.GenericSemanticValidatorHelper An implementation ofSemanticValidatorHelper
that usesJPQLQueryContext
to return the required information and Hermes SPI.GenericTypeHelper This generic implementation ofITypeHelper
wrapsITypeHelper
and delegates the calls to it.JPQLQueryContext This context is used to store information related to the JPQL query.NumericTypeComparator ThisComparator
is used to sortITypes
based on the numerical priority.RefactoringTool The abstract implementation providing refactoring support for JPQL queries.TypeHelper This helper contains methods related toIType
and can perform equivalency checks. -
Enum Summary Enum Description ContentAssistProposals.ClassType This enumeration determines the type of classes returned byContentAssistProposals.classNames()
.