Class InExpression
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.InExpression
-
- All Implemented Interfaces:
Expression
public final class InExpression extends AbstractExpression
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:
BNF:in_expression ::= state_field_path_expression [NOT] IN(in_item {, in_item}* | subquery)JPA 2.0:
BNF:in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN { ( in_item {, in_item}* ) | (subquery) | collection_valued_input_parameter }EclipseLink 2.1:
BNF:in_item ::= literal | single_valued_input_parameter | scalar_expressionEclipseLink 2.5:
BNF: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}+ )Example:SELECT c FROM Customer c WHERE c.home.city IN :cityExample:SELECT p FROM Project p WHERE TYPE(p) IN(LargeProject, SmallProject)- Version:
- 2.5.1
- Author:
- Pascal Filion
- Since:
- 2.3
-
-
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 InExpression(AbstractExpression parent, AbstractExpression expression)Creates a newInExpression.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(ExpressionVisitor visitor)Visits thisExpressionby the givenvisitor.voidacceptChildren(ExpressionVisitor visitor)Visits the children of thisExpression.protected voidaddChildrenTo(java.util.Collection<Expression> children)Adds the children of thisAbstractExpressionto the given collection.protected voidaddOrderedChildrenTo(java.util.List<Expression> children)Adds the children of thisAbstractExpressionto the given list.JPQLQueryBNFfindQueryBNF(Expression expression)Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.java.lang.StringgetActualInIdentifier()Returns the actual IN found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetActualNotIdentifier()Returns the actual NOT found in the string representation of the JPQL query, which has the actual case that was used.ExpressiongetExpression()Returns theExpressionthat represents the state field path expression or type discriminator.java.lang.StringgetExpressionExpressionQueryBNFId()Returns the unique identifier of the query BNF that describes the expression being tested by theINexpression.java.lang.StringgetExpressionItemQueryBNFId()Returns the unique identifier of the query BNF that describes the items being tested against.java.lang.StringgetIdentifier()Returns the identifier for this expression.ExpressiongetInItems()Returns theExpressionthat represents the list if items.JPQLQueryBNFgetQueryBNF()Returns the BNF of thisExpression.booleanhasExpression()Determines whether the state field path expression or type discriminator was parsed.booleanhasInItems()Determines whether the list of items was parsed.booleanhasLeftParenthesis()Determines whether the open parenthesis was parsed or not.booleanhasNot()Determines whether the identifier NOT was parsed.booleanhasRightParenthesis()Determines whether the close parenthesis was parsed or not.booleanhasSpaceAfterIn()Determines whether there was a whitespace after theINidentifier if the left parenthesis was not parsed.protected booleanisParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)Determines whether the parsing is complete based on what is left in the given text.booleanisSingleInputParameter()Determines whether what was parsed after theINidentifier is a single input parameter: BNF:in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN collection_valued_input_parameterprotected voidparse(WordParser wordParser, boolean tolerant)Parses the query by starting at the current position, which is part of the givenWordParser.protected voidtoParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
acceptUnknownVisitor, acceptUnknownVisitor, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, getText, handleAggregate, handleCollection, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
-
-
-
Constructor Detail
-
InExpression
public InExpression(AbstractExpression parent, AbstractExpression expression)
Creates a newInExpression.- Parameters:
parent- The parent of this expressionexpression- The state field path expression that was parsed prior of parsing this expression
-
-
Method Detail
-
accept
public void accept(ExpressionVisitor visitor)
Visits thisExpressionby the givenvisitor.- Parameters:
visitor- TheExpressionVisitorto 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
Expressionsub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitorin order to traverse the entire sub-hierarchy.- Parameters:
visitor- Thevisitorto visit the children of this object.
-
addChildrenTo
protected void addChildrenTo(java.util.Collection<Expression> children)
Adds the children of thisAbstractExpressionto the given collection.- Overrides:
addChildrenToin classAbstractExpression- Parameters:
children- The collection used to store the children
-
addOrderedChildrenTo
protected void addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of thisAbstractExpressionto the given list.- Overrides:
addOrderedChildrenToin classAbstractExpression- Parameters:
children- The list used to store the string representation of thisAbstractExpression
-
findQueryBNF
public JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.- Specified by:
findQueryBNFin interfaceExpression- Overrides:
findQueryBNFin classAbstractExpression- Parameters:
expression- TheExpressionthat is a descendant of this one- Returns:
- The
JPQLQueryBNFthat was used to parse the given expression
-
getActualInIdentifier
public 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.- Returns:
- The IN identifier that was actually parsed
-
getActualNotIdentifier
public 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.- Returns:
- The NOT identifier that was actually parsed, or an empty string if it was not parsed
-
getExpression
public Expression getExpression()
Returns theExpressionthat represents the state field path expression or type discriminator.- Returns:
- The expression that was parsed representing the state field path expression or the type discriminator
-
getExpressionExpressionQueryBNFId
public java.lang.String getExpressionExpressionQueryBNFId()
Returns the unique identifier of the query BNF that describes the expression being tested by theINexpression.- Returns:
InExpressionExpressionBNF.ID
-
getExpressionItemQueryBNFId
public java.lang.String getExpressionItemQueryBNFId()
Returns the unique identifier of the query BNF that describes the items being tested against.- Returns:
InExpressionItemBNF.ID
-
getIdentifier
public java.lang.String getIdentifier()
Returns the identifier for this expression.- Returns:
- Either IS IN or IN
-
getInItems
public Expression getInItems()
Returns theExpressionthat represents the list if items.- Returns:
- The expression that was parsed representing the list of items
-
getQueryBNF
public JPQLQueryBNF getQueryBNF()
Returns the BNF of thisExpression.- Returns:
- The
JPQLQueryBNF, which represents the grammar of thisExpression
-
hasExpression
public boolean hasExpression()
Determines whether the state field path expression or type discriminator was parsed.- Returns:
trueif the state field path expression or type discriminator was parsed;falseif it was not parsed
-
hasInItems
public boolean hasInItems()
Determines whether the list of items was parsed.- Returns:
trueif at least one item was parsed;falseotherwise
-
hasLeftParenthesis
public boolean hasLeftParenthesis()
Determines whether the open parenthesis was parsed or not.- Returns:
trueif the open parenthesis was present in the string version of the query;falseotherwise
-
hasNot
public boolean hasNot()
Determines whether the identifier NOT was parsed.- Returns:
trueif the identifier NOT was parsed;falseotherwise
-
hasRightParenthesis
public boolean hasRightParenthesis()
Determines whether the close parenthesis was parsed or not.- Returns:
trueif the close parenthesis was present in the string version of the query;falseotherwise
-
hasSpaceAfterIn
public boolean hasSpaceAfterIn()
Determines whether there was a whitespace after theINidentifier if the left parenthesis was not parsed.- Returns:
trueif a whitespace was parsed afterINin the string version of the query;falseotherwise- Since:
- 2.4
-
isParsingComplete
protected boolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
Determines whether the parsing is complete based on what is left in the given text. The text is never empty.- Overrides:
isParsingCompletein classAbstractExpression- Parameters:
wordParser- The text to parse based on the current position of the cursorword- The word that was retrieved from the given text, which is the first word in the textexpression- TheExpressionthat has already been parsed- Returns:
trueif the text no longer can't be parsed by the current expression;falseif more can be parsed
-
isSingleInputParameter
public boolean isSingleInputParameter()
Determines whether what was parsed after theINidentifier is a single input parameter:BNF:in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN collection_valued_input_parameter- Returns:
trueif what is following theINidentifier is a single input parameter (without the left or right parenthesis);falseotherwise- Since:
- 2.4
-
parse
protected void parse(WordParser wordParser, boolean tolerant)
Parses the query by starting at the current position, which is part of the givenWordParser.- Specified by:
parsein classAbstractExpression- Parameters:
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 queries
-
toParsedText
protected void toParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.- Specified by:
toParsedTextin classAbstractExpression- Parameters:
writer- The buffer used to append thisExpression's string representationactual- Determines whether the string representation should represent what was parsed, i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the JPQL identifiers
-
-