|
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.AbstractEncapsulatedExpression
org.eclipse.persistence.jpa.internal.jpql.parser.TreatExpression
public final class TreatExpression
Returns an expression that allows to treat its base as if it were a subclass of the class returned by the base.
New to
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
Field Summary | |
---|---|
private AbstractExpression |
collectionValuedPathExpression The Expression that represents the collection-valued path expression. |
private AbstractExpression |
entityType The entity type used to downcast the type of the elements in the collection. |
private boolean |
hasAs Determines whether the identifier AS was parsed. |
private boolean |
hasSpaceAfterAs Determines whether a whitespace was parsed after AS. |
private boolean |
hasSpaceAfterCollectionValuedPathExpression Determines whether a whitespace was parsed after the collection-valued path expression. |
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 | |
---|---|
TreatExpression(AbstractExpression parent) Creates a new TreatExpression . |
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 |
addOrderedEncapsulatedExpressionTo(java.util.List<StringExpression> children) Adds the StringExpressions representing the encapsulated Expression . |
Expression |
getCollectionValuedPathExpression() Returns the Expression that represents the collection-valued path expression. |
Expression |
getEntityType() Returns the Expression 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 this Expression . |
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. |
(package private) void |
parseEncapsulatedExpression(WordParser wordParser, boolean tolerant) Parses the encapsulated expression by starting at the current position, which is part of the given WordParser . |
(package private) java.lang.String |
parseIdentifier(WordParser wordParser) Parses the identifier of this expression. |
(package private) void |
toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of the encapsulated Expression . |
Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractEncapsulatedExpression |
---|
addOrderedChildrenTo, areLogicalIdentifiersSupported, getIdentifier, hasLeftParenthesis, hasRightParenthesis, isParsingComplete, parse, toParsedText |
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 AbstractExpression collectionValuedPathExpression
Expression
that represents the collection-valued path expression.private AbstractExpression entityType
private boolean hasAs
private boolean hasSpaceAfterAs
private boolean hasSpaceAfterCollectionValuedPathExpression
Constructor Detail |
---|
TreatExpression(AbstractExpression parent)
TreatExpression
.
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 addOrderedEncapsulatedExpressionTo(java.util.List<StringExpression> children)
StringExpressions
representing the encapsulated Expression
.addOrderedEncapsulatedExpressionTo
in class AbstractEncapsulatedExpression
children
- The list used to store the string representation of the encapsulated Expression
public Expression getCollectionValuedPathExpression()
Expression
that represents the collection-valued path expression.public Expression getEntityType()
Expression
that represents the entity type that will be used to downcast the type of the elements in the collection.public JPQLQueryBNF getQueryBNF()
Expression
.getQueryBNF
in class AbstractExpression
JPQLQueryBNF
, which represents the grammar of this Expression
public boolean hasAs()
true
if the identifier AS was parsed; false
otherwisepublic boolean hasCollectionValuedPathExpression()
true
if the collection-valued path expression was parsed; false
if nothing was parsedpublic boolean hasEncapsulatedExpression()
hasEncapsulatedExpression
in class AbstractEncapsulatedExpression
true
if something was parsed; false
otherwisepublic boolean hasEntityType()
true
if the entity type was parsed; false
if nothing was parsedpublic boolean hasSpaceAfterAs()
true
if there was a whitespace after AS; false
otherwisepublic boolean hasSpaceAfterCollectionValuedPathExpression()
true
if a whitespace was parsed after the collection-valued path expression; false
otherwisevoid parseEncapsulatedExpression(WordParser wordParser, boolean tolerant)
WordParser
.parseEncapsulatedExpression
in class AbstractEncapsulatedExpression
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 queriesjava.lang.String parseIdentifier(WordParser wordParser)
parseIdentifier
in class AbstractEncapsulatedExpression
void toParsedTextEncapsulatedExpression(java.lang.StringBuilder writer, boolean includeVirtual)
Expression
.toParsedTextEncapsulatedExpression
in class AbstractEncapsulatedExpression
writer
- The buffer used to append the encapsulated 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 |