Class TreatExpression
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression
-
- org.eclipse.persistence.jpa.jpql.parser.TreatExpression
-
- All Implemented Interfaces:
Expression
public final class TreatExpression extends AbstractEncapsulatedExpression
Returns an expression that allows to treat its base as if it were a subclass of the class returned by the base.New to EclipseLink 2.1.
BNF:join_treat ::= TREAT(collection_valued_path_expression AS entity_type_literal)
Example:
SELECT e FROM Employee e JOIN TREAT(e.projects AS LargeProject) lp WHERE lp.budget = value
- Since:
- 2.3
- Version:
- 2.5.1
- Author:
- Pascal Filion
-
-
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
-
-
Constructor Summary
Constructors Constructor Description TreatExpression(AbstractExpression parent)
Creates a newTreatExpression
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(ExpressionVisitor visitor)
Visits thisExpression
by the givenvisitor
.void
acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression
.JPQLQueryBNF
findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.String
getActualAsIdentifier()
Returns the actual AS identifier found in the string representation of the JPQL query, which has the actual case that was used.Expression
getCollectionValuedPathExpression()
Returns theExpression
that represents the collection-valued path expression.Expression
getEntityType()
Returns theExpression
that represents the entity type that will be used to downcast the type of the elements in the collection.JPQLQueryBNF
getQueryBNF()
Returns the BNF of thisExpression
.boolean
hasAs()
Determines whether the identifier AS was parsed.boolean
hasCollectionValuedPathExpression()
Determines whether the collection-valued path expression of the query was parsed.boolean
hasEncapsulatedExpression()
Determines whether something was parsed after the left parenthesis.boolean
hasEntityType()
Determines whether the entity type was parsed.boolean
hasSpaceAfterAs()
Determines whether a whitespace was parsed after AS.boolean
hasSpaceAfterCollectionValuedPathExpression()
Determines whether a whitespace was parsed after the collection-valued path expression.-
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
-
-
-
-
Constructor Detail
-
TreatExpression
public TreatExpression(AbstractExpression parent)
Creates a newTreatExpression
.- Parameters:
parent
- The parent of this expression
-
-
Method Detail
-
accept
public void accept(ExpressionVisitor visitor)
Visits thisExpression
by the givenvisitor
.- Parameters:
visitor
- TheExpressionVisitor
to visit this object
-
acceptChildren
public void acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression
. This method can be used to optimize traversing the children since a new list is not created every timeExpression.children()
is called.This does not traverse the
Expression
sub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.- Parameters:
visitor
- Thevisitor
to visit the children of this object.
-
findQueryBNF
public final JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.- Specified by:
findQueryBNF
in interfaceExpression
- Overrides:
findQueryBNF
in classAbstractExpression
- Parameters:
expression
- TheExpression
that is a descendant of this one- Returns:
- The
JPQLQueryBNF
that was used to parse the given expression
-
getActualAsIdentifier
public String getActualAsIdentifier()
Returns the actual AS identifier found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The AS identifier that was actually parsed, or an empty string if it was not parsed
-
getCollectionValuedPathExpression
public Expression getCollectionValuedPathExpression()
Returns theExpression
that represents the collection-valued path expression.- Returns:
- The expression that represents the collection-valued path expression
-
getEntityType
public Expression getEntityType()
Returns theExpression
that represents the entity type that will be used to downcast the type of the elements in the collection.- Returns:
- The expression representing the entity type
-
getQueryBNF
public JPQLQueryBNF getQueryBNF()
Returns the BNF of thisExpression
.- Returns:
- The
JPQLQueryBNF
, which represents the grammar of thisExpression
-
hasAs
public boolean hasAs()
Determines whether the identifier AS was parsed.- Returns:
true
if the identifier AS was parsed;false
otherwise
-
hasCollectionValuedPathExpression
public boolean hasCollectionValuedPathExpression()
Determines whether the collection-valued path expression of the query was parsed.- Returns:
true
if the collection-valued path expression was parsed;false
if nothing was parsed
-
hasEncapsulatedExpression
public boolean hasEncapsulatedExpression()
Determines whether something was parsed after the left parenthesis.- Specified by:
hasEncapsulatedExpression
in classAbstractEncapsulatedExpression
- Returns:
true
if something was parsed;false
otherwise
-
hasEntityType
public boolean hasEntityType()
Determines whether the entity type was parsed.- Returns:
true
if the entity type was parsed;false
if nothing was parsed
-
hasSpaceAfterAs
public boolean hasSpaceAfterAs()
Determines whether a whitespace was parsed after AS.- Returns:
true
if there was a whitespace after AS;false
otherwise
-
hasSpaceAfterCollectionValuedPathExpression
public boolean hasSpaceAfterCollectionValuedPathExpression()
Determines whether a whitespace was parsed after the collection-valued path expression.- Returns:
true
if a whitespace was parsed after the collection-valued path expression;false
otherwise
-
-