Class AbstractSingleEncapsulatedExpression
java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression
org.eclipse.persistence.jpa.jpql.parser.AbstractSingleEncapsulatedExpression
- All Implemented Interfaces:
Expression
- Direct Known Subclasses:
AbsExpression
,AggregateFunction
,AllOrAnyExpression
,CastExpression
,CoalesceExpression
,ConcatExpression
,EncapsulatedIdentificationVariableExpression
,ExistsExpression
,ExtractExpression
,FunctionExpression
,LengthExpression
,LowerExpression
,MathSingleExpression
,SizeExpression
,SqrtExpression
,SubExpression
,TableExpression
,TrimExpression
,TypeExpression
,UpperExpression
This expression handles parsing a JPQL identifier followed by an expression encapsulated within
parenthesis.
BNF:
expression ::= <identifier>(expression)
- Since:
- 2.3
- Version:
- 2.5
-
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, 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, 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, ROUND, SCN, SELECT, SET, SIGN, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIME, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE
-
Constructor Summary
ModifierConstructorDescriptionprotected
AbstractSingleEncapsulatedExpression
(AbstractExpression parent, String identifier) Creates a newEncapsulatedExpression
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
acceptChildren
(ExpressionVisitor visitor) Visits the children of thisExpression
.protected final void
addChildrenTo
(Collection<Expression> children) Adds the children of thisAbstractExpression
to the given collection.protected void
addOrderedEncapsulatedExpressionTo
(List<Expression> children) Adds theExpressions
representing the encapsulatedExpression
.findQueryBNF
(Expression expression) Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.abstract String
Returns the BNF used to parse the encapsulated expression.final Expression
Returns theExpression
that is encapsulated within parenthesis.boolean
Determines whether something was parsed after the left parenthesis.final boolean
Determines whether the encapsulated expression of the query was parsed.protected void
parseEncapsulatedExpression
(WordParser wordParser, int whitespaceCount, boolean tolerant) Parses the encapsulated expression by starting at the current position, which is part of the givenWordParser
.protected void
Removes the encapsulatedExpression
that was parsed, it should not be part of this one.final void
setExpression
(AbstractExpression expression) Manually sets the encapsulatedExpression
to become the given one.protected void
toParsedTextEncapsulatedExpression
(StringBuilder writer, boolean actual) Generates a string representation of the encapsulatedExpression
.Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression
addOrderedChildrenTo, areLogicalIdentifiersSupported, getActualIdentifier, getIdentifier, hasLeftParenthesis, hasRightParenthesis, hasSpaceAfterIdentifier, 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, getQueryBNF, getRoot, getText, handleAggregate, handleCollection, 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
accept, getQueryBNF
-
Constructor Details
-
AbstractSingleEncapsulatedExpression
Creates a newEncapsulatedExpression
.- Parameters:
parent
- The parent of this expressionidentifier
- The JPQL identifier that starts this expression
-
-
Method Details
-
acceptChildren
Description copied from interface:Expression
Visits the children of thisExpression
. This method can be used to optimize traversing the children since a new list is not created every timeExpression.children()
is called.This does not traverse the
Expression
sub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.- Parameters:
visitor
- Thevisitor
to visit the children of this object.
-
addChildrenTo
Description copied from class:AbstractExpression
Adds the children of thisAbstractExpression
to the given collection.- Overrides:
addChildrenTo
in classAbstractExpression
- Parameters:
children
- The collection used to store the children
-
addOrderedEncapsulatedExpressionTo
Description copied from class:AbstractEncapsulatedExpression
Adds theExpressions
representing the encapsulatedExpression
.- Specified by:
addOrderedEncapsulatedExpressionTo
in classAbstractEncapsulatedExpression
- Parameters:
children
- The list used to store the string representation of the encapsulatedExpression
-
findQueryBNF
Description copied from interface:Expression
Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.- Specified by:
findQueryBNF
in interfaceExpression
- Overrides:
findQueryBNF
in classAbstractExpression
- Parameters:
expression
- TheExpression
that is a descendant of this one- Returns:
- The
JPQLQueryBNF
that was used to parse the given expression
-
getEncapsulatedExpressionQueryBNFId
Returns the BNF used to parse the encapsulated expression.- Returns:
- The BNF used to parse the encapsulated expression
-
getExpression
Returns theExpression
that is encapsulated within parenthesis.- Returns:
- The
Expression
that is encapsulated within parenthesis
-
hasEncapsulatedExpression
public boolean hasEncapsulatedExpression()Description copied from class:AbstractEncapsulatedExpression
Determines whether something was parsed after the left parenthesis.- Specified by:
hasEncapsulatedExpression
in classAbstractEncapsulatedExpression
- Returns:
true
if something was parsed;false
otherwise
-
hasExpression
public final boolean hasExpression()Determines whether the encapsulated expression of the query was parsed.- Returns:
true
if the encapsulated expression was parsed;false
if it was not parsed
-
parseEncapsulatedExpression
protected void parseEncapsulatedExpression(WordParser wordParser, int whitespaceCount, boolean tolerant) Description copied from class:AbstractEncapsulatedExpression
Parses the encapsulated expression by starting at the current position, which is part of the givenWordParser
.- Specified by:
parseEncapsulatedExpression
in classAbstractEncapsulatedExpression
- Parameters:
wordParser
- The text to parse based on the current position of the cursorwhitespaceCount
- The number of whitespace characters that were parsed after '('tolerant
- Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
-
removeEncapsulatedExpression
protected void removeEncapsulatedExpression()Description copied from class:AbstractEncapsulatedExpression
Removes the encapsulatedExpression
that was parsed, it should not be part of this one. This happens when the parsed information does not have both '(' and ')'.- Specified by:
removeEncapsulatedExpression
in classAbstractEncapsulatedExpression
-
setExpression
Manually sets the encapsulatedExpression
to become the given one.- Parameters:
expression
- The new encapsulatedExpression
, which cannot benull
- Throws:
NullPointerException
- The givenAbstractExpression
cannot benull
-
toParsedTextEncapsulatedExpression
Description copied from class:AbstractEncapsulatedExpression
Generates a string representation of the encapsulatedExpression
.- Specified by:
toParsedTextEncapsulatedExpression
in classAbstractEncapsulatedExpression
- Parameters:
writer
- The buffer used to append the encapsulatedExpression
's string representationactual
- 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
-