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

Class 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)
    Version:
    2.5.1
    Author:
    Pascal Filion
    Since:
    2.3

    • Constructor Detail

      • 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 Detail

      • 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 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 java.lang.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 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 the Expression that represents the list if items.
        Returns:
        The expression that was parsed representing the list of items

      • 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,
                                    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:
        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)
        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​(java.lang.StringBuilder writer,
                            boolean actual)
        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