org.eclipse.persistence.jpa.internal.jpql.parser
Class AbstractEncapsulatedExpression

java.lang.Object
org.eclipse.persistence.jpa.internal.jpql.parser.StringExpression
org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.internal.jpql.parser.AbstractEncapsulatedExpression

All Implemented Interfaces:

Expression

Direct Known Subclasses:

AbstractDoubleEncapsulatedExpression, AbstractSingleEncapsulatedExpression, AbstractTripleEncapsulatedExpression, TreatExpression

public abstract class AbstractEncapsulatedExpression

extends AbstractExpression

This expression handles parsing the identifier followed by an expression encapsulated within parenthesis.

BNF: expression ::= <identifier>(expression)

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Field Summary

private boolean	hasLeftParenthesis Flag used to determine if the closing parenthesis is present in the query.
private boolean	hasRightParenthesis Flag used to determine if the opening parenthesis is present in the query.
private boolean	hasSpaceAfterIdentifier Special flag used to separate the identifier with the encapsulated expression when the left parenthesis is missing.

Fields inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE

Fields inherited from interface org.eclipse.persistence.jpa.internal.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXISTS, FALSE, FETCH, FROM, FUNC, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, LEADING, LEFT, LEFT_JOIN, LEFT_JOIN_FETCH, LEFT_OUTER_JOIN, LEFT_OUTER_JOIN_FETCH, LENGTH, LIKE, LOCATE, LOWER, LOWER_THAN, LOWER_THAN_OR_EQUAL, MAX, MEMBER, MEMBER_OF, MIN, MINUS, MOD, MULTIPLICATION, NAMED_PARAMETER, NEW, NOT, NOT_BETWEEN, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, OBJECT, OF, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, SELECT, SET, SIZE, SOME, SQRT, SUBSTRING, SUM, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Constructor Summary

AbstractEncapsulatedExpression(AbstractExpression parent)
Creates a new AbstractEncapsulatedExpression.

Method Summary

(package private) void	addOrderedChildrenTo(java.util.List<StringExpression> children) Adds the StringExpressions representing this Expression.
(package private) abstract void	addOrderedEncapsulatedExpressionTo(java.util.List<StringExpression> children) Adds the StringExpressions representing the encapsulated Expression.
(package private) boolean	areLogicalIdentifiersSupported()
java.lang.String	getIdentifier() Returns the JPQL identifier of this expression.
abstract boolean	hasEncapsulatedExpression() Determines whether something was parsed after the left parenthesis.
boolean	hasLeftParenthesis() Determines whether the open parenthesis was parsed or not.
boolean	hasRightParenthesis() Determines whether the close parenthesis was parsed or not.
(package private) boolean	isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression) Determines whether the parsing is complete based on what is left in the given text.
(package private) void	parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser.
(package private) abstract void	parseEncapsulatedExpression(WordParser wordParser, boolean tolerant) Parses the encapsulated expression by starting at the current position, which is part of the given WordParser.
(package private) abstract java.lang.String	parseIdentifier(WordParser wordParser) Parses the identifier of this expression.
(package private) void	toParsedText(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of this Expression.
(package private) abstract void	toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of the encapsulated Expression.

Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

addChildrenTo, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, getQueryBNF, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseSingleExpression, populatePosition, queryBNF, readdLeadingSpaces, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString

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.internal.jpql.parser.Expression

accept, acceptChildren

Field Detail

hasLeftParenthesis

private boolean hasLeftParenthesis

Flag used to determine if the closing parenthesis is present in the query.

hasRightParenthesis

private boolean hasRightParenthesis

Flag used to determine if the opening parenthesis is present in the query.

hasSpaceAfterIdentifier

private boolean hasSpaceAfterIdentifier

Special flag used to separate the identifier with the encapsulated expression when the left parenthesis is missing.

Constructor Detail

AbstractEncapsulatedExpression

AbstractEncapsulatedExpression(AbstractExpression parent)

Creates a new AbstractEncapsulatedExpression.

Parameters:

parent - The parent of this expression

Method Detail

addOrderedChildrenTo

final void addOrderedChildrenTo(java.util.List<StringExpression> children)

Adds the StringExpressions representing this Expression.

Overrides:

addOrderedChildrenTo in class AbstractExpression

Parameters:

children - The list used to store the string representation of this Expression

addOrderedEncapsulatedExpressionTo

abstract void addOrderedEncapsulatedExpressionTo(java.util.List<StringExpression> children)

Adds the StringExpressions representing the encapsulated Expression.

Parameters:

children - The list used to store the string representation of the encapsulated Expression

areLogicalIdentifiersSupported

boolean areLogicalIdentifiersSupported()

getIdentifier

public final java.lang.String getIdentifier()

Returns the JPQL identifier of this expression.

Returns:

The JPQL identifier

hasEncapsulatedExpression

public abstract boolean hasEncapsulatedExpression()

Determines whether something was parsed after the left parenthesis.

Returns:

true if something was parsed; false otherwise

hasLeftParenthesis

public final boolean hasLeftParenthesis()

Determines whether the open parenthesis was parsed or not.

Returns:

true if the open parenthesis was present in the string version of the query; false otherwise

hasRightParenthesis

public final boolean hasRightParenthesis()

Determines whether the close parenthesis was parsed or not.

Returns:

true if the close parenthesis was present in the string version of the query; false otherwise

isParsingComplete

boolean isParsingComplete(WordParser wordParser,
                          java.lang.String word,
                          Expression expression)

Determines whether the parsing is complete based on what is left in the given text. The text is never empty.

Overrides:

isParsingComplete in class AbstractExpression

Parameters:

wordParser - The text to parse based on the current position of the cursor

word - The word that was retrieved from the given text, which is the first word in the text

expression - The Expression that has already been parsed

Returns:

true if the text no longer can't be parsed by the current expression; false if more can be parsed

parse

final void parse(WordParser wordParser,
                 boolean tolerant)

Parses the query by starting at the current position, which is part of the given WordParser.

Specified by:

parse in class AbstractExpression

Parameters:

wordParser - The text to parse based on the current position of the cursor

tolerant - Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

parseEncapsulatedExpression

abstract void parseEncapsulatedExpression(WordParser wordParser,
                                          boolean tolerant)

Parses the encapsulated expression by starting at the current position, which is part of the given WordParser.

Parameters:

wordParser - The text to parse based on the current position of the cursor

tolerant - Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

parseIdentifier

abstract java.lang.String parseIdentifier(WordParser wordParser)

Parses the identifier of this expression.

Parameters:

text - The text to parse, which starts with the identifier

Returns:

The identifier for this expression

toParsedText

final void toParsedText(java.lang.StringBuilder writer,
                        boolean includeVirtual)

Generates a string representation of this Expression.

Specified by:

toParsedText in class AbstractExpression

Parameters:

writer - The buffer used to append this Expression's string representation

includeVirtual - Determines whether to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist

toParsedTextEncapsulatedExpression

abstract void toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer,
                                                 boolean includeVirtual)

Generates a string representation of the encapsulated Expression.

Parameters:

writer - The buffer used to append the encapsulated Expression's string representation

includeVirtual - Determines whether to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist