Class DefaultContentAssistVisitor
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor
-
- org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor
-
- org.eclipse.persistence.jpa.jpql.tools.DefaultContentAssistVisitor
-
- All Implemented Interfaces:
ExpressionVisitor
public class DefaultContentAssistVisitor extends AbstractContentAssistVisitor
This visitor traverses the JPQL parsed tree and gathers the possible proposals at a given position.Example:
// Have the external form of an IQuery
IQuery
query = ... // Create a JPQLQueryContextJPQLQueryContext
context = new JPQLQueryContext(); context.setQuery(query)
; // Create a map of the positions within the parsed treeQueryPosition
queryPosition = context.getJPQLExpression().buildPosition(query.getExpression(), position); // Either a real extension that adds additional support or ContentAssistExtension extension =ContentAssistExtension.NULL_HELPER
; // Create the visitor and visit the parsed tree DefaultContentAssistVisitor visitor = new DefaultContentAssistVisitor(context); visitor.buildProposals(queryPosition.getPosition(), extension)
; queryPosition.getExpression().accept(visitor); // Retrieve the proposalsContentAssistProposals
proposals = visitor.getProposals(); // Only required if the visitor is cached visitor.dispose(); // Only required if the context is cached context.dispose();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:
- 2.3
- Version:
- 2.5.1
- Author:
- Pascal Filion
-
-
Constructor Summary
Constructors Constructor Description DefaultContentAssistVisitor(JPQLQueryContext queryContext)
Creates a newDefaultContentAssistVisitor
.
-
Method Summary
-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor
buildProposals, buildProposals, dispose, toString, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit
-
-
-
-
Constructor Detail
-
DefaultContentAssistVisitor
public DefaultContentAssistVisitor(JPQLQueryContext queryContext)
Creates a newDefaultContentAssistVisitor
.- Parameters:
queryContext
- The context used to query information about the query- Throws:
java.lang.NullPointerException
- TheJPQLQueryContext
cannot benull
-
-