EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference

org.eclipse.persistence.jpa.jpql
Class AbstractContentAssistVisitor.OrderByClauseCollectionHelper

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor.OrderByClauseCollectionHelper
All Implemented Interfaces:
AbstractContentAssistVisitor.CollectionExpressionHelper<OrderByClause>
Enclosing class:
AbstractContentAssistVisitor

protected class AbstractContentAssistVisitor.OrderByClauseCollectionHelper
extends java.lang.Object
implements AbstractContentAssistVisitor.CollectionExpressionHelper<OrderByClause>


Constructor Summary
protected AbstractContentAssistVisitor.OrderByClauseCollectionHelper()
           
 
Method Summary
 void addAtTheEndOfChild(OrderByClause expression, Expression child, int index)
          Adds the proposals because the cursor is at the end of the given child Expression.
 void addProposals(OrderByClause expression, int index)
          Adds
 CollectionExpression buildCollectionExpression(OrderByClause expression)
          Either returns the given Expression's child, which is already a CollectionExpression or requests this helper to return a "virtual" CollectionExpression that is wrapping the single element.
 boolean hasDelimiterAfterIdentifier(OrderByClause expression)
          Determines whether
 int maxCollectionSize(OrderByClause expression)
          Returns the maximum number of encapsulated expressions the Expression allows.
 int preExpressionLength(OrderByClause expression)
          Returns the length to add to
 JPQLQueryBNF queryBNF(OrderByClause expression, int index)
          Returns the
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractContentAssistVisitor.OrderByClauseCollectionHelper

protected AbstractContentAssistVisitor.OrderByClauseCollectionHelper()
Method Detail

addAtTheEndOfChild

public void addAtTheEndOfChild(OrderByClause expression,
                               Expression child,
                               int index)
Adds the proposals because the cursor is at the end of the given child Expression.

Specified by:
addAtTheEndOfChild in interface AbstractContentAssistVisitor.CollectionExpressionHelper<OrderByClause>
Parameters:
expression - The Expression being visited
child - The child of the parent Expression for which proposals can be added at the end
index - The position of that child in the collection of children

addProposals

public void addProposals(OrderByClause expression,
                         int index)
Adds

Specified by:
addProposals in interface AbstractContentAssistVisitor.CollectionExpressionHelper<OrderByClause>

buildCollectionExpression

public CollectionExpression buildCollectionExpression(OrderByClause expression)
Either returns the given Expression's child, which is already a CollectionExpression or requests this helper to return a "virtual" CollectionExpression that is wrapping the single element.

Specified by:
buildCollectionExpression in interface AbstractContentAssistVisitor.CollectionExpressionHelper<OrderByClause>
Parameters:
expression - The parent of the children to retrieve
Returns:
The given expression's child or a "virtual" one

hasDelimiterAfterIdentifier

public boolean hasDelimiterAfterIdentifier(OrderByClause expression)
Determines whether

Specified by:
hasDelimiterAfterIdentifier in interface AbstractContentAssistVisitor.CollectionExpressionHelper<OrderByClause>
Returns:

maxCollectionSize

public int maxCollectionSize(OrderByClause expression)
Returns the maximum number of encapsulated expressions the Expression allows. Some expression only allow 2, others 3 and others allow an unlimited number.

Specified by:
maxCollectionSize in interface AbstractContentAssistVisitor.CollectionExpressionHelper<OrderByClause>
Parameters:
expression - The Expression for which its maximum number of children
Returns:
The maximum number of children the expression can have

preExpressionLength

public int preExpressionLength(OrderByClause expression)
Returns the length to add to

Specified by:
preExpressionLength in interface AbstractContentAssistVisitor.CollectionExpressionHelper<OrderByClause>

queryBNF

public JPQLQueryBNF queryBNF(OrderByClause expression,
                             int index)
Returns the

Specified by:
queryBNF in interface AbstractContentAssistVisitor.CollectionExpressionHelper<OrderByClause>
Returns:

EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference