Module eclipselink

Package org.eclipse.persistence.jpa.jpql.parser

Class SubExpression

java.lang.Object

org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

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

org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression

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

All Implemented Interfaces:

Expression, ParentExpression

public final class SubExpression
extends AbstractSingleEncapsulatedExpression
implements ParentExpression

This expression wraps a sub-expression within parenthesis.

BNF: expression ::= (sub_expression)

Version:

2.5

Author:

Pascal Filion

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.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.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, AS_OF, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CEILING, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONCAT_PIPES, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DATE, DATETIME, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXP, EXTRACT, FALSE, FETCH, FIRST, FLOOR, FROM, FUNC, FUNCTION, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, ID, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, INTERSECT, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, LAST, LEADING, LEFT, LEFT_JOIN, LEFT_JOIN_FETCH, LEFT_OUTER_JOIN, LEFT_OUTER_JOIN_FETCH, LENGTH, LIKE, LN, LOCAL, LOCATE, LOWER, LOWER_THAN, LOWER_THAN_OR_EQUAL, MAX, MEMBER, MEMBER_OF, MIN, MINUS, MOD, MULTIPLICATION, NAMED_PARAMETER, NEW, NOT, NOT_BETWEEN, NOT_EQUAL, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, NULLS, NULLS_FIRST, NULLS_LAST, OBJECT, OF, ON, OPERATOR, OR, ORDER_BY, ORDER_SIBLINGS_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, POWER, QUOTE, REGEXP, REPLACE, RIGHT, ROUND, SCN, SELECT, SET, SIGN, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, THIS, TIME, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, VERSION, WHEN, WHERE

Constructor Summary

Constructors

Constructor	Description
SubExpression(AbstractExpression parent, JPQLQueryBNF queryBNF)	Creates a new SubExpression.

Method Summary

Modifier and Type	Method	Description
void	accept(ExpressionVisitor visitor)	Visits this Expression by the given visitor.
protected boolean	areLogicalIdentifiersSupported()
JPQLQueryBNF	findQueryBNF(Expression expression)	Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.
String	getEncapsulatedExpressionQueryBNFId()	Returns the BNF used to parse the encapsulated expression.
List<IdentificationVariable>	getIdentificationVariablesWithoutAlias()	Get list of IdentificationVariable where this alias should be added.
JPQLQueryBNF	getQueryBNF()	Returns the BNF of this Expression.
protected boolean	handleCollection(JPQLQueryBNF queryBNF)	Determines whether the given JPQLQueryBNF handles a collection of sub-expressions that are separated by commas.
boolean	isGenerateImplicitThisAlias()	Whether Hermes parser should automatically add missing "this" prefix into where field variables if it doesn't exist.
boolean	isParentExpression()	Flag if expression is a parent/root in the tree.
boolean	isSubExpression()
void	setGenerateImplicitThisAlias(boolean generateImplicitThisAlias)

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

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

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

addOrderedChildrenTo, getActualIdentifier, getIdentifier, hasLeftParenthesis, hasRightParenthesis, hasSpaceAfterIdentifier, isInvalid, isParsingComplete, parse, shouldParseRightParenthesis, toParsedText

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

acceptUnknownVisitor, acceptUnknownVisitor, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getParentExpression, getQueryBNF, getRoot, getText, handleAggregate, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, 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.jpql.parser.Expression

acceptChildren, children, getGrammar, getLength, getOffset, getParent, getRoot, isAncestor, orderedChildren, populatePosition, toActualText, toParsedText

Constructor Details

SubExpression

public SubExpression(AbstractExpression parent,
 JPQLQueryBNF 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 Details

isGenerateImplicitThisAlias

public boolean isGenerateImplicitThisAlias()

Description copied from interface: ParentExpression

Whether Hermes parser should automatically add missing "this" prefix into where field variables if it doesn't exist.

Specified by:

isGenerateImplicitThisAlias in interface ParentExpression

Returns:

boolean true - if this aliases should be generated , false - if not

setGenerateImplicitThisAlias

public void setGenerateImplicitThisAlias(boolean generateImplicitThisAlias)

Specified by:

setGenerateImplicitThisAlias in interface ParentExpression

isParentExpression

public boolean isParentExpression()

Description copied from class: AbstractExpression

Flag if expression is a parent/root in the tree.

Overrides:

isParentExpression in class AbstractExpression

Returns:

boolean true - yes it's parent/root , false - if not

isSubExpression

public boolean isSubExpression()

Overrides:

isSubExpression in class AbstractExpression

accept

public void accept(ExpressionVisitor visitor)

Description copied from interface: Expression

Visits this Expression by the given visitor.

Specified by:

accept in interface Expression

Parameters:

visitor - The ExpressionVisitor to visit this object

areLogicalIdentifiersSupported

protected boolean areLogicalIdentifiersSupported()

Overrides:

areLogicalIdentifiersSupported in class AbstractEncapsulatedExpression

getEncapsulatedExpressionQueryBNFId

public String getEncapsulatedExpressionQueryBNFId()

Description copied from class: AbstractSingleEncapsulatedExpression

Returns the BNF used to parse the encapsulated expression.

Specified by:

getEncapsulatedExpressionQueryBNFId in class AbstractSingleEncapsulatedExpression

Returns:

The BNF used to parse the encapsulated expression

findQueryBNF

public JPQLQueryBNF findQueryBNF(Expression expression)

Description copied from interface: Expression

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.

Specified by:

findQueryBNF in interface Expression

Overrides:

findQueryBNF in class AbstractSingleEncapsulatedExpression

Parameters:

expression - The Expression that is a descendant of this one

Returns:

The JPQLQueryBNF that was used to parse the given expression

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Description copied from interface: Expression

Returns the BNF of this Expression.

Specified by:

getQueryBNF in interface Expression

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

handleCollection

protected boolean handleCollection(JPQLQueryBNF queryBNF)

Description copied from class: AbstractExpression

Determines whether the given JPQLQueryBNF handles a collection of sub-expressions that are separated by commas.

Overrides:

handleCollection in class AbstractExpression

Parameters:

queryBNF - The JPQLQueryBNF used to determine if the parsing should handle collection of sub-expressions

Returns:

true if the sub-expression to parse might have several sub-expressions separated by commas; false otherwise

getIdentificationVariablesWithoutAlias

public List<IdentificationVariable> getIdentificationVariablesWithoutAlias()

Description copied from interface: ParentExpression

Get list of IdentificationVariable where this alias should be added.

Specified by:

getIdentificationVariablesWithoutAlias in interface ParentExpression