Top Description Inners Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.tools

public Class EclipseLinkContentAssistVisitor

extends AbstractContentAssistVisitor
implements EclipseLinkExpressionVisitor
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor, org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor
Annotations
@SuppressWarnings:unused
Static Imports
org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.DOT, .Expression.ALL, .Expression.AS, .Expression.AS_OF, .Expression.CONNECT_BY, .Expression.EXCEPT, .Expression.FROM, .Expression.INTERSECT, .Expression.NOT_EQUAL, .Expression.NULLS_FIRST, .Expression.NULLS_LAST, .Expression.ORDER_SIBLINGS_BY, .Expression.REGEXP, .Expression.SCN, .Expression.SELECT, .Expression.START_WITH, .Expression.TABLE, .Expression.TIMESTAMP, .Expression.UNION, .Expression.WHERE
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.

Author
Pascal Filion
Since
2.4
Version
2.5.1

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static class
EclipseLinkContentAssistVisitor.AcceptableTypeVisitor

protected static class
EclipseLinkContentAssistVisitor.AppendableExpressionVisitor

protected static class
EclipseLinkContentAssistVisitor.EndingQueryPositionBuilder

protected static class
EclipseLinkContentAssistVisitor.FollowingClausesVisitor

This visitor adds support for the additional clauses provided by EclipseLink, such as the

protected class
EclipseLinkContentAssistVisitor.FromClauseCollectionHelper

protected class
EclipseLinkContentAssistVisitor.FromClauseStatementHelper

protected class
EclipseLinkContentAssistVisitor.IncompleteCollectionExpressionVisitor

This subclass adds support for EclipseLink specific support.

protected class
EclipseLinkContentAssistVisitor.OrderByClauseStatementHelper

protected class
EclipseLinkContentAssistVisitor.SimpleFromClauseStatementHelper

protected class
EclipseLinkContentAssistVisitor.TableExpressionVisitor

protected class
EclipseLinkContentAssistVisitor.UnionClauseStatementHelper

Field Summary

Inherited from org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor:
correctionshelpersidentifierFiltersINVALID_IDENTIFIER_FILTERlockedExpressionsproposalsqueryContextqueryPositionSPACE_LENGTHVALID_IDENTIFIER_FILTERvirtualSpaceswordwordParser

Constructor Summary

AccessConstructor and Description
public
EclipseLinkContentAssistVisitor(JPQLQueryContext
The context used to query information about the query
queryContext)

Creates a new EclipseLinkContentAssistVisitor.

Method Summary

Modifier and TypeMethod and Description
protected EclipseLinkContentAssistVisitor.AcceptableTypeVisitor
buildAcceptableTypeVisitor()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.buildAcceptableTypeVisitor.

protected EclipseLinkContentAssistVisitor.AppendableExpressionVisitor
buildAppendableExpressionVisitor()

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.buildAppendableExpressionVisitor.

protected EclipseLinkContentAssistVisitor.EndingQueryPositionBuilder
buildEndingQueryPositionBuilder()

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.buildEndingQueryPositionBuilder.

protected EclipseLinkContentAssistVisitor.FollowingClausesVisitor
buildFollowingClausesVisitor()

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.buildFollowingClausesVisitor.

protected EclipseLinkContentAssistVisitor.FromClauseCollectionHelper
buildFromClauseCollectionHelper()

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.buildFromClauseCollectionHelper.

protected EclipseLinkContentAssistVisitor.FromClauseStatementHelper
buildFromClauseStatementHelper()

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.buildFromClauseStatementHelper.

protected AbstractContentAssistVisitor.GroupByClauseCollectionHelper
buildGroupByClauseCollectionHelper()

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.buildGroupByClauseCollectionHelper.

protected EclipseLinkContentAssistVisitor.IncompleteCollectionExpressionVisitor
buildIncompleteCollectionExpressionVisitor()

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.buildIncompleteCollectionExpressionVisitor.

protected EclipseLinkContentAssistVisitor.OrderByClauseStatementHelper
buildOrderByClauseStatementHelper()

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.buildOrderByClauseStatementHelper.

protected EclipseLinkContentAssistVisitor.SimpleFromClauseStatementHelper
buildSimpleFromClauseStatementHelper()

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.buildSimpleFromClauseStatementHelper.

protected EclipseLinkContentAssistVisitor.TableExpressionVisitor
buildTableExpressionVisitor()

