EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference

org.eclipse.persistence.jpa.jpql
Class EclipseLinkContentAssistVisitor

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor
      extended by org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor
          extended by 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
Author:
Pascal Filion
Since:
2.4

Nested Class Summary
protected  class EclipseLinkContentAssistVisitor.AppendableExpressionVisitor
           
protected  class EclipseLinkContentAssistVisitor.FromClauseSelectStatementHelper
           
protected  class EclipseLinkContentAssistVisitor.GroupByClauseCollectionHelper
           
protected  class EclipseLinkContentAssistVisitor.GroupByClauseSelectStatementHelper
           
protected  class EclipseLinkContentAssistVisitor.HavingClauseSelectStatementHelper
           
protected  class EclipseLinkContentAssistVisitor.OrderByClauseSelectStatementHelper
           
protected  class EclipseLinkContentAssistVisitor.TrailingCompletenessVisitor
           
protected  class EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper
           
protected  class EclipseLinkContentAssistVisitor.WhereClauseHelper
           
protected  class EclipseLinkContentAssistVisitor.WhereClauseSelectStatementHelper
           
 
Nested classes/interfaces inherited from class org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor
AbstractContentAssistVisitor.AbstractFromClauseSelectStatementHelper<T extends AbstractSelectStatement>, AbstractContentAssistVisitor.AbstractGroupByClauseSelectStatementHelper<T extends AbstractSelectStatement>, AbstractContentAssistVisitor.AbstractHavingClauseSelectStatementHelper<T extends AbstractSelectStatement>, AbstractContentAssistVisitor.AbstractSelectClauseSelectStatementHelper, AbstractContentAssistVisitor.AbstractWhereClauseSelectStatementHelper<T extends AbstractSelectStatement>, AbstractContentAssistVisitor.AcceptableTypeVisitor, AbstractContentAssistVisitor.ClauseHelper<T extends Expression>, AbstractContentAssistVisitor.CollectionExpressionHelper<T extends Expression>, AbstractContentAssistVisitor.CollectionExpressionVisitor, AbstractContentAssistVisitor.CollectionMappingFilter, AbstractContentAssistVisitor.CompletenessVisitor, AbstractContentAssistVisitor.CompoundExpressionHelper, AbstractContentAssistVisitor.ConditionalExpressionCompletenessVisitor, AbstractContentAssistVisitor.ConstrutorCollectionHelper, AbstractContentAssistVisitor.DefaultMappingCollector, AbstractContentAssistVisitor.DeleteClauseHelper, AbstractContentAssistVisitor.DoubleEncapsulatedCollectionHelper, AbstractContentAssistVisitor.FilteringMappingCollector, AbstractContentAssistVisitor.FromClauseCollectionHelper, AbstractContentAssistVisitor.FromClauseHelper, AbstractContentAssistVisitor.HavingClauseHelper, AbstractContentAssistVisitor.IdentificationVariableType, AbstractContentAssistVisitor.IncompleteCollectionExpressionVisitor, AbstractContentAssistVisitor.JoinCollectionHelper, AbstractContentAssistVisitor.MappingCollector, AbstractContentAssistVisitor.MappingFilterBuilder, AbstractContentAssistVisitor.MappingTypeFilter, AbstractContentAssistVisitor.NullExpressionVisitor, AbstractContentAssistVisitor.OrderByClauseCollectionHelper, AbstractContentAssistVisitor.PropertyMappingFilter, AbstractContentAssistVisitor.RangeVariableDeclarationVisitor, AbstractContentAssistVisitor.ResultVariableVisitor, AbstractContentAssistVisitor.SelectClauseCompletenessVisitor, AbstractContentAssistVisitor.SelectClauseSelectStatementHelper, AbstractContentAssistVisitor.SelectStatementHelper<T extends AbstractSelectStatement,C extends Expression>, AbstractContentAssistVisitor.SimpleFromClauseSelectStatementHelper, AbstractContentAssistVisitor.SimpleGroupByClauseSelectStatementHelper, AbstractContentAssistVisitor.SimpleHavingClauseSelectStatementHelper, AbstractContentAssistVisitor.SimpleSelectClauseSelectStatementHelper, AbstractContentAssistVisitor.SimpleWhereClauseSelectStatementHelper, AbstractContentAssistVisitor.SubqueryVisitor, AbstractContentAssistVisitor.TripleEncapsulatedCollectionHelper, AbstractContentAssistVisitor.UpdateItemCollectionHelper, AbstractContentAssistVisitor.VisitParentVisitor
 
Field Summary
 
Fields inherited from class org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor
context, corrections, helpers, lockedExpressions, positionInCollections, proposals, queryPosition, SPACE_LENGTH, virtualSpaces, word, wordParser
 
