Package org.eclipse.persistence.jpa.jpql.tools

Interface Summary

Interface	Description
AbstractContentAssistVisitor.CollectionExpressionHelper<T extends Expression>	This helper is used to determine how to add proposals within a collection of expressions.
AbstractContentAssistVisitor.MappingCollector	A collector is responsible to retrieve the possible proposals by using the mappings that can complete a path expression.
AbstractContentAssistVisitor.StatementHelper<T extends Expression>	This helper helps to add JPQL identifiers for the clauses that make up a query statement and also chains the clauses within the query.
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 the IType of the enum type and the list of possible enum constants.
RefactoringDelta	A refactoring delta contains an ordered collection of TextEdit.
RefactoringTool.StateObjectUpdater<T extends StateObject>	This interface is used to transparently push the new value into the StateObject.
ResultQuery	This is used to retrieve the new JPQL query when a content assist item needs to be insert at a certain position.
TextEdit	A TextEdit 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.
AbstractContentAssistVisitor.AbstractAppendableExpressionVisitor
AbstractContentAssistVisitor.AbstractConditionalClauseCollectionHelper<T extends Expression>	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.AbstractFromClauseStatementHelper<T extends AbstractSelectStatement>
AbstractContentAssistVisitor.AbstractGroupByClauseStatementHelper<T extends AbstractSelectStatement>
AbstractContentAssistVisitor.AbstractHavingClauseStatementHelper<T extends AbstractSelectStatement>
AbstractContentAssistVisitor.AbstractSelectClauseCollectionHelper<T extends AbstractSelectClause>
AbstractContentAssistVisitor.AbstractSelectClauseStatementHelper
AbstractContentAssistVisitor.AbstractWhereClauseSelectStatementHelper<T extends AbstractSelectStatement>
AbstractContentAssistVisitor.AcceptableTypeVisitor	This visitor retrieves the permitted type from the path expression's parent.
AbstractContentAssistVisitor.AppendableExpressionVisitor	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.
AbstractContentAssistVisitor.CollectionExpressionVisitor	This visitor retrieves the CollectionExpression if it is visited.
AbstractContentAssistVisitor.CollectionMappingFilter
AbstractContentAssistVisitor.ConcatExpressionCollectionHelper
AbstractContentAssistVisitor.ConditionalClauseCollectionHelper	This helpers handles adding proposals for AbstractConditionalClause.
AbstractContentAssistVisitor.ConstrutorCollectionHelper
AbstractContentAssistVisitor.DeclarationVisitor
AbstractContentAssistVisitor.DefaultMappingCollector	The default implementation of AbstractContentAssistVisitor.MappingCollector, which simply returns an empty collection.
AbstractContentAssistVisitor.DeleteClauseCollectionHelper
AbstractContentAssistVisitor.DeleteClauseStatementHelper
AbstractContentAssistVisitor.DifferentComparisonFilter
AbstractContentAssistVisitor.DoubleEncapsulatedCollectionHelper
AbstractContentAssistVisitor.EncapsulatedExpressionVisitor
AbstractContentAssistVisitor.EndingQueryPositionBuilder	This builder populates a QueryPosition by traversing the valid portion of the JPQL query.
AbstractContentAssistVisitor.EnumVisitor	This visitor determines whether a path expression can be resolved as a fully qualified enum type and an enum constant.
AbstractContentAssistVisitor.FilteringMappingCollector	This AbstractContentAssistVisitor.MappingCollector returns the possible mappings (non-collection type or collection type) from a managed type.
AbstractContentAssistVisitor.FollowingClausesVisitor
AbstractContentAssistVisitor.FollowingInvalidExpressionVisitor
AbstractContentAssistVisitor.FromClauseCollectionHelper
AbstractContentAssistVisitor.FromClauseStatementHelper
AbstractContentAssistVisitor.GroupByClauseCollectionHelper
AbstractContentAssistVisitor.GroupByClauseStatementHelper
AbstractContentAssistVisitor.HavingClauseStatementHelper
AbstractContentAssistVisitor.IncompleteCollectionExpressionVisitor	This visitor is used when a clause or a compound expression was parsed with a collection of expressions representing an invalid fragment.
AbstractContentAssistVisitor.InvalidExpressionVisitor	This visitor determines if the visited Expression is one of the two that represents an invalid expression.
AbstractContentAssistVisitor.JoinCollectionHelper
AbstractContentAssistVisitor.MappingFilterBuilder	This visitor is responsible to create the right Filter based on the type of the Expression.
AbstractContentAssistVisitor.MappingTypeFilter	This Filter is responsible to filter out the mappings that can't have their type assignable to the one passed in.
AbstractContentAssistVisitor.NotExpressionVisitor
AbstractContentAssistVisitor.OrderByClauseCollectionHelper
AbstractContentAssistVisitor.OrderByClauseStatementHelper
AbstractContentAssistVisitor.PropertyMappingFilter
AbstractContentAssistVisitor.RangeVariableDeclarationVisitor
AbstractContentAssistVisitor.ResultVariableVisitor
AbstractContentAssistVisitor.SelectClauseCollectionHelper
AbstractContentAssistVisitor.SelectClauseStatementHelper
AbstractContentAssistVisitor.SimpleFromClauseStatementHelper
AbstractContentAssistVisitor.SimpleGroupByClauseStatementHelper
AbstractContentAssistVisitor.SimpleHavingClauseStatementHelper
AbstractContentAssistVisitor.SimpleSelectClauseCollectionHelper
AbstractContentAssistVisitor.SimpleSelectClauseStatementHelper
AbstractContentAssistVisitor.SimpleWhereClauseSelectStatementHelper
AbstractContentAssistVisitor.SubqueryAppendableExpressionVisitor
AbstractContentAssistVisitor.SubqueryVisitor	This visitor determines if an Expression is in a subquery.
AbstractContentAssistVisitor.TripleEncapsulatedCollectionHelper
AbstractContentAssistVisitor.UpdateClauseStatementHelper
AbstractContentAssistVisitor.UpdateItemCollectionHelper
AbstractContentAssistVisitor.VisitParentVisitor	This visitor is meant to adjust the corrections stack when traversing an Expression in order to increase the list of valid proposals.
AbstractContentAssistVisitor.WhenClauseConditionalClauseCollectionHelper	This helpers handles adding proposals for WhenClause.
AbstractContentAssistVisitor.WhereClauseDeleteStatementHelper
AbstractContentAssistVisitor.WhereClauseSelectStatementHelper
AbstractContentAssistVisitor.WhereClauseUpdateStatementHelper
AbstractContentAssistVisitor.WithinInvalidExpressionVisitor
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 of TextEdit objects. AbstractJPQLQueryHelper.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.
AbstractRefactoringTool	The abstract definition of a refactoring
BasicRefactoringTool	The abstract implementation providing refactoring support for JPQL queries.
BasicRefactoringTool.JavaQuery	A simple implementation of IQuery.
DefaultBasicRefactoringTool	This utility class provides basic refactoring support.
DefaultContentAssistProposals	The default implementation of ContentAssistProposals 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 of TextEdit objects. DefaultJPQLQueryHelper.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 1.0 or 2.x.
DefaultLiteralVisitor	This visitor traverses an Expression and retrieves the "literal" value.
DefaultParameterTypeVisitor	This visitor calculates the type of an input parameter.
DefaultRefactoringDelta	The default implementation of RefactoringDelta which contains the TextEdit 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.
DefaultSemanticValidator.NullValueVisitor
DefaultSemanticValidator.ResultVariableInOrderByVisitor
DefaultSemanticValidator.UpdateClauseAbstractSchemaNameFinder
DefaultTextEdit	The default implementation of a TextEdit, 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.
EclipseLinkContentAssistVisitor.AcceptableTypeVisitor
EclipseLinkContentAssistVisitor.AppendableExpressionVisitor
EclipseLinkContentAssistVisitor.EndingQueryPositionBuilder
EclipseLinkContentAssistVisitor.FollowingClausesVisitor	This visitor adds support for the additional clauses provided by EclipseLink, such as the
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 of TextEdit objects. EclipseLinkJPQLQueryHelper.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.
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 a ResolverBuilder 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 of SemanticValidatorHelper that uses JPQLQueryContext to return the required information and Hermes SPI.
GenericSemanticValidatorHelper.IdentificationVariableVisitor
GenericTypeHelper	This generic implementation of ITypeHelper wraps ITypeHelper and delegates the calls to it.
JPQLQueryContext	This context is used to store information related to the JPQL query.
JPQLQueryContext.QueryExpressionVisitor	This visitor is responsible to retrieve the Expression that is the beginning of a query.
NumericTypeComparator	This Comparator is used to sort ITypes based on the numerical priority.
RefactoringTool	The abstract implementation providing refactoring support for JPQL queries.
RefactoringTool.ClassNameRenamer	This visitor renames a fully qualified class name.
RefactoringTool.EntityNameRenamer	This visitor renames an entity name.
RefactoringTool.EnumConstantRenamer	This visitor renames an enum constant.
RefactoringTool.FieldNameRenamer	This visitor renames any segment of a path expression.
RefactoringTool.ResultVariableNameRenamer	This visitor renames all the result variables found in the JPQL query.
RefactoringTool.VariableNameRenamer	This visitor renames all the identification variables found in the JPQL query.
TypeHelper	This helper contains methods related to IType and can perform equivalency checks.

Enum Summary

Enum	Description
AbstractContentAssistVisitor.AppendableType	This is used to determine how AbstractContentAssistVisitor.AppendableExpressionVisitor should perform the check.
AbstractContentAssistVisitor.IdentificationVariableType	The various ways of retrieving identification variables from the declaration expression.
ContentAssistProposals.ClassType	This enumeration determines the type of classes returned by ContentAssistProposals.classNames().