org.eclipse.persistence.jpa.jpql.tools
Class EclipseLinkContentAssistVisitor
java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor
org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor
org.eclipse.persistence.jpa.jpql.tools.EclipseLinkContentAssistVisitor
- All Implemented Interfaces:
- EclipseLinkExpressionVisitor, ExpressionVisitor
public class EclipseLinkContentAssistVisitor
- extends AbstractContentAssistVisitor
- implements EclipseLinkExpressionVisitor
This extension over the default content assist visitor adds the additional support EclipseLink
provides.
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.
- Version:
- 2.5
- Author:
- Pascal Filion
- Since:
- 2.4
Nested classes/interfaces inherited from class org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor |
AbstractContentAssistVisitor.AbstractAppendableExpressionVisitor, AbstractContentAssistVisitor.AbstractConditionalClauseCollectionHelper, 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.AppendableType, AbstractContentAssistVisitor.CollectionExpressionHelper<T extends Expression>, AbstractContentAssistVisitor.CollectionExpressionVisitor, AbstractContentAssistVisitor.CollectionMappingFilter, AbstractContentAssistVisitor.CompletenessVisitor, AbstractContentAssistVisitor.CompoundExpressionHelper, AbstractContentAssistVisitor.CompoundTypeFilter, AbstractContentAssistVisitor.ConcatExpressionCollectionHelper, AbstractContentAssistVisitor.ConstrutorCollectionHelper, AbstractContentAssistVisitor.DeclarationVisitor, AbstractContentAssistVisitor.DefaultMappingCollector, AbstractContentAssistVisitor.DeleteClauseCollectionHelper, AbstractContentAssistVisitor.DeleteClauseStatementHelper, AbstractContentAssistVisitor.DoubleEncapsulatedCollectionHelper, AbstractContentAssistVisitor.EncapsulatedExpressionVisitor, AbstractContentAssistVisitor.EnumVisitor, AbstractContentAssistVisitor.FilteringMappingCollector, AbstractContentAssistVisitor.FollowingInvalidExpressionVisitor, AbstractContentAssistVisitor.GroupByClauseCollectionHelper, AbstractContentAssistVisitor.GroupByClauseStatementHelper, AbstractContentAssistVisitor.HavingClauseStatementHelper, AbstractContentAssistVisitor.IdentificationVariableType, AbstractContentAssistVisitor.InvalidExpressionVisitor, AbstractContentAssistVisitor.JoinCollectionHelper, AbstractContentAssistVisitor.MappingCollector, AbstractContentAssistVisitor.MappingFilterBuilder, AbstractContentAssistVisitor.MappingTypeFilter, AbstractContentAssistVisitor.NotExpressionVisitor, AbstractContentAssistVisitor.OrderByClauseCollectionHelper, AbstractContentAssistVisitor.PropertyMappingFilter, AbstractContentAssistVisitor.RangeVariableDeclarationVisitor, AbstractContentAssistVisitor.ResultVariableVisitor, AbstractContentAssistVisitor.SelectClauseCollectionHelper, AbstractContentAssistVisitor.SelectClauseStatementHelper, AbstractContentAssistVisitor.SimpleGroupByClauseStatementHelper, AbstractContentAssistVisitor.SimpleHavingClauseStatementHelper, AbstractContentAssistVisitor.SimpleSelectClauseCollectionHelper, AbstractContentAssistVisitor.SimpleSelectClauseStatementHelper, AbstractContentAssistVisitor.SimpleWhereClauseSelectStatementHelper, AbstractContentAssistVisitor.StatementHelper<T extends Expression>, AbstractContentAssistVisitor.SubqueryAppendableExpressionVisitor, AbstractContentAssistVisitor.SubqueryVisitor, AbstractContentAssistVisitor.TripleEncapsulatedCollectionHelper, AbstractContentAssistVisitor.UpdateClauseStatementHelper, AbstractContentAssistVisitor.UpdateItemCollectionHelper, AbstractContentAssistVisitor.VisitParentVisitor, AbstractContentAssistVisitor.WhereClauseDeleteStatementHelper, AbstractContentAssistVisitor.WhereClauseSelectStatementHelper, AbstractContentAssistVisitor.WhereClauseUpdateStatementHelper, AbstractContentAssistVisitor.WithinInvalidExpressionVisitor |
Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor |
compoundTypeFilters, corrections, helpers, lockedExpressions, proposals, queryContext, queryPosition, SPACE_LENGTH, virtualSpaces, word, wordParser |
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor |
addAggregateIdentifier, addAggregateIdentifiers, addAggregateIdentifiers, addArithmeticIdentifiers, addClauseIdentifier, addClauseIdentifiers, addClauseIdentifiers, addComparisonIdentifiers, addCompositeIdentifier, addCompoundIdentifier, addCompoundIdentifiers, addCompoundIdentifiers, addEntities, addEntities, addEnumConstant, addEnumConstants, addExpressionFactoryIdentifiers, addExpressionFactoryIdentifiers, addFunctionIdentifier, addFunctionIdentifiers, addFunctionIdentifiers, addFunctionIdentifiers, addIdentificationVariable, addIdentificationVariables, addIdentificationVariables, addIdentifier, addJoinIdentifiers, addLeftIdentificationVariables, addLogicalIdentifiers, addRangeIdentificationVariable, addResultVariables, addVirtualSpace, areArithmeticSymbolsAppendable, areComparisonSymbolsAppendable, areLogicalSymbolsAppendable, buildAbstractConditionalClauseCollectionHelper, buildCollectionExpressionVisitor, buildCollectionMappingFilter, buildCompoundExpressionHelper, buildConcatExpressionCollectionHelper, buildConstrutorCollectionHelper, buildDeclarationVisitor, buildDefaultMappingCollector, buildDeleteClauseCollectionHelper, buildDeleteClauseStatementHelper, buildDoubleEncapsulatedCollectionHelper, buildEmptyCompoundTypeFilter, buildEncapsulatedExpressionVisitor, buildEndingPositionFromInvalidExpression, buildEnumVisitor, buildFilteringMappingCollector, buildFollowingInvalidExpressionVisitor, buildGroupByClauseStatementHelper, buildHavingClauseStatementHelper, buildInvalidExpressionVisitor, buildJoinCollectionHelper, buildJPQLQueryBNFValidator, buildMappingCollector, buildMappingFilter, buildMappingFilter, buildMappingFilterBuilder, buildNotExpressionVisitor, buildOrderByClauseCollectionHelper, buildPropertyMappingFilter, buildProposals, buildProposals, buildRangeVariableDeclarationVisitor, buildResultVariableVisitor, buildSelectClauseCollectionHelper, buildSelectClauseStatementHelper, buildSimpleGroupByClauseStatementHelper, buildSimpleHavingClauseStatementHelper, buildSimpleSelectClauseCollectionHelper, buildSimpleSelectClauseStatementHelper, buildSimpleWhereClauseSelectStatementHelper, buildSubqueryAppendableExpressionVisitor, buildSubqueryVisitor, buildTripleEncapsulatedCollectionHelper, buildUpdateClauseStatementHelper, buildUpdateItemCollectionHelper, buildVisitParentVisitor, buildWhereClauseDeleteStatementHelper, buildWhereClauseSelectStatementHelper, buildWhereClauseUpdateStatementHelper, buildWithinInvalidExpressionVisitor, dispose, findRangeVariableDeclaration, getAbstractConditionalClauseCollectionHelper, getAcceptableType, getAppendableExpressionVisitor, getCollectionExpression, getCollectionExpressionVisitor, getCompoundExpressionHelper, getConcatExpressionCollectionHelper, getConstructorCollectionHelper, getCoumpoundTypeFilter, getDeclarationVisitor, getDefaultMappingCollector, getDeleteClauseCollectionHelper, getDeleteClauseStatementHelper, getDoubleEncapsulatedCollectionHelper, getEncapsulatedExpressionVisitor, getEndingQueryPositionBuilder, getEnumVisitor, getExpressionTypeVisitor, getFollowingClausesVisitor, getFollowingInvalidExpressionVisitor, getFromClauseCollectionHelper, getFromClauseStatementHelper, getGroupByClauseCollectionHelper, getGroupByClauseStatementHelper, getHavingClauseStatementHelper, getHelper, getIdentifierRole, getIncompleteCollectionExpressionVisitor, getInvalidExpressionVisitor, getJoinCollectionHelper, getMappingCollectionFilter, getMappingFilterBuilder, getMappingPropertyFilter, getNotExpressionVisitor, getOrderByClauseCollectionHelper, getOrderByClauseStatementHelper, getQueryBNF, getRangeVariableDeclarationVisitor, getResultVariableVisitor, getSelectClauseCollectionHelper, getSelectClauseStatementHelper, getSimpleFromClauseStatementHelper, getSimpleGroupByClauseStatementHelper, getSimpleHavingClauseStatementHelper, getSimpleSelectClauseCollectionHelper, getSimpleSelectClauseStatementHelper, getSimpleWhereClauseSelectStatementHelper, getSubqueryAppendableExpressionVisitor, getSubqueryVisitor, getTrailingCompletenessVisitor, getTripleEncapsulatedCollectionHelper, getUpdateClauseStatementHelper, getUpdateItemCollectionHelper, getVisitParentVisitor, getWhereClauseDeleteStatementHelper, getWhereClauseSelectStatementHelper, getWhereClauseUpdateStatementHelper, getWithinInvalidExpressionVisitor, hasClausesDefinedBetween, hasVirtualSpace, isAggregate, isAppendable, isAppendableToCollection, isClause, isClauseAppendable, isComplete, isCompoundable, isCompoundFunction, isDeclaration, isEncapsulated, isEnumAllowed, isFollowingInvalidExpression, isFunction, isInSubquery, isInvalidExpression, isLocked, isNotExpression, isPositionWithin, isPositionWithin, isSubqueryAppendable, isValid, isValid, isValid, isValid, isValid, isValidProposal, isValidVersion, isWithinInvalidExpression, registerHelper, removeVirtualSpace, 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, visitAggregateFunction, visitArithmeticExpression, visitCollectionExpression, visitEndingExpression, visitEnumConstant, visitInvalidExpression, visitLogicalExpression, visitPathExpression, visitPathExpression, visitSingleEncapsulatedExpression, visitSingleEncapsulatedExpression, visitStatement |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor |
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 |
EclipseLinkContentAssistVisitor
public EclipseLinkContentAssistVisitor(JPQLQueryContext queryContext)
- Creates a new
EclipseLinkContentAssistVisitor
.
- Parameters:
queryContext
- The context used to query information about the query
- Throws:
java.lang.NullPointerException
- The JPQLQueryContext
cannot be null
buildAcceptableTypeVisitor
protected EclipseLinkContentAssistVisitor.AcceptableTypeVisitor buildAcceptableTypeVisitor()
-
- Specified by:
buildAcceptableTypeVisitor
in class AbstractContentAssistVisitor
buildAppendableExpressionVisitor
protected EclipseLinkContentAssistVisitor.AppendableExpressionVisitor buildAppendableExpressionVisitor()
-
- Overrides:
buildAppendableExpressionVisitor
in class AbstractContentAssistVisitor
buildEndingQueryPositionBuilder
protected EclipseLinkContentAssistVisitor.EndingQueryPositionBuilder buildEndingQueryPositionBuilder()
-
- Overrides:
buildEndingQueryPositionBuilder
in class AbstractContentAssistVisitor
buildFollowingClausesVisitor
protected EclipseLinkContentAssistVisitor.FollowingClausesVisitor buildFollowingClausesVisitor()
-
- Overrides:
buildFollowingClausesVisitor
in class AbstractContentAssistVisitor
buildFromClauseCollectionHelper
protected EclipseLinkContentAssistVisitor.FromClauseCollectionHelper buildFromClauseCollectionHelper()
-
- Overrides:
buildFromClauseCollectionHelper
in class AbstractContentAssistVisitor
buildFromClauseStatementHelper
protected EclipseLinkContentAssistVisitor.FromClauseStatementHelper buildFromClauseStatementHelper()
-
- Overrides:
buildFromClauseStatementHelper
in class AbstractContentAssistVisitor
buildGroupByClauseCollectionHelper
protected AbstractContentAssistVisitor.GroupByClauseCollectionHelper buildGroupByClauseCollectionHelper()
-
- Overrides:
buildGroupByClauseCollectionHelper
in class AbstractContentAssistVisitor
buildIncompleteCollectionExpressionVisitor
protected EclipseLinkContentAssistVisitor.IncompleteCollectionExpressionVisitor buildIncompleteCollectionExpressionVisitor()
-
- Overrides:
buildIncompleteCollectionExpressionVisitor
in class AbstractContentAssistVisitor
buildOrderByClauseStatementHelper
protected EclipseLinkContentAssistVisitor.OrderByClauseStatementHelper buildOrderByClauseStatementHelper()
-
- Overrides:
buildOrderByClauseStatementHelper
in class AbstractContentAssistVisitor
buildSimpleFromClauseStatementHelper
protected EclipseLinkContentAssistVisitor.SimpleFromClauseStatementHelper buildSimpleFromClauseStatementHelper()
-
- Overrides:
buildSimpleFromClauseStatementHelper
in class AbstractContentAssistVisitor
buildTableExpressionVisitor
protected EclipseLinkContentAssistVisitor.TableExpressionVisitor buildTableExpressionVisitor()
buildTrailingCompletenessVisitor
protected EclipseLinkContentAssistVisitor.TrailingCompletenessVisitor buildTrailingCompletenessVisitor()
-
- Overrides:
buildTrailingCompletenessVisitor
in class AbstractContentAssistVisitor
buildUnionClauseStatementHelper
protected EclipseLinkContentAssistVisitor.UnionClauseStatementHelper buildUnionClauseStatementHelper()
getEcliseLinkVersion
protected EclipseLinkVersion getEcliseLinkVersion()
- Returns the enum constant of the EclipseLink version specified in the
JPQLQueryContext
.
- Returns:
- The EclipseLink version specified or the default version (i.e. the version of the
current release)
- Since:
- 2.5
getTableExpressionVisitor
protected EclipseLinkContentAssistVisitor.TableExpressionVisitor getTableExpressionVisitor()
getTableName
protected java.lang.String getTableName(java.lang.String variableName)
getUnionClauseStatementHelper
protected EclipseLinkContentAssistVisitor.UnionClauseStatementHelper getUnionClauseStatementHelper()
initialize
protected void initialize()
- Initializes this visitor.
- Overrides:
initialize
in class AbstractContentAssistVisitor
isJoinFetchIdentifiable
protected boolean isJoinFetchIdentifiable()
- Determines whether a
JOIN FETCH
expression can be identified by with an
identification variable or not.
- Specified by:
isJoinFetchIdentifiable
in class AbstractContentAssistVisitor
- Returns:
true
if the expression can have an identification variable;
false
otherwise
isTableExpression
protected boolean isTableExpression(Expression expression)
visit
public void visit(AsOfClause expression)
- Visits the
AsOfClause
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The Expression
to visit
visit
public void visit(CastExpression expression)
- Visits the
CastExpression
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The Expression
to visit
visit
public void visit(ConnectByClause expression)
- Visits the
ConnectByClause
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The ConnectByClause
to visit
visit
public void visit(DatabaseType expression)
- Visits the
DatabaseType
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The DatabaseType
to visit
visit
public void visit(ExtractExpression expression)
- Visits the
ExtractExpression
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The Expression
to visit
visit
public void visit(HierarchicalQueryClause expression)
- Visits the
HierarchicalQueryClause
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The HierarchicalQueryClause
to visit
visit
public void visit(OrderByItem expression)
- Visits the
OrderByItem
expression.
- Specified by:
visit
in interface ExpressionVisitor
- Overrides:
visit
in class AbstractContentAssistVisitor
- Parameters:
expression
- The Expression
to visit
visit
public void visit(OrderSiblingsByClause expression)
- Visits the
OrderSiblingsByClause
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The Expression
to visit
visit
public void visit(RegexpExpression expression)
- Visits the
RegexpExpression
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The Expression
to visit
visit
public void visit(StartWithClause expression)
- Visits the
StartWithClause
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The StartWithClause
to visit
visit
public void visit(TableExpression expression)
- Visits the
TableExpression
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The Expression
to visit
visit
public void visit(TableVariableDeclaration expression)
- Visits the
TableVariableDeclaration
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The Expression
to visit
visit
public void visit(UnionClause expression)
- Visits the
UnionClause
expression.
- Specified by:
visit
in interface EclipseLinkExpressionVisitor
- Parameters:
expression
- The Expression
to visit
visitThirdPartyPathExpression
protected void visitThirdPartyPathExpression(AbstractPathExpression expression,
java.lang.String variableName)
- Visits the given
AbstractPathExpression
and attempts to find valid proposals that is
not provided by the default implementation. Subclasses can add additional proposals that is
outside of the scope of generic JPA metadata.
- Overrides:
visitThirdPartyPathExpression
in class AbstractContentAssistVisitor
- Parameters:
expression
- The AbstractPathExpression
to inspectvariableName
- The beginning of the path expression