Constructor Summary
EclipseLinkContentAssistVisitor(JPQLQueryContext queryContext)
          Creates a new EclipseLinkContentAssistVisitor.
 
Method Summary
protected  EclipseLinkContentAssistVisitor.AppendableExpressionVisitor buildAppendableExpressionVisitor()
          
protected  EclipseLinkContentAssistVisitor.FromClauseSelectStatementHelper buildFromClauseSelectStatementHelper()
          
protected  EclipseLinkContentAssistVisitor.GroupByClauseCollectionHelper buildGroupByClauseCollectionHelper()
          
protected  EclipseLinkContentAssistVisitor.GroupByClauseSelectStatementHelper buildGroupByClauseSelectStatementHelper()
          
protected  EclipseLinkContentAssistVisitor.HavingClauseSelectStatementHelper buildHavingClauseSelectStatementHelper()
          
protected  EclipseLinkContentAssistVisitor.OrderByClauseSelectStatementHelper buildOrderByClauseSelectStatementHelper()
          
protected  EclipseLinkContentAssistVisitor.TrailingCompletenessVisitor buildTrailingCompleteness()
          
protected  EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper buildUnionClauseSelectStatementHelper()
           
protected  EclipseLinkContentAssistVisitor.WhereClauseHelper buildWhereClauseHelper()
          
protected  EclipseLinkContentAssistVisitor.WhereClauseSelectStatementHelper buildWhereClauseSelectStatementHelper()
          
protected  EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper getUnionClauseSelectStatementHelper()
           
protected  boolean isJoinFetchIdentifiable()
          Determines whether a JOIN FETCH expression can be identified by with an identification variable or not.
 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
addAggregate, addAllAggregates, addAllAggregates, addAllArithmeticIdentifiers, addAllClauses, addAllClauses, addAllComparisonIdentifiers, addAllCompounds, addAllCompounds, addAllExpressionFactoryIdentifiers, addAllExpressionFactoryIdentifiers, addAllFunctions, addAllFunctions, addAllFunctions, addAllFunctions, addAllIdentificationVariables, addAllIdentifiers, addAllIdentifiers, addAllLogicIdentifiers, addAllResultVariables, addClause, addCompound, addEntities, addEntities, addFunction, addIdentificationVariable, addIdentificationVariables, addIdentifier, addIdentifier, addIdentifier, addIdentifier, addJoinIdentifiers, addLeftIdentificationVariables, addRangeIdentificationVariable, addScalarExpressionProposals, addSelectExpressionProposals, addSelectExpressionProposals, areArithmeticSymbolsAppendable, areComparisonSymbolsAppendable, areLogicSymbolsAppendable, buildAcceptableTypeVisitor, buildCollectionExpressionVisitor, buildCollectionMappingFilter, buildCompoundExpressionHelper, buildConditionalExpressionCompletenessVisitor, buildConstrutorCollectionHelper, buildDefaultMappingCollector, buildDeleteClauseHelper, buildDoubleEncapsulatedCollectionHelper, buildFilteringMappingCollector, buildFromClauseCollectionHelper, buildFromClauseHelper, buildHavingClauseHelper, buildIncompleteCollectionExpressionVisitor, buildJoinCollectionHelper, buildJPQLQueryBNFValidator, buildJPQLQueryBNFValidator, buildMappingCollector, buildMappingFilter, buildMappingFilter, buildMappingFilterBuilder, buildNullExpressionVisitor, buildOrderByClauseCollectionHelper, buildPropertyMappingFilter, buildProposals, buildRangeVariableDeclarationVisitor, buildResultVariableVisitor, buildSelectClauseCompleteness, buildSelectClauseSelectStatementHelper, buildSimpleFromClauseSelectStatementHelper, buildSimpleGroupByClauseSelectStatementHelper, buildSimpleHavingClauseSelectStatementHelper, buildSimpleSelectClauseSelectStatementHelper, buildSimpleWhereClauseSelectStatementHelper, buildSubqueryVisitor, buildTripleEncapsulatedCollectionHelper, buildUpdateItemCollectionHelper, buildVisitParentVisitor, cast, dispose, entities, findExpressionPosition, findRangeVariableDeclaration, getAcceptableType, getAppendableExpressionVisitor, getCollectionExpression, getCollectionExpressionVisitor, getCompletenessVisitor, getCompoundExpressionHelper, getConditionalExpressionCompletenessVisitor, getConstructorCollectionHelper, getCorrections, getDefaultMappingCollector, getDeleteClauseHelper, getDoubleEncapsulatedCollectionHelper, getEmbeddable, getEntity, getEntityNamed, getExpressionFactory, getExpressionRegistry, getExpressionTypeVisitor, getFromClauseCollectionHelper, getFromClauseHelper, getFromClauseSelectStatementHelper, getGrammar, getGroupByClauseCollectionHelper, getGroupByClauseSelectStatementHelper, getHavingClauseHelper, getHavingClauseSelectStatementHelper, getHelper, getIdentifierRole, getIdentifierVersion, getIncompleteCollectionExpressionVisitor, getJoinCollectionHelper, getJPAVersion, getJPQLExpression, getManagedType, getMappedSuperclass, getMapping, getMappingCollectionFilter, getMappingFilterBuilder, getMappingPropertyFilter, getNullExpressionVisitor, getOrderByClauseCollectionHelper, getOrderByClauseSelectStatementHelper, getPosition, getProposals, getProvider, getQuery, getQueryBNF, getQueryContext, getQueryExpression, getRangeVariableDeclarationVisitor, getResolver, getResultVariableVisitor, getSelectClauseCompletenessVisitor, getSelectClauseSelectStatementHelper, getSimpleFromClauseSelectStatementHelper, getSimpleGroupByClauseSelectStatementHelper, getSimpleHavingClauseSelectStatementHelper, getSimpleSelectClauseSelectStatementHelper, getSimpleWhereClauseSelectStatementHelper, getSubqueryVisitor, getTripleEncapsulatedCollectionHelper, getType, getType, getType, getTypeDeclaration, getTypeHelper, getTypeRepository, getUpdateItemCollectionHelper, initialize, isAggregate, isAppendable, isAppendableToCollection, isClause, isComplete, isCompoundable, isCompoundFunction, isConditionalExpressionComplete, isFunction, isGroupByComplete, isInSubquery, isLocked, isNull, isPositionWithin, isPositionWithin, isPreviousClauseComplete, isResultVariable, isSelectExpressionComplete, isValid, isValid, isValidProposal, isValidVersion, length, prepare, registerHelper, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, 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, visitClause, visitCollectionExpression, visitCompoundableExpression, visitCompoundableExpression, visitDeleteStatement, visitEncapsulatedExpression, visitLogicalExpression, visitParentVisitor, visitPathExpression, visitPathExpression, visitSelectClause, visitSelectStatement, visitSelectStatement, visitSingleEncapsulatedExpression, visitSingleEncapsulatedExpression, visitUpdateStatement, whereClauseHelper, whereClauseSelectStatementHelper
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor
visit
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

