|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.CompoundExpression
public abstract class CompoundExpression
A compound expression has a left and right expressions combined by an identifier.
expression ::= left_expression identifier right_expression
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 |
Constructor Summary | |
---|---|
protected |
CompoundExpression(AbstractExpression parent,
java.lang.String identifier)
Creates a new CompoundExpression . |
Method Summary | |
---|---|
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 |
addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of this AbstractExpression to the given list. |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression . |
java.lang.String |
getActualIdentifier()
Returns the actual identifier found in the string representation of the JPQL query, which has the actual case that was used. |
java.lang.String |
getIdentifier()
Returns the JPQL identifier of this expression. |
Expression |
getLeftExpression()
Returns the Expression that represents the first expression, which is before the
identifier. |
Expression |
getRightExpression()
Returns the Expression that represents the second expression, which is after the
identifier. |
boolean |
hasLeftExpression()
Determines whether the first expression of the query was parsed. |
boolean |
hasRightExpression()
Determines whether the second expression of the query was parsed. |
boolean |
hasSpaceAfterIdentifier()
Determines whether a whitespace was parsed after the identifier. |
abstract java.lang.String |
leftExpressionBNF()
Returns the unique identifier of the JPQLQueryBNF for the right expression. |
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 java.lang.String |
parseIdentifier(WordParser wordParser)
Parses the identifier of this expression. |
abstract java.lang.String |
rightExpressionBNF()
Returns the unique identifier of the JPQLQueryBNF used to determine how to parse the
right expression. |
protected void |
setLeftExpression(AbstractExpression leftExpression)
Sets the given Expression to be the first expression of this compound one. |
protected void |
setRightExpression(AbstractExpression rightExpression)
Sets the given Expression to be the second expression of this compound one. |
protected void |
toParsedText(java.lang.StringBuilder writer,
boolean actual)
Generates a string representation of this Expression , including its children,
if it has any. |
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 Detail |
---|
protected CompoundExpression(AbstractExpression parent, java.lang.String identifier)
CompoundExpression
.
parent
- The parent of this expressionidentifier
- The identifier 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()
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 AbstractExpression
children
- The collection used to store the childrenprotected final void addOrderedChildrenTo(java.util.List<Expression> children)
AbstractExpression
to the given list.
addOrderedChildrenTo
in class AbstractExpression
children
- The list used to store the string representation of this AbstractExpression
public JPQLQueryBNF findQueryBNF(Expression expression)
JPQLQueryBNF
that represents the fragment of this Expression
that was used when parsing the given Expression
.
findQueryBNF
in interface Expression
findQueryBNF
in class AbstractExpression
expression
- The Expression
that is a descendant of this one
JPQLQueryBNF
that was used to parse the given expressionpublic final java.lang.String getActualIdentifier()
public java.lang.String getIdentifier()
public final Expression getLeftExpression()
Expression
that represents the first expression, which is before the
identifier.
public final Expression getRightExpression()
Expression
that represents the second expression, which is after the
identifier.
public final boolean hasLeftExpression()
true
if the first expression was parsed; false
if it was
not parsedpublic final boolean hasRightExpression()
true
if the second expression was parsed; false
if it was
not parsedpublic final boolean hasSpaceAfterIdentifier()
true
if there was a whitespace after the identifier; false
otherwisepublic abstract java.lang.String leftExpressionBNF()
JPQLQueryBNF
for the right expression.
protected final void parse(WordParser wordParser, boolean tolerant)
WordParser
.
parse
in class AbstractExpression
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 queriesprotected abstract java.lang.String parseIdentifier(WordParser wordParser)
text
- The text to parse, which starts with the identifier
public abstract java.lang.String rightExpressionBNF()
JPQLQueryBNF
used to determine how to parse the
right expression.
protected final void setLeftExpression(AbstractExpression leftExpression)
Expression
to be the first expression of this compound one.
leftExpression
- The expression that was parsed before the identifierprotected final void setRightExpression(AbstractExpression rightExpression)
Expression
to be the second expression of this compound one.
rightExpression
- The expression that was parsed after the identifierprotected final void toParsedText(java.lang.StringBuilder writer, boolean actual)
Expression
, including its children,
if it has any.
toParsedText
in class AbstractExpression
writer
- 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 identifiers
|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |