|
EclipseLink 2.5.0, build 'v20130507-3faac2b' 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.AbstractEncapsulatedExpression
org.eclipse.persistence.jpa.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 | |
|---|---|
protected int |
parameterIndex
Determines which child expression is been currently parsed. |
| 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 |
AbstractTripleEncapsulatedExpression(AbstractExpression parent,
java.lang.String identifier)
Creates a new AbstractTripleEncapsulatedExpression. |
| 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 |
addOrderedEncapsulatedExpressionTo(java.util.List<Expression> children)
Adds the Expressions representing the encapsulated Expression. |
CollectionExpression |
buildCollectionExpression()
Creates a new CollectionExpression that will wrap the first, second and third
expressions. |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression. |
Expression |
getFirstExpression()
Returns the Expression that represents the first expression. |
abstract java.lang.String |
getParameterQueryBNFId(int index)
Returns the unique identifier of the JPQLQueryBNF to be used to parse one of the
encapsulated expression at the given position. |
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. |
protected 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. |
protected abstract boolean |
isThirdExpressionOptional()
Determines whether the third expression is an optional expression, which means a valid query can have it or not. |
protected void |
parseEncapsulatedExpression(WordParser wordParser,
int whitespaceCount,
boolean tolerant)
Parses the encapsulated expression by starting at the current position, which is part of the given WordParser. |
protected void |
removeEncapsulatedExpression()
Removes the encapsulated Expression that was parsed, it should not be part of this one. |
protected void |
toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer,
boolean actual)
Generates a string representation of the encapsulated Expression. |
| Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression |
|---|
addOrderedChildrenTo, areLogicalIdentifiersSupported, getActualIdentifier, getIdentifier, hasLeftParenthesis, hasRightParenthesis, hasSpaceAfterIdentifier, parse, shouldParseRightParenthesis, toParsedText |
| 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 |
| Field Detail |
|---|
protected int parameterIndex
| Constructor Detail |
|---|
protected AbstractTripleEncapsulatedExpression(AbstractExpression parent, java.lang.String identifier)
AbstractTripleEncapsulatedExpression.
parent - The parent of this expressionidentifier - The JPQL identifier that starts this expression| Method 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 void addChildrenTo(java.util.Collection<Expression> children)
AbstractExpression to the given collection.
addChildrenTo in class AbstractExpressionchildren - The collection used to store the childrenprotected void addOrderedEncapsulatedExpressionTo(java.util.List<Expression> children)
Expressions representing the encapsulated Expression.
addOrderedEncapsulatedExpressionTo in class AbstractEncapsulatedExpressionchildren - The list used to store the string representation of the encapsulated Expressionpublic final CollectionExpression buildCollectionExpression()
CollectionExpression that will wrap the first, second and third
expressions.
public JPQLQueryBNF findQueryBNF(Expression expression)
JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression.
findQueryBNF in interface ExpressionfindQueryBNF in class AbstractExpressionexpression - The Expression that is a descendant of this one
JPQLQueryBNF that was used to parse the given expressionpublic final Expression getFirstExpression()
Expression that represents the first expression.
public abstract java.lang.String getParameterQueryBNFId(int index)
JPQLQueryBNF to be used to parse one of the
encapsulated expression at the given position.
index - The position of the encapsulated Expression that needs to be parsed
within the parenthesis, which starts at position 0
JPQLQueryBNF to be used to parse one of the encapsulated expressionpublic 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 AbstractEncapsulatedExpressiontrue 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
parsedprotected boolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
isParsingComplete in class AbstractEncapsulatedExpressionwordParser - 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 parsed
true if the text no longer can't be parsed by the current expression;
false if more can be parsedprotected abstract boolean isThirdExpressionOptional()
true if the third expression can either be present or not in a valid
query; false if it's mandatoryprotected void parseEncapsulatedExpression(WordParser wordParser, int whitespaceCount, boolean tolerant)
WordParser.
parseEncapsulatedExpression in class AbstractEncapsulatedExpressionwordParser - The text to parse based on the current position of the cursorwhitespaceCount - The number of whitespace characters that were parsed after '('tolerant - Determines whether the parsing system should be tolerant, meaning if it should
try to parse invalid or incomplete queriesprotected void removeEncapsulatedExpression()
Expression that was parsed, it should not be part of this one.
This happens when the parsed information does not have both '(' and ')'.
removeEncapsulatedExpression in class AbstractEncapsulatedExpression
protected final void toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer,
boolean actual)
Expression.
toParsedTextEncapsulatedExpression in class AbstractEncapsulatedExpressionwriter - The buffer used to append the encapsulated Expression's string
representationactual - 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
|
EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||