java.lang.Object
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
- - org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression
  - - org.eclipse.persistence.jpa.jpql.parser.AbstractTripleEncapsulatedExpression

All Implemented Interfaces:

Expression

Direct Known Subclasses:

LocateExpression, SubstringExpression
```
public abstract class AbstractTripleEncapsulatedExpression
extends AbstractEncapsulatedExpression
```
This Expression takes care of parsing an expression that encapsulates three expressions separated by a comma.
BNF: expression ::= <identifier>(first_expression, second_expression, third_expression)

Since:

2.3

Version:

2.5.1

Author:

Pascal Filion

See Also:

LocateExpression, SubstringExpression

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
- Fields inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression
  ABS, ALL, AND, ANY, AS, AS_OF, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXTRACT, FALSE, FETCH, FIRST, FROM, FUNC, FUNCTION, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, INTERSECT, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, LAST, LEADING, LEFT, LEFT_JOIN, LEFT_JOIN_FETCH, LEFT_OUTER_JOIN, LEFT_OUTER_JOIN_FETCH, LENGTH, LIKE, LOCATE, LOWER, LOWER_THAN, LOWER_THAN_OR_EQUAL, MAX, MEMBER, MEMBER_OF, MIN, MINUS, MOD, MULTIPLICATION, NAMED_PARAMETER, NEW, NOT, NOT_BETWEEN, NOT_EQUAL, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, NULLS, NULLS_FIRST, NULLS_LAST, OBJECT, OF, ON, OPERATOR, OR, ORDER_BY, ORDER_SIBLINGS_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, REGEXP, SCN, SELECT, SET, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`acceptChildren(ExpressionVisitor visitor)`	Visits the children of this `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 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.

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression
getActualIdentifier, getIdentifier, hasLeftParenthesis, hasRightParenthesis, hasSpaceAfterIdentifier

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
children, getGrammar, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, isAncestor, orderedChildren, populatePosition, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression
accept, getQueryBNF

- Method Detail
  - acceptChildren
```
public void acceptChildren(ExpressionVisitor visitor)
```
    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 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.
    
    Parameters:
    
    visitor - The visitor to visit the children of this object.
  - buildCollectionExpression
```
public final CollectionExpression buildCollectionExpression()
```
    Creates a new CollectionExpression that will wrap the first, second and third expressions.
    
    Returns:
    
    The first, second and third expressions represented by a temporary collection
  - findQueryBNF
```
public JPQLQueryBNF findQueryBNF(Expression expression)
```
    Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.
    
    Specified by:
    
    findQueryBNF in interface Expression
    
    Overrides:
    
    findQueryBNF in class AbstractExpression
    
    Parameters:
    
    expression - The Expression that is a descendant of this one
    
    Returns:
    
    The JPQLQueryBNF that was used to parse the given expression
  - getFirstExpression
```
public final Expression getFirstExpression()
```
    Returns the Expression that represents the first expression.
    
    Returns:
    
    The expression that was parsed representing the first expression
  - getParameterQueryBNFId
```
public abstract 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.
    
    Parameters:
    
    index - The position of the encapsulated Expression that needs to be parsed within the parenthesis, which starts at position 0
    
    Returns:
    
    The ID of the JPQLQueryBNF to be used to parse one of the encapsulated expression
  - getSecondExpression
```
public final Expression getSecondExpression()
```
    Returns the Expression that represents the second expression.
    
    Returns:
    
    The expression that was parsed representing the second expression
  - getThirdExpression
```
public final Expression getThirdExpression()
```
    Returns the Expression that represents the first expression.
    
    Returns:
    
    The expression that was parsed representing the first expression
  - hasEncapsulatedExpression
```
public boolean hasEncapsulatedExpression()
```
    Determines whether something was parsed after the left parenthesis.
    
    Specified by:
    
    hasEncapsulatedExpression in class AbstractEncapsulatedExpression
    
    Returns:
    
    true if something was parsed; false otherwise
  - hasFirstComma
```
public final boolean hasFirstComma()
```
    Determines whether the comma was parsed after the first expression.
    
    Returns:
    
    true if a comma was parsed after the first expression; false otherwise
  - hasFirstExpression
```
public final boolean hasFirstExpression()
```
    Determines whether the first expression of the query was parsed.
    
    Returns:
    
    true if the first expression was parsed; false if it was not parsed
  - hasSecondComma
```
public final boolean hasSecondComma()
```
    Determines whether the comma was parsed after the second expression.
    
    Returns:
    
    true if a comma was parsed after the second expression; false otherwise
  - hasSecondExpression
```
public final boolean hasSecondExpression()
```
    Determines whether the second expression of the query was parsed.
    
    Returns:
    
    true if the second expression was parsed; false if it was not parsed
  - hasSpaceAfterFirstComma
```
public final boolean hasSpaceAfterFirstComma()
```
    Determines whether a whitespace was parsed after the first comma.
    
    Returns:
    
    true if there was a whitespace after the first comma; false otherwise
  - hasSpaceAfterSecondComma
```
public final boolean hasSpaceAfterSecondComma()
```
    Determines whether a whitespace was parsed after the second comma.
    
    Returns:
    
    true if there was a whitespace after the second comma; false otherwise
  - hasThirdExpression
```
public final boolean hasThirdExpression()
```
    Determines whether the third expression of the query was parsed.
    
    Returns:
    
    true if the third expression was parsed; false if it was not parsed

Class AbstractTripleEncapsulatedExpression

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

Fields inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression

Method Summary

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression

Method Detail

acceptChildren

buildCollectionExpression

findQueryBNF

getFirstExpression

getParameterQueryBNFId

getSecondExpression

getThirdExpression

hasEncapsulatedExpression

hasFirstComma

hasFirstExpression

hasSecondComma

hasSecondExpression

hasSpaceAfterFirstComma

hasSpaceAfterSecondComma

hasThirdExpression