Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.parser

public abstract Class AbstractConditionalClause

extends AbstractExpression
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.jpa.jpql.parser.HavingClause, org.eclipse.persistence.jpa.jpql.parser.OnClause, org.eclipse.persistence.jpa.jpql.parser.StartWithClause, org.eclipse.persistence.jpa.jpql.parser.WhereClause
Imports
java.util.ArrayList, .Collection, .List, org.eclipse.persistence.jpa.jpql.WordParser
Conditional expressions are composed of other conditional expressions, comparison operations, logical operations, path expressions that evaluate to boolean values, boolean literals, and boolean input parameters. Arithmetic expressions can be used in comparison expressions. Arithmetic expressions are composed of other arithmetic expressions, arithmetic operations, path expressions that evaluate to numeric values, numeric literals, and numeric input parameters. Arithmetic operations use numeric promotion. Standard bracketing () for ordering expression evaluation is supported.
BNF: expression ::= identifier conditional_expression
Author
Pascal Filion
Since
2.3
Version
2.5
See Also
HavingClause, OnClause, StartWithClause, WhereClause

Field Summary

Modifier and TypeField and Description
private AbstractExpression
conditionalExpression

The expression representing the composition of the conditional expressions.

private boolean
hasSpaceAfterIdentifier

Determines whether a whitespace was parsed after the identifier.

private String
identifier

The actual identifier found in the string representation of the JPQL query.

Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression:
COMMADOTDOUBLE_QUOTELEFT_CURLY_BRACKETLEFT_PARENTHESISNOT_DEFINEDRIGHT_CURLY_BRACKETRIGHT_PARENTHESISSINGLE_QUOTESPACEUNDERSCORE

Constructor Summary

AccessConstructor and Description
protected
AbstractConditionalClause(AbstractExpression
The parent of this expression
parent, String
The identifier of this conditional clause
identifier)

Creates a new AbstractConditionalClause.

Method Summary

