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

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
org.eclipse.persistence.jpa.internal.jpql.parser.AbstractSingleEncapsulatedExpression
org.eclipse.persistence.jpa.internal.jpql.parser.SubExpression

All Implemented Interfaces:

Expression

public final class SubExpression

extends AbstractSingleEncapsulatedExpression

This expression wraps a sub-expression within parenthesis.

BNF: expression ::= (sub_expression)

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Field Summary

private java.lang.String

queryBNF The unique identifier of the JPQLQueryBNF coming from the parent that is used to parse the next portion of the query.

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

SubExpression(AbstractExpression parent, java.lang.String queryBNF)
Creates a new SubExpression.

Method Summary

void	accept(ExpressionVisitor visitor) Visits this Expression by the given visitor.
(package private) boolean	areLogicalIdentifiersSupported()
java.lang.String	encapsulatedExpressionBNF() Returns the BNF used to parse the encapsulated expression.
JPQLQueryBNF	findQueryBNF(AbstractExpression expression) Retrieves the JPQLQueryBNF that was used to parse the given Expression.
JPQLQueryBNF	getQueryBNF() Returns the BNF of this Expression.
(package private) java.lang.String	parseIdentifier(WordParser wordParser) Parses the identifier of this expression.

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

acceptChildren, addChildrenTo, addOrderedEncapsulatedExpressionTo, getExpression, hasEncapsulatedExpression, hasExpression, parseEncapsulatedExpression, setExpression, toParsedTextEncapsulatedExpression

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

addOrderedChildrenTo, getIdentifier, hasLeftParenthesis, hasRightParenthesis, isParsingComplete, parse, toParsedText

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

buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, getChildren, getJPAVersion, getParent, 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

Field Detail

queryBNF

private java.lang.String queryBNF

The unique identifier of the JPQLQueryBNF coming from the parent that is used to parse the next portion of the query.

Constructor Detail

SubExpression

SubExpression(AbstractExpression parent,
              java.lang.String queryBNF)

Creates a new SubExpression.

Parameters:

parent - The parent of this expression

queryBNF - The BNF coming from the parent that is used to parse the next portion of the query

Method Detail

accept

public void accept(ExpressionVisitor visitor)

Visits this Expression by the given visitor.

Parameters:

visitor - The visitor to visit this object

areLogicalIdentifiersSupported

boolean areLogicalIdentifiersSupported()

Overrides:

areLogicalIdentifiersSupported in class AbstractEncapsulatedExpression

encapsulatedExpressionBNF

public java.lang.String encapsulatedExpressionBNF()

Returns the BNF used to parse the encapsulated expression.

Specified by:

encapsulatedExpressionBNF in class AbstractSingleEncapsulatedExpression

Returns:

The BNF used to parse the encapsulated expression

findQueryBNF

public JPQLQueryBNF findQueryBNF(AbstractExpression expression)

Retrieves the JPQLQueryBNF that was used to parse the given Expression.

Overrides:

findQueryBNF in class AbstractExpression

Parameters:

expression - The expression for which its BNF is needed

Returns:

The JPQLQueryBNF that was used to parse the given expression

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Specified by:

getQueryBNF in class AbstractExpression

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

parseIdentifier

java.lang.String parseIdentifier(WordParser wordParser)

Parses the identifier of this expression.

Specified by:

parseIdentifier in class AbstractEncapsulatedExpression

Returns:

The identifier for this expression