Module org.eclipse.persistence.jpa.jpql
Package org.eclipse.persistence.jpa.jpql.parser

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_expression

EclipseLink 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 :city
Example: SELECT p FROM Project p WHERE TYPE(p) IN(LargeProject, SmallProject)
Since:
2.3
Version:
2.5.1

  • Constructor Details

    • InExpression

      public InExpression(AbstractExpression parent, AbstractExpression expression)
      Creates a new InExpression.
      Parameters:
      parent - The parent of this expression
      expression - The state field path expression that was parsed prior of parsing this expression

  • Method Details

    • accept

      public void accept(ExpressionVisitor visitor)
      Description copied from interface: Expression
      Visits this Expression by the given visitor.
      Parameters:
      visitor - The ExpressionVisitor to visit this object

    • acceptChildren

      public void acceptChildren(ExpressionVisitor visitor)
      Description copied from interface: Expression
      Visits the children of this 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.

      Parameters:
      visitor - The visitor to visit the children of this object.

    • addChildrenTo

      protected void addChildrenTo(Collection<Expression> children)
      Description copied from class: AbstractExpression
      Adds the children of this AbstractExpression to the given collection.
      Overrides:
      addChildrenTo in class AbstractExpression
      Parameters:
      children - The collection used to store the children

    • addOrderedChildrenTo

      protected void addOrderedChildrenTo(List<Expression> children)
      Description copied from class: AbstractExpression
      Adds the children of this AbstractExpression to the given list.
      Overrides:
      addOrderedChildrenTo in class AbstractExpression
      Parameters:
      children - The list used to store the string representation of this AbstractExpression

    • findQueryBNF

      public JPQLQueryBNF findQueryBNF(Expression expression)
      Description copied from interface: Expression
      Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.
      Specified by:
      findQueryBNF in interface Expression
      Overrides:
      findQueryBNF in class AbstractExpression
      Parameters:
      expression - The Expression that is a descendant of this one
      Returns:
      The JPQLQueryBNF that was used to parse the given expression

    • getActualInIdentifier

      public 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 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 the Expression that 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 String getExpressionExpressionQueryBNFId()
      Returns the unique identifier of the query BNF that describes the expression being tested by the IN expression.
      Returns:
      InExpressionExpressionBNF.ID

    • getExpressionItemQueryBNFId

      public String getExpressionItemQueryBNFId()
      Returns the unique identifier of the query BNF that describes the items being tested against.
      Returns:
      InExpressionItemBNF.ID

    • getIdentifier

      public String getIdentifier()
      Returns the identifier for this expression.
      Returns:
      Either IS IN or IN

    • getInItems

      public Expression getInItems()
      Returns the Expression that represents the list if items.
      Returns:
      The expression that was parsed representing the list of items

    • getQueryBNF

      public JPQLQueryBNF getQueryBNF()
      Description copied from interface: Expression
      Returns the BNF of this Expression.
      Returns:
      The JPQLQueryBNF, which represents the grammar of this Expression

    • hasExpression

      public boolean hasExpression()
      Determines whether the state field path expression or type discriminator was parsed.
      Returns:
      true if the state field path expression or type discriminator was parsed; false if it was not parsed

    • hasInItems

      public boolean hasInItems()
      Determines whether the list of items was parsed.
      Returns:
      true if at least one item was parsed; false otherwise

    • hasLeftParenthesis

      public boolean hasLeftParenthesis()
      Determines whether the open parenthesis was parsed or not.
      Returns:
      true if the open parenthesis was present in the string version of the query; false otherwise

    • hasNot

      public boolean hasNot()
      Determines whether the identifier NOT was parsed.
      Returns:
      true if the identifier NOT was parsed; false otherwise

    • hasRightParenthesis

      public boolean hasRightParenthesis()
      Determines whether the close parenthesis was parsed or not.
      Returns:
      true if the close parenthesis was present in the string version of the query; false otherwise

    • hasSpaceAfterIn

      public boolean hasSpaceAfterIn()
      Determines whether there was a whitespace after the IN identifier if the left parenthesis was not parsed.
      Returns:
      true if a whitespace was parsed after IN in the string version of the query; false otherwise
      Since:
      2.4

    • isParsingComplete

      protected boolean isParsingComplete(WordParser wordParser, String word, Expression expression)
      Description copied from class: AbstractExpression
      Determines whether the parsing is complete based on what is left in the given text. The text is never empty.
      Overrides:
      isParsingComplete in class AbstractExpression
      Parameters:
      wordParser - The text to parse based on the current position of the cursor
      word - The word that was retrieved from the given text, which is the first word in the text
      expression - The Expression that has already been parsed
      Returns:
      true if the text no longer can't be parsed by the current expression; false if more can be parsed

    • isSingleInputParameter

      public 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
      Returns:
      true if what is following the IN identifier is a single input parameter (without the left or right parenthesis); false otherwise
      Since:
      2.4

    • parse

      protected void parse(WordParser wordParser, boolean tolerant)
      Description copied from class: AbstractExpression
      Parses the query by starting at the current position, which is part of the given WordParser.
      Specified by:
      parse in class AbstractExpression
      Parameters:
      wordParser - The text to parse based on the current position of the cursor
      tolerant - Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

    • toParsedText

      protected void toParsedText(StringBuilder writer, boolean actual)
      Description copied from class: AbstractExpression
      Generates a string representation of this Expression, including its children, if it has any.
      Specified by:
      toParsedText in class AbstractExpression
      Parameters:
      writer - The buffer used to append this Expression's string representation
      actual - 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