public abstract class AbstractSingleEncapsulatedExpression extends AbstractEncapsulatedExpression
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 |
AbstractSingleEncapsulatedExpression(AbstractExpression parent,
java.lang.String identifier)
Creates a new
EncapsulatedExpression. |
| Modifier and Type | Method and Description |
|---|---|
void |
acceptChildren(ExpressionVisitor visitor)
Visits the children of this
Expression. |
protected void |
addChildrenTo(java.util.Collection<Expression> children)
Adds the children of this
AbstractExpression to the given collection. |
protected void |
addOrderedEncapsulatedExpressionTo(java.util.List<Expression> children)
Adds the
Expressions representing the encapsulated Expression. |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the
JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression. |
abstract java.lang.String |
getEncapsulatedExpressionQueryBNFId()
Returns the BNF used to parse the encapsulated expression.
|
Expression |
getExpression()
Returns the
Expression that is encapsulated within parenthesis. |
boolean |
hasEncapsulatedExpression()
Determines whether something was parsed after the left parenthesis.
|
boolean |
hasExpression()
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
given
WordParser. |
protected void |
removeEncapsulatedExpression()
Removes the encapsulated
Expression that was parsed, it should not be part of this one. |
void |
setExpression(AbstractExpression expression)
Manually sets the encapsulated
Expression to become the given one. |
protected void |
toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer,
boolean actual)
Generates a string representation of the encapsulated
Expression. |
addOrderedChildrenTo, areLogicalIdentifiersSupported, getActualIdentifier, getIdentifier, hasLeftParenthesis, hasRightParenthesis, hasSpaceAfterIdentifier, isParsingComplete, parse, shouldParseRightParenthesis, toParsedTextacceptUnknownVisitor, 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, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaccept, getQueryBNFprotected AbstractSingleEncapsulatedExpression(AbstractExpression parent, java.lang.String identifier)
EncapsulatedExpression.parent - The parent of this expressionidentifier - The JPQL identifier that starts this expressionpublic void acceptChildren(ExpressionVisitor visitor)
Expression. This method can be used to optimize traversing
the children since a new list is not created every time Expression.children() is called.
This does not traverse the Expression sub-hierarchy, use a subclass of
AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.
visitor - The visitor to visit the children of this object.protected final void addChildrenTo(java.util.Collection<Expression> children)
AbstractExpression to the given collection.addChildrenTo in class AbstractExpressionchildren - The collection used to store the childrenprotected void addOrderedEncapsulatedExpressionTo(java.util.List<Expression> children)
Expressions representing the encapsulated Expression.addOrderedEncapsulatedExpressionTo in class AbstractEncapsulatedExpressionchildren - The list used to store the string representation of the encapsulated Expressionpublic JPQLQueryBNF findQueryBNF(Expression expression)
JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression.findQueryBNF in interface ExpressionfindQueryBNF in class AbstractExpressionexpression - The Expression that is a descendant of this oneJPQLQueryBNF that was used to parse the given expressionpublic abstract java.lang.String getEncapsulatedExpressionQueryBNFId()
public final Expression getExpression()
Expression that is encapsulated within parenthesis.Expression that is encapsulated within parenthesispublic boolean hasEncapsulatedExpression()
hasEncapsulatedExpression in class AbstractEncapsulatedExpressiontrue if something was parsed; false otherwisepublic final boolean hasExpression()
true if the encapsulated expression was parsed; false if it
was not parsedprotected void parseEncapsulatedExpression(WordParser wordParser, int whitespaceCount, boolean tolerant)
WordParser.parseEncapsulatedExpression in class AbstractEncapsulatedExpressionwordParser - 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 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 ')'.removeEncapsulatedExpression in class AbstractEncapsulatedExpressionpublic final void setExpression(AbstractExpression expression)
Expression to become the given one.expression - The new encapsulated Expression, which cannot be nulljava.lang.NullPointerException - The given AbstractExpression cannot be nullprotected void toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer,
boolean actual)
Expression.toParsedTextEncapsulatedExpression in class AbstractEncapsulatedExpressionwriter - 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 assist