|
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.AbstractSingleEncapsulatedExpression
public abstract class AbstractSingleEncapsulatedExpression
This expression handles parsing a JPQL identifier followed by an expression encapsulated within parenthesis.
expression ::= <identifier>(expression)
Field Summary | |
---|---|
private AbstractExpression |
expression The sub-expression encapsulated within parenthesis. |
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 | |
---|---|
AbstractSingleEncapsulatedExpression(AbstractExpression parent) Creates a new EncapsulatedExpression . |
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 . |
abstract java.lang.String |
encapsulatedExpressionBNF() 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. |
(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 |
setExpression(AbstractExpression expression) Sets |
(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 expression
Constructor Detail |
---|
AbstractSingleEncapsulatedExpression(AbstractExpression parent)
EncapsulatedExpression
.
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.final 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 abstract java.lang.String encapsulatedExpressionBNF()
public final Expression getExpression()
Expression
that is encapsulated within parenthesis.Expression
that is encapsulated within parenthesispublic boolean hasEncapsulatedExpression()
hasEncapsulatedExpression
in class AbstractEncapsulatedExpression
true
if something was parsed; false
otherwisepublic final boolean hasExpression()
true
if the encapsulated expression was parsed; false
if it was not parsedvoid 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 setExpression(AbstractExpression expression)
expression
-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 |