buildAppendableExpressionVisitor

protected EclipseLinkContentAssistVisitor.AppendableExpressionVisitor buildAppendableExpressionVisitor()

Overrides:
buildAppendableExpressionVisitor in class AbstractContentAssistVisitor

buildFromClauseSelectStatementHelper

protected EclipseLinkContentAssistVisitor.FromClauseSelectStatementHelper buildFromClauseSelectStatementHelper()

Overrides:
buildFromClauseSelectStatementHelper in class AbstractContentAssistVisitor

buildGroupByClauseCollectionHelper

protected EclipseLinkContentAssistVisitor.GroupByClauseCollectionHelper buildGroupByClauseCollectionHelper()

Overrides:
buildGroupByClauseCollectionHelper in class AbstractContentAssistVisitor

buildGroupByClauseSelectStatementHelper

protected EclipseLinkContentAssistVisitor.GroupByClauseSelectStatementHelper buildGroupByClauseSelectStatementHelper()

Overrides:
buildGroupByClauseSelectStatementHelper in class AbstractContentAssistVisitor

buildHavingClauseSelectStatementHelper

protected EclipseLinkContentAssistVisitor.HavingClauseSelectStatementHelper buildHavingClauseSelectStatementHelper()

Overrides:
buildHavingClauseSelectStatementHelper in class AbstractContentAssistVisitor

buildOrderByClauseSelectStatementHelper

protected EclipseLinkContentAssistVisitor.OrderByClauseSelectStatementHelper buildOrderByClauseSelectStatementHelper()

Overrides:
buildOrderByClauseSelectStatementHelper in class AbstractContentAssistVisitor

buildTrailingCompleteness

protected EclipseLinkContentAssistVisitor.TrailingCompletenessVisitor buildTrailingCompleteness()

Overrides:
buildTrailingCompleteness in class AbstractContentAssistVisitor

buildUnionClauseSelectStatementHelper

protected EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper buildUnionClauseSelectStatementHelper()

buildWhereClauseHelper

protected EclipseLinkContentAssistVisitor.WhereClauseHelper buildWhereClauseHelper()

Overrides:
buildWhereClauseHelper in class AbstractContentAssistVisitor

buildWhereClauseSelectStatementHelper

protected EclipseLinkContentAssistVisitor.WhereClauseSelectStatementHelper buildWhereClauseSelectStatementHelper()

Overrides:
buildWhereClauseSelectStatementHelper in class AbstractContentAssistVisitor

getUnionClauseSelectStatementHelper

protected EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper getUnionClauseSelectStatementHelper()

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

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

EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference