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

Class CollectionMemberExpression

java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.CollectionMemberExpression
All Implemented Interfaces:
Expression
public final class CollectionMemberExpression extends AbstractExpression
This expression tests whether the designated value is a member of the collection specified by the collection-valued path expression. If the collection-valued path expression designates an empty collection, the value of the MEMBER OF expression is FALSE and the value of the NOT MEMBER OF expression is TRUE. Otherwise, if the value of the collection-valued path expression or single-valued association-field path expression in the collection member expression is NULL or unknown, the value of the collection member expression is unknown.
BNF: collection_member_expression ::= entity_or_value_expression [NOT] MEMBER [OF] collection_valued_path_expression
Since:
2.3
Version:
2.5

  • Constructor Details

    • CollectionMemberExpression

      public CollectionMemberExpression(AbstractExpression parent, AbstractExpression expression)
      Creates a new CollectionMemberExpression.
      Parameters:
      parent - The parent of this expression
      expression - The entity expression that was parsed before parsing this one

  • 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

    • getActualMemberIdentifier

      public String getActualMemberIdentifier()
      Returns the actual MEMBER identifier found in the string representation of the JPQL query, which has the actual case that was used.
      Returns:
      The MEMBER identifier that was actually parsed

    • getActualNotIdentifier

      public String getActualNotIdentifier()
      Returns the actual NOT identifier 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

    • getActualOfIdentifier

      public String getActualOfIdentifier()
      Returns the actual OF identifier found in the string representation of the JPQL query, which has the actual case that was used.
      Returns:
      The OF identifier that was actually parsed, or an empty string if it was not parsed

    • getCollectionValuedPathExpression

      public Expression getCollectionValuedPathExpression()
      Returns the Expression representing the collection-valued path expression.
      Returns:
      The expression that was parsed representing the collection valued path expression

    • getEntityExpression

      public Expression getEntityExpression()
      Returns the Expression representing the entity expression.
      Returns:
      The expression that was parsed representing the entity expression

    • getIdentifier

      public String getIdentifier()
      Returns the identifier for this expression that may include NOT and OF if it was parsed.
      Returns:
      Either MEMBER, NOT MEMBER, NOT MEMBER OF or MEMBER OF

    • 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

    • hasCollectionValuedPathExpression

      public boolean hasCollectionValuedPathExpression()
      Determines whether the collection-valued path expression was parsed.
      Returns:
      true if the collection-valued path expression was parsed; false otherwise

    • hasEntityExpression

      public boolean hasEntityExpression()
      Determines whether the entity expression was parsed.
      Returns:
      true if the entity expression was parsed; false otherwise

    • hasNot

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

    • hasOf

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

    • hasSpaceAfterMember

      public boolean hasSpaceAfterMember()
      Determines whether a whitespace was found after MEMBER.
      Returns:
      true if there was a whitespace after MEMBER; false otherwise

    • hasSpaceAfterOf

      public boolean hasSpaceAfterOf()
      Determines whether a whitespace was found after OF.
      Returns:
      true if there was a whitespace after OF; false otherwise

    • 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