public final class InExpression extends AbstractExpression
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 }
EclipseLink 2.1:
in_item ::= literal | single_valued_input_parameter | scalar_expression
EclipseLink 2.5:
in_expression ::= { in_expression_expression | nested_array_expression } [NOT] IN { ( in_item {, in_item}* ) | (subquery) | ( nested_array_item {, nested_array_item}+ ) | collection_valued_input_parameter }
in_expression_expression ::= { state_field_path_expression | type_discriminator |
single_valued_input_parameter | identification_variable |
scalar_expression }
nested_array_expression ::= ( in_expression_expression {, in_expression_expression}+ )
nested_array_item ::= ( in_item {, in_item}+ )
SELECT c FROM Customer c WHERE c.home.city IN :city
SELECT p FROM Project p WHERE TYPE(p) IN(LargeProject, SmallProject)
COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE
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 and Description |
---|
InExpression(AbstractExpression parent,
AbstractExpression expression)
Creates a new
InExpression . |
Modifier and Type | Method and Description |
---|---|
void |
accept(ExpressionVisitor visitor)
Visits this
Expression by the given visitor . |
void |
acceptChildren(ExpressionVisitor visitor)
Visits the children of this
Expression . |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the
JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression . |
java.lang.String |
getActualInIdentifier()
Returns the actual IN found in the string representation of the JPQL query, which has
the actual case that was used.
|
java.lang.String |
getActualNotIdentifier()
Returns the actual NOT found in the string representation of the JPQL query, which has
the actual case that was used.
|
Expression |
getExpression()
Returns the
Expression that represents the state field path expression or type
discriminator. |
java.lang.String |
getExpressionExpressionQueryBNFId()
Returns the unique identifier of the query BNF that describes the expression being tested by
the
IN expression. |
java.lang.String |
getExpressionItemQueryBNFId()
Returns the unique identifier of the query BNF that describes the items being tested against.
|
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.
|
boolean |
hasSpaceAfterIn()
Determines whether there was a whitespace after the
IN identifier if the left
parenthesis was not parsed. |
boolean |
isSingleInputParameter()
Determines whether what was parsed after the
IN identifier is a single input
parameter:
BNF: in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN collection_valued_input_parameter |
children, getGrammar, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, isAncestor, orderedChildren, populatePosition, toActualText, toParsedText, toString
public InExpression(AbstractExpression parent, AbstractExpression expression)
InExpression
.parent
- The parent of this expressionexpression
- The state field path expression that was parsed prior of parsing this
expressionpublic void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.visitor
- The ExpressionVisitor
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()
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.public JPQLQueryBNF findQueryBNF(Expression expression)
JPQLQueryBNF
that represents the fragment of this Expression
that was used when parsing the given Expression
.findQueryBNF
in interface Expression
findQueryBNF
in class AbstractExpression
expression
- The Expression
that is a descendant of this oneJPQLQueryBNF
that was used to parse the given expressionpublic java.lang.String getActualInIdentifier()
public java.lang.String getActualNotIdentifier()
public Expression getExpression()
Expression
that represents the state field path expression or type
discriminator.public java.lang.String getExpressionExpressionQueryBNFId()
IN
expression.InExpressionExpressionBNF.ID
public java.lang.String getExpressionItemQueryBNFId()
InExpressionItemBNF.ID
public java.lang.String getIdentifier()
public Expression getInItems()
Expression
that represents the list if items.public JPQLQueryBNF getQueryBNF()
Expression
.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
otherwisepublic boolean hasSpaceAfterIn()
IN
identifier if the left
parenthesis was not parsed.true
if a whitespace was parsed after IN
in the string
version of the query; false
otherwisepublic boolean isSingleInputParameter()
IN
identifier is a single input
parameter:
in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN collection_valued_input_parameter
true
if what is following the IN
identifier is a single
input parameter (without the left or right parenthesis); false
otherwiseEclipseLink 2.6.3, "build v20160428-59c81c5" API Reference