protected EclipseLinkContentAssistVisitor.UnionClauseStatementHelper
buildUnionClauseStatementHelper()

protected EclipseLinkVersion

Returns:

The EclipseLink version specified or the default version (i.e. the version of the current release)
getEcliseLinkVersion()

Returns the enum constant of the EclipseLink version specified in the JPQLQueryContext.

protected JPQLGrammar
getLatestGrammar()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.getLatestGrammar.

Returns the latest supported JPQL grammar, which is required when checking the validity of a JPQL identifier.
protected EclipseLinkContentAssistVisitor.TableExpressionVisitor
getTableExpressionVisitor()

protected String
getTableName(String variableName)

protected EclipseLinkContentAssistVisitor.UnionClauseStatementHelper
getUnionClauseStatementHelper()

protected void
initialize()

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.initialize.

Initializes this visitor.
protected boolean
isJoinFetchIdentifiable()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.isJoinFetchIdentifiable.

Determines whether a JOIN FETCH expression can be identified by with an identification variable or not.
protected boolean
isTableExpression(Expression expression)

public void
visit(AsOfClause
The Expression to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the AsOfClause expression.
public void
visit(CastExpression
The Expression to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the CastExpression expression.
public void
visit(ConnectByClause
The ConnectByClause to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the ConnectByClause expression.
public void
visit(DatabaseType
The DatabaseType to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the DatabaseType expression.
public void
visit(ExtractExpression
The Expression to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the ExtractExpression expression.
public void
visit(HierarchicalQueryClause
The HierarchicalQueryClause to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the HierarchicalQueryClause expression.
public void
visit(OrderByItem
The Expression to visit
expression)

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.visit.

Implements org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor.visit.

Visits the OrderByItem expression.
public void
visit(OrderSiblingsByClause
The Expression to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the OrderSiblingsByClause expression.
public void
visit(RegexpExpression
The Expression to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the RegexpExpression expression.
public void
visit(StartWithClause
The StartWithClause to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the StartWithClause expression.
public void
visit(TableExpression
The Expression to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the TableExpression expression.
public void
visit(TableVariableDeclaration
The Expression to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the TableVariableDeclaration expression.
public void
visit(UnionClause
The Expression to visit
expression)

Implements org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor.visit.

Visits the UnionClause expression.
protected void
visitThirdPartyPathExpression(AbstractPathExpression
The AbstractPathExpression to inspect
expression, String
The beginning of the path expression
variableName)

Overrides org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.visitThirdPartyPathExpression.

Visits the given AbstractPathExpression and attempts to find valid proposals that is not provided by the default implementation.
Inherited from org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor:
addAggregateIdentifieraddAggregateIdentifiersaddAggregateIdentifiersaddArithmeticIdentifiersaddClauseIdentifieraddClauseIdentifiersaddClauseIdentifiersaddComparisonIdentifiersaddCompositeIdentifieraddCompoundIdentifieraddCompoundIdentifiersaddCompoundIdentifiersaddEntitiesaddEntitiesaddEnumConstantaddEnumConstantsaddExpressionFactoryIdentifiersaddExpressionFactoryIdentifiersaddFunctionIdentifieraddFunctionIdentifiersaddFunctionIdentifiersaddFunctionIdentifiersaddIdentificationVariableaddIdentificationVariablesaddIdentificationVariablesaddIdentifieraddJoinIdentifiersaddLeftIdentificationVariablesaddLogicalIdentifiersaddRangeIdentificationVariableaddResultVariablesaddVirtualSpaceareArithmeticSymbolsAppendableareComparisonSymbolsAppendableareLogicalSymbolsAppendablebuildCollectionCompoundTypeFilterbuildCollectionExpressionVisitorbuildCollectionMappingFilterbuildConcatExpressionCollectionHelperbuildConditionalClauseCollectionHelperbuildConstrutorCollectionHelperbuildDeclarationVisitorbuildDefaultMappingCollectorbuildDeleteClauseCollectionHelperbuildDeleteClauseStatementHelperbuildDifferentComparisonFilterbuildDoubleEncapsulatedCollectionHelperbuildEncapsulatedExpressionVisitorbuildEndingPositionFromInvalidExpressionbuildEnumVisitorbuildFilteringMappingCollectorbuildFollowingInvalidExpressionVisitorbuildGroupByClauseStatementHelperbuildHavingClauseStatementHelperbuildInvalidExpressionVisitorbuildJoinCollectionHelperbuildJPQLQueryBNFValidatorbuildMappingCollectorbuildMappingFilterbuildMappingFilterbuildMappingFilterBuilderbuildNonCollectionCompoundTypeFilterbuildNotExpressionVisitorbuildOrderByClauseCollectionHelperbuildPropertyMappingFilterbuildProposalsbuildProposalsbuildRangeVariableDeclarationVisitorbuildResultVariableVisitorbuildSelectClauseCollectionHelperbuildSelectClauseStatementHelperbuildSimpleGroupByClauseStatementHelperbuildSimpleHavingClauseStatementHelperbuildSimpleSelectClauseCollectionHelperbuildSimpleSelectClauseStatementHelperbuildSimpleWhereClauseSelectStatementHelperbuildSubqueryAppendableExpressionVisitorbuildSubqueryVisitorbuildTripleEncapsulatedCollectionHelperbuildUpdateClauseStatementHelperbuildUpdateItemCollectionHelperbuildVisitParentVisitorbuildWhenClauseConditionalClauseCollectionHelperbuildWhereClauseDeleteStatementHelperbuildWhereClauseSelectStatementHelperbuildWhereClauseUpdateStatementHelperbuildWithinInvalidExpressionVisitordisposefindRangeVariableDeclarationgetAcceptableTypegetAppendableExpressionVisitorgetCollectionExpressiongetCollectionExpressionVisitorgetConcatExpressionCollectionHelpergetConditionalClauseCollectionHelpergetConstructorCollectionHelpergetDeclarationVisitorgetDefaultMappingCollectorgetDeleteClauseCollectionHelpergetDeleteClauseStatementHelpergetDoubleEncapsulatedCollectionHelpergetEncapsulatedExpressionVisitorgetEndingQueryPositionBuildergetEnumVisitorgetExpressionFactorygetExpressionTypeVisitorgetFiltergetFollowingClausesVisitorgetFollowingInvalidExpressionVisitorgetFromClauseCollectionHelpergetFromClauseStatementHelpergetGroupByClauseCollectionHelpergetGroupByClauseStatementHelpergetHavingClauseStatementHelpergetHelpergetIdentifierRolegetIncompleteCollectionExpressionVisitorgetInvalidExpressionVisitorgetJoinCollectionHelpergetMappingCollectionFiltergetMappingFilterBuildergetMappingPropertyFiltergetNotExpressionVisitorgetOrderByClauseCollectionHelpergetOrderByClauseStatementHelpergetQueryBNFgetRangeVariableDeclarationVisitorgetResultVariableVisitorgetSelectClauseCollectionHelpergetSelectClauseStatementHelpergetSimpleFromClauseStatementHelpergetSimpleGroupByClauseStatementHelpergetSimpleHavingClauseStatementHelpergetSimpleSelectClauseCollectionHelpergetSimpleSelectClauseStatementHelpergetSimpleWhereClauseSelectStatementHelpergetSubqueryAppendableExpressionVisitorgetSubqueryVisitorgetTripleEncapsulatedCollectionHelpergetUpdateClauseStatementHelpergetUpdateItemCollectionHelpergetVisitParentVisitorgetWhenClauseConditionalClauseCollectionHelpergetWhereClauseDeleteStatementHelpergetWhereClauseSelectStatementHelpergetWhereClauseUpdateStatementHelpergetWithinInvalidExpressionVisitorhasClausesDefinedBetweenhasVirtualSpaceisAggregateisAppendableisAppendableToCollectionisClauseisClauseAppendableisCompleteisCompoundableisCompoundFunctionisDeclarationisEncapsulatedisEnumAllowedisFollowingInvalidExpressionisFunctionisInSubqueryisInvalidExpressionisLockedisNotExpressionisPositionWithinisPositionWithinisSubqueryAppendableisValidisValidisValidisValidisValidisValidProposalisValidVersionisWithinInvalidExpressionregisterHelperremoveVirtualSpacetoStringvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitAggregateFunctionvisitArithmeticExpressionvisitCollectionExpressionvisitEndingExpressionvisitEnumConstantvisitInvalidExpressionvisitLogicalExpressionvisitPathExpressionvisitPathExpressionvisitSingleEncapsulatedExpressionvisitSingleEncapsulatedExpressionvisitStatement