|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) E28847-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.AbstractTripleEncapsulatedExpression
public abstract class AbstractTripleEncapsulatedExpression
This Expression
takes care of parsing an expression that encapsulates three expressions separated by a comma.
expression ::= <identifier>(first_expression, second_expression, third_expression)
LocateExpression
, SubstringExpression
Field Summary | |
---|---|
private AbstractExpression |
firstExpression The Expression that represents the first expression. |
private boolean |
hasFirstComma Determines whether the comma separating the first and second expression was parsed. |
private boolean |
hasSecondComma Determines whether the comma separating the first and second expression was parsed. |
private boolean |
hasSpaceAfterFirstComma Determines whether a whitespace is following the comma. |
private boolean |
hasSpaceAfterSecondComma Determines whether a whitespace is following the comma. |
private AbstractExpression |
secondExpression The Expression that represents the second expression. |
private AbstractExpression |
thirdExpression The Expression that represents the first expression. |
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 |
Constructor Summary | |
---|---|
AbstractTripleEncapsulatedExpression(AbstractExpression parent) Creates a new AbstractTripleEncapsulatedExpression . |
Method Summary | |
---|---|
void |
acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression . |
(package private) void |
addChildrenTo(java.util.Collection<Expression> children) Adds the children of this Expression to the given collection. |
(package private) void |
addOrderedEncapsulatedExpressionTo(java.util.List<StringExpression> children) Adds the StringExpressions representing the encapsulated Expression . |
CollectionExpression |
buildCollectionExpression() Creates a new CollectionExpression that will wrap the first, second and third expressions. |
Expression |
getFirstExpression() Returns the Expression that represents the first expression. |
Expression |
getSecondExpression() Returns the Expression that represents the second expression. |
Expression |
getThirdExpression() Returns the Expression that represents the first expression. |
boolean |
hasEncapsulatedExpression() Determines whether something was parsed after the left parenthesis. |
boolean |
hasFirstComma() Determines whether the comma was parsed after the first expression. |
boolean |
hasFirstExpression() Determines whether the first expression of the query was parsed. |
boolean |
hasSecondComma() Determines whether the comma was parsed after the second expression. |
boolean |
hasSecondExpression() Determines whether the second expression of the query was parsed. |
boolean |
hasSpaceAfterFirstComma() Determines whether a whitespace was parsed after the first comma. |
boolean |
hasSpaceAfterSecondComma() Determines whether a whitespace was parsed after the second comma. |
boolean |
hasThirdExpression() Determines whether the third expression of the query was parsed. |
(package private) abstract boolean |
isThirdExpressionOptional() Determines whether the third expression is an optional expression, which means a valid query can have it or not. |
abstract JPQLQueryBNF |
parameterExpressionBNF(int index) Returns the BNF to be used to parse one of the encapsulated expression. |
(package private) void |
parseEncapsulatedExpression(WordParser wordParser, boolean tolerant) Parses the encapsulated expression by starting at the current position, which is part of the given WordParser . |
(package private) void |
toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of the encapsulated Expression . |
Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractEncapsulatedExpression |
---|
addOrderedChildrenTo, areLogicalIdentifiersSupported, getIdentifier, hasLeftParenthesis, hasRightParenthesis, isParsingComplete, parse, parseIdentifier, toParsedText |
Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression |
---|
buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, getQueryBNF, 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 |
Methods inherited from interface org.eclipse.persistence.jpa.internal.jpql.parser.Expression |
---|
accept |
Field Detail |
---|
private AbstractExpression firstExpression
Expression
that represents the first expression.private boolean hasFirstComma
private boolean hasSecondComma
private boolean hasSpaceAfterFirstComma
private boolean hasSpaceAfterSecondComma
private AbstractExpression secondExpression
Expression
that represents the second expression.private AbstractExpression thirdExpression
Expression
that represents the first expression.Constructor Detail |
---|
AbstractTripleEncapsulatedExpression(AbstractExpression parent)
AbstractTripleEncapsulatedExpression
.
parent
- The parent of this expressionMethod Detail |
---|
public 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()
or Expression.getChildren()
is called.
This does not traverse the Expression
sub-hierarchy, use an subclass of AbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.
visitor
- The visitor
to visit the children of this object.void addChildrenTo(java.util.Collection<Expression> children)
Expression
to the given collection.addChildrenTo
in class AbstractExpression
children
- The collection used to store the childrenvoid addOrderedEncapsulatedExpressionTo(java.util.List<StringExpression> children)
StringExpressions
representing the encapsulated Expression
.addOrderedEncapsulatedExpressionTo
in class AbstractEncapsulatedExpression
children
- The list used to store the string representation of the encapsulated Expression
public final CollectionExpression buildCollectionExpression()
CollectionExpression
that will wrap the first, second and third expressions.public final Expression getFirstExpression()
Expression
that represents the first expression.public final Expression getSecondExpression()
Expression
that represents the second expression.public final Expression getThirdExpression()
Expression
that represents the first expression.public boolean hasEncapsulatedExpression()
hasEncapsulatedExpression
in class AbstractEncapsulatedExpression
true
if something was parsed; false
otherwisepublic final boolean hasFirstComma()
true
if a comma was parsed after the first expression; false
otherwisepublic final boolean hasFirstExpression()
true
if the first expression was parsed; false
if it was not parsedpublic final boolean hasSecondComma()
true
if a comma was parsed after the second expression; false
otherwisepublic final boolean hasSecondExpression()
true
if the second expression was parsed; false
if it was not parsedpublic final boolean hasSpaceAfterFirstComma()
true
if there was a whitespace after the first comma; false
otherwisepublic final boolean hasSpaceAfterSecondComma()
true
if there was a whitespace after the second comma; false
otherwisepublic final boolean hasThirdExpression()
true
if the third expression was parsed; false
if it was not parsedabstract boolean isThirdExpressionOptional()
true
if the third expression can either be present or not in a valid query; false
if it's mandatorypublic abstract JPQLQueryBNF parameterExpressionBNF(int index)
index
- The position of the encapsulated Expression
that needs to be parsed within the parenthesisvoid parseEncapsulatedExpression(WordParser wordParser, boolean tolerant)
WordParser
.parseEncapsulatedExpression
in class AbstractEncapsulatedExpression
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 queriesfinal void toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer, boolean includeVirtual)
Expression
.toParsedTextEncapsulatedExpression
in class AbstractEncapsulatedExpression
writer
- The buffer used to append the encapsulated Expression
's string representationincludeVirtual
- 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
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |