org.eclipse.persistence.jpa.jpql

Class EclipseLinkContentAssistVisitor

java.lang.Object

org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor

org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor

org.eclipse.persistence.jpa.jpql.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.4.2

Author:

Pascal Filion

Since:

2.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	EclipseLinkContentAssistVisitor.AcceptableTypeVisitor
protected class	EclipseLinkContentAssistVisitor.AppendableExpressionVisitor
protected class	EclipseLinkContentAssistVisitor.EndingQueryPositionBuilder
protected class	EclipseLinkContentAssistVisitor.OrderByClauseStatementHelper
protected class	EclipseLinkContentAssistVisitor.TableExpressionVisitor
protected class	EclipseLinkContentAssistVisitor.TrailingCompletenessVisitor
protected class	EclipseLinkContentAssistVisitor.UnionClauseStatementHelper

Nested classes/interfaces inherited from class org.eclipse.persistence.jpa.jpql.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.FollowingClausesVisitor, AbstractContentAssistVisitor.FollowingInvalidExpressionVisitor, AbstractContentAssistVisitor.FromClauseCollectionHelper, AbstractContentAssistVisitor.FromClauseStatementHelper, AbstractContentAssistVisitor.GroupByClauseCollectionHelper, AbstractContentAssistVisitor.GroupByClauseStatementHelper, AbstractContentAssistVisitor.HavingClauseStatementHelper, AbstractContentAssistVisitor.IdentificationVariableType, AbstractContentAssistVisitor.IncompleteCollectionExpressionVisitor, 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.SimpleFromClauseStatementHelper, 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

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor

compoundTypeFilters, corrections, helpers, lockedExpressions, proposals, queryContext, queryPosition, SPACE_LENGTH, virtualSpaces, word, wordParser

Constructor Summary

Constructors

Constructor and Description
EclipseLinkContentAssistVisitor(JPQLQueryContext queryContext) Creates a new EclipseLinkContentAssistVisitor.

Method Summary

Methods

Modifier and Type	Method and Description
protected EclipseLinkContentAssistVisitor.AcceptableTypeVisitor	buildAcceptableTypeVisitor()
protected EclipseLinkContentAssistVisitor.AppendableExpressionVisitor	buildAppendableExpressionVisitor()
protected EclipseLinkContentAssistVisitor.EndingQueryPositionBuilder	buildEndingQueryPositionBuilder()
protected AbstractContentAssistVisitor.GroupByClauseCollectionHelper	buildGroupByClauseCollectionHelper()
protected EclipseLinkContentAssistVisitor.OrderByClauseStatementHelper	buildOrderByClauseStatementHelper()
protected EclipseLinkContentAssistVisitor.TableExpressionVisitor	buildTableExpressionVisitor()
protected EclipseLinkContentAssistVisitor.TrailingCompletenessVisitor	buildTrailingCompletenessVisitor()
protected EclipseLinkContentAssistVisitor.UnionClauseStatementHelper	buildUnionClauseStatementHelper()
protected EclipseLinkContentAssistVisitor.TableExpressionVisitor	getTableExpressionVisitor()
protected EclipseLinkContentAssistVisitor.UnionClauseStatementHelper	getUnionClauseStatementHelper()
protected void	initialize() Initializes this visitor.
protected boolean	isJoinFetchIdentifiable() Determines whether a JOIN FETCH expression can be identified by with an identification variable or not.
protected boolean	isTableExpression(Expression expression)
void	visit(CastExpression expression) Visits the CastExpression expression.
void	visit(DatabaseType expression) Visits the DatabaseType expression.
void	visit(ExtractExpression expression) Visits the ExtractExpression expression.
void	visit(OrderByItem expression) Visits the OrderByItem expression.
void	visit(RegexpExpression expression)
void	visit(TableExpression expression) Visits the TableExpression expression.
void	visit(TableVariableDeclaration expression) Visits the TableVariableDeclaration expression.
void	visit(UnionClause expression) Visits the UnionClause expression.

Methods inherited from class org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor

addAggregateIdentifier, addAggregateIdentifiers, addAggregateIdentifiers, addArithmeticIdentifiers, addClauseIdentifier, addClauseIdentifiers, addClauseIdentifiers, addComparisonIdentifiers, addCompositeIdentifier, addCompoundIdentifier, addCompoundIdentifiers, addCompoundIdentifiers, addEntities, addEntities, 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, buildFollowingClausesVisitor, buildFollowingInvalidExpressionVisitor, buildFromClauseCollectionHelper, buildFromClauseStatementHelper, buildGroupByClauseStatementHelper, buildHavingClauseStatementHelper, buildIncompleteCollectionExpressionVisitor, buildInvalidExpressionVisitor, buildJoinCollectionHelper, buildJPQLQueryBNFValidator, buildMappingCollector, buildMappingFilter, buildMappingFilter, buildMappingFilterBuilder, buildNotExpressionVisitor, buildOrderByClauseCollectionHelper, buildPropertyMappingFilter, buildProposals, buildRangeVariableDeclarationVisitor, buildResultVariableVisitor, buildSelectClauseCollectionHelper, buildSelectClauseStatementHelper, buildSimpleFromClauseStatementHelper, 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, visitInvalidExpression, visitLogicalExpression, visitPathExpression, visitPathExpression, visitSingleEncapsulatedExpression, visitSingleEncapsulatedExpression, visitStatement, visitThirdPartyPathExpression

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

Constructor Detail

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

Method Detail

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

buildGroupByClauseCollectionHelper

protected AbstractContentAssistVisitor.GroupByClauseCollectionHelper buildGroupByClauseCollectionHelper()

Overrides:

buildGroupByClauseCollectionHelper in class AbstractContentAssistVisitor

buildOrderByClauseStatementHelper

protected EclipseLinkContentAssistVisitor.OrderByClauseStatementHelper buildOrderByClauseStatementHelper()

Overrides:

buildOrderByClauseStatementHelper in class AbstractContentAssistVisitor

buildTableExpressionVisitor

protected EclipseLinkContentAssistVisitor.TableExpressionVisitor buildTableExpressionVisitor()

buildTrailingCompletenessVisitor

protected EclipseLinkContentAssistVisitor.TrailingCompletenessVisitor buildTrailingCompletenessVisitor()

Overrides:

buildTrailingCompletenessVisitor in class AbstractContentAssistVisitor

buildUnionClauseStatementHelper

protected EclipseLinkContentAssistVisitor.UnionClauseStatementHelper buildUnionClauseStatementHelper()

getTableExpressionVisitor

protected EclipseLinkContentAssistVisitor.TableExpressionVisitor getTableExpressionVisitor()

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(CastExpression expression)

Visits the CastExpression expression.

Specified by:

visit in interface EclipseLinkExpressionVisitor

Parameters:

expression - The Expression 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(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(RegexpExpression expression)

Specified by:

visit in interface EclipseLinkExpressionVisitor

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