|
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.InExpression
public final class InExpression
The state_field_path_expression
must have a string, numeric, or enum value. The literal and/or input_parameter
values must be like the same abstract schema type of the state_field_path_expression
in type.
The results of the subquery
must be like the same abstract schema type of the state_field_path_expression
in type.
There must be at least one element in the comma separated list that defines the set of values for the IN expression. If the value of a state_field_path_expression
in an IN or NOT IN expression is NULL or unknown, the value of the expression is unknown.
JPA 1.0:
in_expression ::= state_field_path_expression [NOT] IN(in_item {, in_item}* | subquery)
JPA 2.0
in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN { ( in_item {, in_item}* ) | (subquery) | collection_valued_input_parameter }
Field Summary | |
---|---|
private AbstractExpression |
expression The expression before the 'IN' identifier used for identification. |
private boolean |
hasLeftParenthesis Flag used to determine if the closing parenthesis is present in the query. |
private boolean |
hasNot Determines whether this expression is negated or not. |
private boolean |
hasRightParenthesis Flag used to determine if the opening parenthesis is present in the query. |
private AbstractExpression |
inItems The expression within parenthesis, which can be one or many expressions. |
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 | |
---|---|
InExpression(AbstractExpression parent, AbstractExpression expression) Creates a new InExpression . |
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 |
addOrderedChildrenTo(java.util.List<StringExpression> children) Adds the StringExpressions representing this Expression . |
JPQLQueryBNF |
findQueryBNF(AbstractExpression expression) Retrieves the JPQLQueryBNF that was used to parse the given Expression . |
Expression |
getExpression() Returns the Expression that represents the state field path expression or type discriminator. |
java.lang.String |
getIdentifier() Returns the identifier for this expression. |
Expression |
getInItems() Returns the Expression that represents the list if items. |
JPQLQueryBNF |
getQueryBNF() Returns the BNF of this Expression . |
boolean |
hasExpression() Determines whether the state field path expression or type discriminator was parsed. |
boolean |
hasInItems() Determines whether the list of items was parsed. |
boolean |
hasLeftParenthesis() Determines whether the open parenthesis was parsed or not. |
boolean |
hasNot() Determines whether the identifier NOT was parsed. |
boolean |
hasRightParenthesis() Determines whether the close parenthesis was parsed or not. |
(package private) void |
parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser . |
(package private) void |
toParsedText(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of this Expression . |
Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression |
---|
buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, getChildren, getJPAVersion, getParent, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, isParsingComplete, 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 expression
private boolean hasLeftParenthesis
private boolean hasNot
private boolean hasRightParenthesis
private AbstractExpression inItems
Constructor Detail |
---|
InExpression(AbstractExpression parent, AbstractExpression expression)
InExpression
.
parent
- The parent of this expressionexpression
- The state field path expression that was parsed prior of parsing 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 addOrderedChildrenTo(java.util.List<StringExpression> children)
StringExpressions
representing this Expression
.addOrderedChildrenTo
in class AbstractExpression
children
- The list used to store the string representation of this Expression
public JPQLQueryBNF findQueryBNF(AbstractExpression expression)
JPQLQueryBNF
that was used to parse the given Expression
.findQueryBNF
in class AbstractExpression
expression
- The expression for which its BNF is neededJPQLQueryBNF
that was used to parse the given expressionpublic Expression getExpression()
Expression
that represents the state field path expression or type discriminator.public java.lang.String getIdentifier()
public Expression getInItems()
Expression
that represents the list if items.public JPQLQueryBNF getQueryBNF()
Expression
.getQueryBNF
in class AbstractExpression
JPQLQueryBNF
, which represents the grammar of this Expression
public boolean hasExpression()
true
if the state field path expression or type discriminator was parsed; false
if it was not parsedpublic boolean hasInItems()
true
if at least one item was parsed; false
otherwisepublic boolean hasLeftParenthesis()
true
if the open parenthesis was present in the string version of the query; false
otherwisepublic boolean hasNot()
true
if the identifier NOT was parsed; false
otherwisepublic boolean hasRightParenthesis()
true
if the close parenthesis was present in the string version of the query; false
otherwisevoid parse(WordParser wordParser, boolean tolerant)
WordParser
.parse
in class AbstractExpression
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 queriesvoid toParsedText(java.lang.StringBuilder writer, boolean includeVirtual)
Expression
.toParsedText
in class AbstractExpression
writer
- The buffer used to append this 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 |