Modifier and TypeMethod and Description
public void
acceptChildren(ExpressionVisitor
The visitor to visit the children of this object.
visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Visits the children of this Expression.
protected final void
addChildrenTo(Collection<Expression>
The collection used to store the children
children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Adds the children of this AbstractExpression to the given collection.
protected final void
addOrderedChildrenTo(List<Expression>
The list used to store the string representation of this AbstractExpression
children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Adds the children of this AbstractExpression to the given list.
public CollectionExpression

Returns:

The single select item represented by a temporary collection
buildCollectionExpression()

Creates a new CollectionExpression that will wrap the single select item.

public JPQLQueryBNF
findQueryBNF(Expression
The Expression that is a descendant of this one
expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.findQueryBNF.

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.
public final String

Returns:

The identifier that was actually parsed
getActualIdentifier()

Returns the actual identifier found in the string representation of the JPQL query, which has the actual case that was used.

public final Expression

Returns:

The actual conditional expression
getConditionalExpression()

Returns the expression representing the composition of the conditional expressions.

public final String

Returns:

The JPQL identifier
getIdentifier()

Returns the JPQL identifier of this expression.

public final boolean

Returns:

true if there is a conditional expression; false otherwise
hasConditionalExpression()

Determines whether the conditional expression was parsed.

public final boolean

Returns:

true if there was a whitespace after the identifier; false otherwise
hasSpaceAfterIdentifier()

Determines whether a whitespace was parsed after the identifier or not.

protected boolean
isParsingComplete(WordParser
The text to parse based on the current position of the cursor
wordParser, String
The word that was retrieved from the given text, which is the first word in the text
word, Expression
The Expression that has already been parsed
expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.isParsingComplete.

Determines whether the parsing is complete based on what is left in the given text.
protected final void
parse(WordParser
The text to parse based on the current position of the cursor
wordParser, boolean
Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Parses the query by starting at the current position, which is part of the given WordParser.
protected boolean
shouldSkipLiteral(AbstractExpression
The Expression that has just been parsed or null
expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.shouldSkipLiteral.

When parsing an invalid or incomplete query, it is possible two literals would be parsed but in some cases, a CollectionExpression should not be created and the parsing should actually stop here.
protected final void
toParsedText(StringBuilder
The buffer used to append this Expression's string representation
writer, boolean
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
actual)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Generates a string representation of this Expression, including its children, if it has any.
Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression:
acceptUnknownVisitoracceptUnknownVisitorbuildExpressionFromFallingBackbuildNullExpressionbuildStringExpressionbuildStringExpressionbuildUnknownExpressioncalculatePositionchildrenfindFallBackExpressionFactorygetExpressionFactorygetExpressionRegistrygetGrammargetIdentifierVersiongetJPAVersiongetLengthgetOffsetgetParentgetQueryBNFgetRootgetTexthandleAggregatehandleCollectionisAncestorisIdentifierisNullisTolerantisUnknownisVirtualorderedChildrenparseparseUsingExpressionFactorypopulatePositionrebuildActualTextrebuildParsedTextsetParentsetTextshouldParseWithFactoryFirsttoActualTexttoParsedTexttoString

Field Detail

conditionalExpressionback to summary
private AbstractExpression conditionalExpression

The expression representing the composition of the conditional expressions.

hasSpaceAfterIdentifierback to summary
private boolean hasSpaceAfterIdentifier

Determines whether a whitespace was parsed after the identifier.

identifierback to summary
private String identifier

The actual identifier found in the string representation of the JPQL query.

Constructor Detail

AbstractConditionalClauseback to summary
protected AbstractConditionalClause(AbstractExpression parent, String identifier)

Creates a new AbstractConditionalClause.

Parameters
parent:AbstractExpression

The parent of this expression

identifier:String

The identifier of this conditional clause

Method Detail

acceptChildrenback to summary
public void acceptChildren(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Visits the children of this Expression. This method can be used to optimize traversing the children since a new list is not created every time children() is called.

This does not traverse the Expression sub-hierarchy, use a subclass of AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.

Parameters
visitor:ExpressionVisitor

The visitor to visit the children of this object.

Annotations
@Override
addChildrenToback to summary
protected final void addChildrenTo(Collection<Expression> children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Adds the children of this AbstractExpression to the given collection.

Parameters
children:Collection<Expression>

The collection used to store the children

Annotations
@Override
addOrderedChildrenToback to summary
protected final void addOrderedChildrenTo(List<Expression> children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Adds the children of this AbstractExpression to the given list.

Parameters
children:List<Expression>

The list used to store the string representation of this AbstractExpression

Annotations
@Override
buildCollectionExpressionback to summary
public CollectionExpression buildCollectionExpression()

Creates a new CollectionExpression that will wrap the single select item.

Returns:CollectionExpression

The single select item represented by a temporary collection

findQueryBNFback to summary
public JPQLQueryBNF findQueryBNF(Expression expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.findQueryBNF.

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.

Parameters
expression:Expression

The Expression that is a descendant of this one

Returns:JPQLQueryBNF

The JPQLQueryBNF that was used to parse the given expression

Annotations
@Override
getActualIdentifierback to summary
public final String getActualIdentifier()

Returns the actual identifier found in the string representation of the JPQL query, which has the actual case that was used.

Returns:String

The identifier that was actually parsed

getConditionalExpressionback to summary
public final Expression getConditionalExpression()

Returns the expression representing the composition of the conditional expressions.

Returns:Expression

The actual conditional expression

getIdentifierback to summary
public final String getIdentifier()

Returns the JPQL identifier of this expression.

Returns:String

The JPQL identifier

hasConditionalExpressionback to summary
public final boolean hasConditionalExpression()

Determines whether the conditional expression was parsed.

Returns:boolean

true if there is a conditional expression; false otherwise

hasSpaceAfterIdentifierback to summary
public final boolean hasSpaceAfterIdentifier()

Determines whether a whitespace was parsed after the identifier or not.

Returns:boolean

true if there was a whitespace after the identifier; false otherwise

isParsingCompleteback to summary
protected boolean isParsingComplete(WordParser wordParser, String word, Expression expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.isParsingComplete.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.isParsingComplete.

Determines whether the parsing is complete based on what is left in the given text. The text is never empty.

Parameters
wordParser:WordParser

The text to parse based on the current position of the cursor

word:String

The word that was retrieved from the given text, which is the first word in the text

expression:Expression

The Expression that has already been parsed

Returns:boolean

true if the text no longer can't be parsed by the current expression; false if more can be parsed

Annotations
@Override
parseback to summary
protected final void parse(WordParser wordParser, boolean tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Parses the query by starting at the current position, which is part of the given WordParser.

Parameters
wordParser:WordParser

The text to parse based on the current position of the cursor

tolerant:boolean

Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

Annotations
@Override
shouldSkipLiteralback to summary
protected boolean shouldSkipLiteral(AbstractExpression expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.shouldSkipLiteral.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.shouldSkipLiteral.

When parsing an invalid or incomplete query, it is possible two literals would be parsed but in some cases, a CollectionExpression should not be created and the parsing should actually stop here. Example: BETWEEN 10 20, when parsing 20, it should not be parsed as part of the lower bound expression.

Parameters
expression:AbstractExpression

The Expression that has just been parsed or null

Returns:boolean

true

Annotations
@Override
toParsedTextback to summary
protected final void toParsedText(StringBuilder writer, boolean actual)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Generates a string representation of this Expression, including its children, if it has any.

Parameters
writer:StringBuilder

The buffer used to append this Expression's string representation

actual:boolean

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

Annotations
@Override