org.eclipse.persistence.jpa.jpql.tools
Class AbstractContentAssistVisitor.AbstractConditionalClauseCollectionHelper<T extends Expression>

java.lang.Object
  org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.AbstractConditionalClauseCollectionHelper<T>

All Implemented Interfaces:

AbstractContentAssistVisitor.CollectionExpressionHelper<T>

Direct Known Subclasses:

AbstractContentAssistVisitor.ConditionalClauseCollectionHelper, AbstractContentAssistVisitor.WhenClauseConditionalClauseCollectionHelper

Enclosing class:

AbstractContentAssistVisitor

protected abstract class AbstractContentAssistVisitor.AbstractConditionalClauseCollectionHelper<T extends Expression>
extends java.lang.Object
implements AbstractContentAssistVisitor.CollectionExpressionHelper<T>

This helper handles adding proposals within a conditional expression that might be parsed as a single expression or has a collection of expression, which means the fragment is either incomplete or invalid.

Constructor Summary

protected

AbstractContentAssistVisitor.AbstractConditionalClauseCollectionHelper()

Method Summary

void	addAtTheEndOfChild(Expression expression, CollectionExpression collectionExpression, int index, boolean hasComma, boolean virtualSpace) Adds the proposals because the cursor is at the end of the child at the given position.
void	addIdentifier(Expression expression, java.lang.String identifier) Adds the given JPQL identifier as a valid proposal.
void	addTheBeginningOfChild(Expression expression, CollectionExpression collectionExpression, int index, boolean hasComma) Adds the proposals because the cursor is at the beginning of the child Expression at the given position.
boolean	canContinue(Expression expression, CollectionExpression collectionExpression, int index) Asks this helper if the search can continue even though two child expressions are not separated by a comma.
protected java.lang.Object[]	findChild(CollectionExpression collectionExpression, int index) Handles a special case for a compound identifier like 'IS EMPTY' or 'IS NOT EMPTY'.
int	maxCollectionSize(Expression expression) Returns the maximum number of encapsulated expressions the Expression allows.
int	preExpressionLength(Expression expression) Returns the length of anything that can be defined before the first child.
JPQLQueryBNF	queryBNF(Expression expression, int index) Returns the JPQLQueryBNF that defines the fragment at the given position.

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.tools.AbstractContentAssistVisitor.CollectionExpressionHelper

buildCollectionExpression, hasDelimiterAfterIdentifier

Constructor Detail

AbstractContentAssistVisitor.AbstractConditionalClauseCollectionHelper

protected AbstractContentAssistVisitor.AbstractConditionalClauseCollectionHelper()

Method Detail

addAtTheEndOfChild

public void addAtTheEndOfChild(Expression expression,
                               CollectionExpression collectionExpression,
                               int index,
                               boolean hasComma,
                               boolean virtualSpace)

Adds the proposals because the cursor is at the end of the child at the given position.

Specified by:

addAtTheEndOfChild in interface AbstractContentAssistVisitor.CollectionExpressionHelper<T extends Expression>

Parameters:

expression - The Expression being visited

collectionExpression - The CollectionExpression is either the child of the given Expression or a temporary generated one that usually contains a single item

index - The position of that child in the collection of children

hasComma - Indicates whether a comma is present before the child at the given position; if the index is 0, then this is false by default

virtualSpace - Indicates if this method is called because the cursor is at the end of the child at the specified index but by considering there is a virtual space at the end of that child

addIdentifier

public void addIdentifier(Expression expression,
                          java.lang.String identifier)

Adds the given JPQL identifier as a valid proposal.

Specified by:

addIdentifier in interface AbstractContentAssistVisitor.CollectionExpressionHelper<T extends Expression>

Parameters:

expression - The Expression being visited

identifier - The JPQL identifier to add as a valid proposal

addTheBeginningOfChild

public void addTheBeginningOfChild(Expression expression,
                                   CollectionExpression collectionExpression,
                                   int index,
                                   boolean hasComma)

Adds the proposals because the cursor is at the beginning of the child Expression at the given position.

Specified by:

addTheBeginningOfChild in interface AbstractContentAssistVisitor.CollectionExpressionHelper<T extends Expression>

Parameters:

expression - The Expression being visited

collectionExpression - The CollectionExpression is either the child of the given Expression or a temporary generated one that usually contains a single item. This can be null if the position is at the beginning

index - The position of the child that was scanned

hasComma - Indicates whether a comma is present before the child at the given position; if the index is 0, then this is false by default

canContinue

public boolean canContinue(Expression expression,
                           CollectionExpression collectionExpression,
                           int index)

Asks this helper if the search can continue even though two child expressions are not separated by a comma.

Specified by:

canContinue in interface AbstractContentAssistVisitor.CollectionExpressionHelper<T extends Expression>

Parameters:

expression - The Expression being visited

collectionExpression - The CollectionExpression

index - The position of the child being scanned

Returns:

true if the check can continue even though the previous child was not separated by a comma; false to stop the check

findChild

protected java.lang.Object[] findChild(CollectionExpression collectionExpression,
                                       int index)

Handles a special case for a compound identifier like 'IS EMPTY' or 'IS NOT EMPTY'.

Parameters:

collectionExpression - The CollectionExpression is used to find the Expression to use when filtering out compound identifier

index - The position to start the search, which goes from that index to the beginning

Returns:

An array of three elements. The first one is the child Expression that can be used when filtering out compound identifier. The second boolean element indicates if IS was detected after the child. The third boolean element indicates if NOT was detected after the child, which would also be after IS if it was detected. null is returned if nothing could be found

maxCollectionSize

public int maxCollectionSize(Expression 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<T extends Expression>

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

Returns the length of anything that can be defined before the first child. An example can be "DISTINCT " in "AVG(DISTINCT e.name)".

Specified by:

preExpressionLength in interface AbstractContentAssistVisitor.CollectionExpressionHelper<T extends Expression>

Parameters:

expression - The Expression being visited

Returns:

The length of anything that was parsed before the first child or 0 if nothing was parsed

queryBNF

public JPQLQueryBNF queryBNF(Expression expression,
                             int index)

Returns the JPQLQueryBNF that defines the fragment at the given position.

Specified by:

queryBNF in interface AbstractContentAssistVisitor.CollectionExpressionHelper<T extends Expression>

Parameters:

expression - The Expression being visited

index - The position of the element to retrieve the BNF defined in the JPQL grammar

Returns:

The JPQLQueryBNF that defines the fragment at the given position