Package org.eclipse.persistence.jpa.jpql.tools
package org.eclipse.persistence.jpa.jpql.tools
-
ClassDescriptionThe visitor provides support for finding the possible proposals within a JPQL query at a certain position.This helper handles adding proposals within a conditional expression that might be parsed as a single expression or has a collection of expression, which means the fragment is either incomplete or invalid.AbstractContentAssistVisitor.AbstractGroupByClauseStatementHelper<T extends AbstractSelectStatement>AbstractContentAssistVisitor.AbstractWhereClauseSelectStatementHelper<T extends AbstractSelectStatement>This visitor retrieves the permitted type from the path expression's parent.This visitor scans the visited
Expression
and determines if a JPQL identifier can be added ("appended") when the position of the cursor is at the end of the expression.This is used to determine howAbstractContentAssistVisitor.AppendableExpressionVisitor
should perform the check.This helper is used to determine how to add proposals within a collection of expressions.This visitor retrieves theCollectionExpression
if it is visited.This helpers handles adding proposals forAbstractConditionalClause
.The default implementation ofAbstractContentAssistVisitor.MappingCollector
, which simply returns an empty collection.This builder populates aQueryPosition
by traversing the valid portion of the JPQL query.This visitor determines whether a path expression can be resolved as a fully qualified enum type and an enum constant.ThisAbstractContentAssistVisitor.MappingCollector
returns the possible mappings (non-collection type or collection type) from a managed type.The various ways of retrieving identification variables from the declaration expression.This visitor is used when a clause or a compound expression was parsed with a collection of expressions representing an invalid fragment.This visitor determines if the visitedExpression
is one of the two that represents an invalid expression.A collector is responsible to retrieve the possible proposals by using the mappings that can complete a path expression.This visitor is responsible to create the rightFilter
based on the type of theExpression
.ThisFilter
is responsible to filter out the mappings that can't have their type assignable to the one passed in.This helper helps to add JPQL identifiers for the clauses that make up a query statement and also chains the clauses within the query.This visitor determines if anExpression
is in a subquery.This visitor is meant to adjust the corrections stack when traversing anExpression
in order to increase the list of valid proposals.This helpers handles adding proposals forWhenClause
.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.The abstract definition of a refactoringThe abstract implementation providing refactoring support for JPQL queries.A simple implementation ofIQuery
.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.This object stores the various proposals available for content assist for a certain position within a JPQL query.This enumeration determines the type of classes returned byContentAssistProposals.classNames()
.Holds onto theIType
of the enum type and the list of possible enum constants.This utility class provides basic refactoring support.The default implementation ofContentAssistProposals
which stores the valid proposals.This visitor traverses the JPQL parsed tree and gathers the possible proposals at a given position.This validator is responsible to validate a JPQL query grammatically purely based on the JPA specification document.This context is used to store information related to the JPQL query.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.This visitor traverses anExpression
and retrieves the "literal" value.This visitor calculates the type of an input parameter.The default implementation ofRefactoringDelta
which contains theTextEdit
that were creating during the refactoring of a JPQL query.This utility class provides basic refactoring support.This validator is responsible to gather the problems found in a JPQL query by validating the content to make sure it is semantically valid.The default implementation of aTextEdit
, which contains the location of the change within the JPQL query (offset) and the old and new values.This utility class provides basic refactoring support.This extension over the default content assist visitor adds the additional support EclipseLink provides.This visitor adds support for the additional clauses provided by EclipseLink, such as theThis context is used to store information related to the JPQL query.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.This visitor calculates the type of an input parameter.This refactoring tool add support for EclipseLink specific extension over the default implementation of JPQL defined in the Java Persistence functional specification.An implementation of aResolverBuilder
that adds support for EclipseLink extension.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.An implementation ofSemanticValidatorHelper
that usesJPQLQueryContext
to return the required information and Hermes SPI.This generic implementation ofITypeHelper
wrapsITypeHelper
and delegates the calls to it.This context is used to store information related to the JPQL query.This visitor is responsible to retrieve theExpression
that is the beginning of a query.ThisComparator
is used to sortITypes
based on the numerical priority.A refactoring delta contains an ordered collection ofTextEdit
.The abstract implementation providing refactoring support for JPQL queries.This visitor renames a fully qualified class name.This visitor renames an entity name.This visitor renames an enum constant.This visitor renames any segment of a path expression.This visitor renames all the result variables found in the JPQL query.RefactoringTool.StateObjectUpdater<T extends StateObject>This interface is used to transparently push the new value into theStateObject
.This visitor renames all the identification variables found in the JPQL query.This is used to retrieve the new JPQL query when a content assist item needs to be insert at a certain position.ATextEdit
contains the information of a change that can be made to the JPQL query after performing a refactoring operation.This helper contains methods related toIType
and can perform equivalency checks.