|
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.WhenClause
public final class WhenClause
A WHEN predicate is used to calculate a condition and when it's true, its THEN will be executed.
when_clause ::= WHEN conditional_expression THEN scalar_expression
or
simple_when_clause ::= WHEN scalar_expression THEN scalar_expression
Field Summary | |
---|---|
private boolean |
hasSpaceAfterThen Determines whether a whitespace was parsed after the identifier THEN. |
private boolean |
hasSpaceAfterWhen Determines whether a whitespace was parsed after the identifier WHEN. |
private boolean |
hasSpaceAfterWhenExpression Determines whether a whitespace was parsed after the conditional expression. |
private boolean |
hasThen Determines whether the identifier THEN was parsed. |
private AbstractExpression |
thenExpression The Expression representing the expression following the identifier THEN. |
private AbstractExpression |
whenExpression The Expression representing the conditional predicate of the clause. |
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 | |
---|---|
WhenClause(AbstractExpression parent) Creates a new WhenClause . |
Method Summary | |
---|---|
void |
accept(ExpressionVisitor visitor) Visits this Expression by the given visitor . |
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 |
addOrderedChildrenTo(java.util.List<StringExpression> children) Adds the StringExpressions representing this Expression . |
JPQLQueryBNF |
getQueryBNF() Returns the BNF of this Expression . |
AbstractExpression |
getThenExpression() Returns the Expression representing the expression following the identifier THEN. |
AbstractExpression |
getWhenExpression() Returns the Expression representing the conditional predicate of the clause. |
boolean |
hasSpaceAfterThen() Determines whether a whitespace was parsed after THEN. |
boolean |
hasSpaceAfterWhen() Determines whether a whitespace was parsed after WHEN. |
boolean |
hasSpaceAfterWhenExpression() Determines whether a whitespace was parsed after the conditional expression. |
boolean |
hasThen() Determines whether the identifier THEN was part of the query. |
boolean |
hasThenExpression() Determines whether the THEN expression of the query was parsed. |
boolean |
hasWhenExpression() Determines whether the conditional expression of the query was parsed. |
(package private) boolean |
isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression) Determines whether the parsing is complete based on what is left in the given text. |
(package private) void |
parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser . |
(package private) void |
toParsedText(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of this Expression . |
Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression |
---|
buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, 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 |
Field Detail |
---|
private boolean hasSpaceAfterThen
private boolean hasSpaceAfterWhen
private boolean hasSpaceAfterWhenExpression
private boolean hasThen
private AbstractExpression thenExpression
Expression
representing the expression following the identifier THEN.private AbstractExpression whenExpression
Expression
representing the conditional predicate of the clause.Constructor Detail |
---|
WhenClause(AbstractExpression parent)
WhenClause
.
parent
- The parent of this expressionMethod Detail |
---|
public void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.visitor
- The visitor
to visit this objectpublic 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 addOrderedChildrenTo(java.util.List<StringExpression> children)
StringExpressions
representing this Expression
.addOrderedChildrenTo
in class AbstractExpression
children
- The list used to store the string representation of this Expression
public JPQLQueryBNF getQueryBNF()
Expression
.getQueryBNF
in class AbstractExpression
JPQLQueryBNF
, which represents the grammar of this Expression
public AbstractExpression getThenExpression()
Expression
representing the expression following the identifier THEN.public AbstractExpression getWhenExpression()
Expression
representing the conditional predicate of the clause.public boolean hasSpaceAfterThen()
true
if there was a whitespace after THEN; false
otherwisepublic boolean hasSpaceAfterWhen()
true
if there was a whitespace after WHEN; false
otherwisepublic boolean hasSpaceAfterWhenExpression()
true
if there was a whitespace after the conditional expression; false
otherwisepublic boolean hasThen()
true
if the identifier THEN was parsed; false
otherwisepublic boolean hasThenExpression()
true
the THEN expression was parsed; false
if nothing was parsedpublic boolean hasWhenExpression()
true
the conditional expression was parsed; false
if nothing was parsedboolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
isParsingComplete
in class AbstractExpression
wordParser
- 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 parsedvoid 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 queriesvoid toParsedText(java.lang.StringBuilder writer, boolean includeVirtual)
Expression
.toParsedText
in class AbstractExpression
writer
- The buffer used to append this 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 |