Module org.eclipse.persistence.jpa.jpql
Package org.eclipse.persistence.jpa.jpql.tools.model.query

Class InExpressionStateObject

java.lang.Object
org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject<StateObject>
org.eclipse.persistence.jpa.jpql.tools.model.query.InExpressionStateObject
All Implemented Interfaces:
ListHolderStateObject<StateObject>, StateObject
public class InExpressionStateObject extends AbstractListHolderStateObject<StateObject>
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 }

Since:
2.4
Version:
2.4
See Also:

  • Field Details

    • ITEMS_LIST

      public static final String ITEMS_LIST
      Notifies the list of items has changed.
      See Also:

    • NOT_PROPERTY

      public static final String NOT_PROPERTY
      Notifies the visibility of the NOT identifier has changed.
      See Also:

    • STATE_OBJECT_PROPERTY

      public static final String STATE_OBJECT_PROPERTY
      Notifies the StateObject representing the state field path expression or the input parameter has changed.
      See Also:

  • Constructor Details

    • InExpressionStateObject

      public InExpressionStateObject(StateObject parent)
      Creates a new InExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      Throws:
      NullPointerException - The given parent cannot be null

    • InExpressionStateObject

      public InExpressionStateObject(StateObject parent, boolean not, String path, List<String> items)
      Creates a new InExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      not - Determines whether the NOT identifier is part of the expression or not
      items - The list of JPQL fragments that will be parsed and converted into StateObject
      Throws:
      NullPointerException - The given parent cannot be null

    • InExpressionStateObject

      public InExpressionStateObject(StateObject parent, boolean not, String path, String parameter)
      Creates a new InExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      not - Determines whether the NOT identifier is part of the expression or not
      parameter - The
      Throws:
      NullPointerException - The given parent cannot be null

    • InExpressionStateObject

      public InExpressionStateObject(StateObject parent, StateObject stateObject, boolean not, List<? extends StateObject> items)
      Creates a new InExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      not - Determines whether the NOT identifier is part of the expression or not
      Throws:
      NullPointerException - The given parent cannot be null

    • InExpressionStateObject

      public InExpressionStateObject(StateObject parent, StateObject stateFieldPath, List<? extends StateObject> items)
      Creates a new InExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      Throws:
      NullPointerException - The given parent cannot be null

    • InExpressionStateObject

      public InExpressionStateObject(StateObject parent, String path, List<String> items)
      Creates a new InExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      items - The list of JPQL fragments that will be parsed and converted into StateObject
      Throws:
      NullPointerException - The given parent cannot be null

  • Method Details

    • accept

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

    • addChildren

      protected void addChildren(List<StateObject> children)
      Description copied from class: AbstractStateObject
      Adds the children of this StateObject to the given list.
      Overrides:
      addChildren in class AbstractListHolderStateObject<StateObject>
      Parameters:
      children - The list used to store the children

    • addNot

      public InExpressionStateObject addNot()
      Makes sure the NOT identifier is specified.
      Returns:
      This object

    • getExpression

      public InExpression getExpression()
      Description copied from interface: StateObject
      Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
      Specified by:
      getExpression in interface StateObject
      Overrides:
      getExpression in class AbstractStateObject
      Returns:
      The parsed object when a JPQL query is parsed and converted into a StateObject or null when the JPQL query is manually created (i.e. not from a string)

    • getStateObject

      public StateObject getStateObject()
      Returns

    • hasNot

      public boolean hasNot()
      Determines whether the NOT identifier is used or not.
      Returns:
      true if the NOT identifier is part of the expression; false otherwise

    • hasStateObject

      public boolean hasStateObject()
      Determines whether

    • isEquivalent

      public boolean isEquivalent(StateObject stateObject)
      Description copied from interface: StateObject
      Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.
      Specified by:
      isEquivalent in interface StateObject
      Overrides:
      isEquivalent in class AbstractStateObject
      Parameters:
      stateObject - The StateObject to compare its content to this one
      Returns:
      true if both object are equivalent; false otherwise

    • isSingleInputParameter

      public boolean isSingleInputParameter()
      Determines whether what was parsed after the IN identifier is a single input parameter.
      Returns:
      true if the only item is an input parameter; false otherwise

    • listName

      protected String listName()
      Description copied from class: AbstractListHolderStateObject
      Returns the name that is uniquely identifying the list.
      Specified by:
      listName in class AbstractListHolderStateObject<StateObject>
      Returns:
      The unique name identifying the list

    • parse

      public void parse(String jpqlFragment)
      Parses the given JPQL fragment, which represents either a single or many items, the fragment will be parsed and converted into StateObject.
      Parameters:
      jpqlFragment - The portion of the query to parse

    • removeNot

      public void removeNot()
      Makes sure the NOT identifier is not specified.

    • setExpression

      public void setExpression(InExpression expression)
      Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.
      Parameters:
      expression - The parsed object representing an IN expression

    • setNot

      public void setNot(boolean not)
      Sets whether the NOT identifier should be part of the expression or not.
      Parameters:
      not - true if the NOT identifier should be part of the expression; false otherwise

    • setSingleInputParameter

      public void setSingleInputParameter(boolean singleInputParameter)
      Sets whether what was parsed after the IN identifier is a single input parameter.
      Parameters:
      singleInputParameter - true if the only item is an input parameter; false otherwise

    • setStateObject

      public void setStateObject(StateObject stateObject)
      Sets

    • toggleNot

      public void toggleNot()
      Changes the visibility state of the NOT identifier.

    • toTextInternal

      protected void toTextInternal(Appendable writer) throws IOException
      Description copied from class: AbstractStateObject
      Prints out a string representation of this StateObject, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.
      Specified by:
      toTextInternal in class AbstractStateObject
      Parameters:
      writer - The writer used to print out the string representation
      Throws:
      IOException - This should never happens, it is only required because Appendable is used instead of any concrete class