public abstract class AbstractEncapsulatedExpression extends AbstractExpression
expression ::= <identifier>(expression)COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCOREABS, ALL, AND, ANY, AS, AS_OF, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXTRACT, FALSE, FETCH, FIRST, 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, 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, QUOTE, REGEXP, SCN, SELECT, SET, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE| Modifier | Constructor and Description |
|---|---|
protected |
AbstractEncapsulatedExpression(AbstractExpression parent,
String identifier)
Creates a new
AbstractEncapsulatedExpression. |
| Modifier and Type | Method and Description |
|---|---|
protected void |
addOrderedChildrenTo(List<Expression> children)
Adds the children of this
AbstractExpression to the given list. |
protected abstract void |
addOrderedEncapsulatedExpressionTo(List<Expression> children)
Adds the
Expressions representing the encapsulated Expression. |
protected boolean |
areLogicalIdentifiersSupported() |
String |
getActualIdentifier()
Returns the actual identifier found in the string representation of the JPQL query, which has
the actual case that was used.
|
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.
|
boolean |
hasSpaceAfterIdentifier()
Determines whether a whitespace was parsed after the identifier rather than the left
parenthesis.
|
protected boolean |
isParsingComplete(WordParser wordParser,
String word,
Expression expression)
Determines whether the parsing is complete based on what is left in the given text.
|
protected void |
parse(WordParser wordParser,
boolean tolerant)
Parses the query by starting at the current position, which is part of the given
WordParser. |
protected abstract void |
parseEncapsulatedExpression(WordParser wordParser,
int whitespaceCount,
boolean tolerant)
Parses the encapsulated expression by starting at the current position, which is part of the
given
WordParser. |
protected abstract void |
removeEncapsulatedExpression()
Removes the encapsulated
Expression that was parsed, it should not be part of this one. |
protected boolean |
shouldParseRightParenthesis(WordParser wordParser,
boolean tolerant)
Determines whether the right parenthesis should be parsed or not by this expression.
|
protected void |
toParsedText(StringBuilder writer,
boolean actual)
Generates a string representation of this
Expression, including its children,
if it has any. |
protected abstract void |
toParsedTextEncapsulatedExpression(StringBuilder writer,
boolean actual)
Generates a string representation of the encapsulated
Expression. |
acceptUnknownVisitor, acceptUnknownVisitor, addChildrenTo, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, findQueryBNF, 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, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaccept, acceptChildren, getQueryBNFprotected AbstractEncapsulatedExpression(AbstractExpression parent, String identifier)
AbstractEncapsulatedExpression.parent - The parent of this expressionidentifier - The JPQL identifier that starts this expressionprotected final void addOrderedChildrenTo(List<Expression> children)
AbstractExpression to the given list.addOrderedChildrenTo in class AbstractExpressionchildren - The list used to store the string representation of this AbstractExpressionprotected abstract void addOrderedEncapsulatedExpressionTo(List<Expression> children)
Expressions representing the encapsulated Expression.children - The list used to store the string representation of the encapsulated Expressionprotected boolean areLogicalIdentifiersSupported()
public final String getActualIdentifier()
public final String getIdentifier()
public abstract boolean hasEncapsulatedExpression()
true if something was parsed; false otherwisepublic final boolean hasLeftParenthesis()
true if the open parenthesis was present in the string version of the
query; false otherwisepublic final boolean hasRightParenthesis()
true if the close parenthesis was present in the string version of the
query; false otherwisepublic boolean hasSpaceAfterIdentifier()
true if a whitespace was parsed after the identifier; false
otherwiseprotected boolean isParsingComplete(WordParser wordParser, String word, Expression expression)
isParsingComplete in class AbstractExpressionwordParser - The text to parse based on the current position of the cursorword - The word that was retrieved from the given text, which is the first word in the textexpression - The Expression that has already been parsedtrue if the text no longer can't be parsed by the current expression;
false if more can be parsedprotected void parse(WordParser wordParser, boolean tolerant)
WordParser.parse in class AbstractExpressionwordParser - The text to parse based on the current position of the cursortolerant - Determines whether the parsing system should be tolerant, meaning if it should
try to parse invalid or incomplete queriesprotected abstract void parseEncapsulatedExpression(WordParser wordParser, int whitespaceCount, boolean tolerant)
WordParser.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 queriesprotected abstract void removeEncapsulatedExpression()
Expression that was parsed, it should not be part of this one.
This happens when the parsed information does not have both '(' and ')'.protected boolean shouldParseRightParenthesis(WordParser wordParser, boolean tolerant)
wordParser - The text to parse based on the current position of the cursortolerant - Determines whether the parsing system should be tolerant, meaning if it should
try to parse invalid or incomplete queriestrue if the right parenthesis should be owned by this expression if it
is the next character to scan; false otherwiseprotected final void toParsedText(StringBuilder writer, boolean actual)
Expression, including its children,
if it has any.toParsedText in class AbstractExpressionwriter - The buffer used to append this Expression's string representationactual - Determines whether the string representation should represent what was parsed,
i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the
JPQL identifiersprotected abstract void toParsedTextEncapsulatedExpression(StringBuilder writer, boolean actual)
Expression.writer - The buffer used to append the encapsulated Expression'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 assistCopyright © 2007–2021 Eclipse.org - EclipseLink Project. All rights reserved.