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

Class AbstractDoubleEncapsulatedExpressionStateObject

java.lang.Object
org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject
org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractDoubleEncapsulatedExpressionStateObject
All Implemented Interfaces:
StateObject
Direct Known Subclasses:
ModExpressionStateObject, NullIfExpressionStateObject
public abstract class AbstractDoubleEncapsulatedExpressionStateObject extends AbstractEncapsulatedExpressionStateObject
This StateObject represents a JPQL expression that has a JPQL identifier followed by two an encapsulated expression with parenthesis, the two expression are separated by a comma.

BNF: expression ::= <identifier>(first_expression, second_expression)

Since:
2.4
Version:
2.4
See Also:

  • Field Details

  • Constructor Details

    • AbstractDoubleEncapsulatedExpressionStateObject

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

    • AbstractDoubleEncapsulatedExpressionStateObject

      protected AbstractDoubleEncapsulatedExpressionStateObject(StateObject parent, StateObject firstStateObject, StateObject secondStateObject)
      Creates a new AbstractDoubleEncapsulatedExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      firstStateObject - The StateObject representing the first expression
      secondStateObject - The StateObject representing the second expression
      Throws:
      NullPointerException - The given parent cannot be null

    • AbstractDoubleEncapsulatedExpressionStateObject

      public AbstractDoubleEncapsulatedExpressionStateObject(StateObject parent, String firstJpqlFragment, String secondJpqlFragment)
      Creates a new AbstractDoubleEncapsulatedExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      firstJpqlFragment - The string representation of the first encapsulated expression to parse and to convert into a StateObject representation
      secondJpqlFragment - The string representation of the second encapsulated expression to parse and to convert into a StateObject representation
      Throws:
      NullPointerException - The given parent cannot be null

  • Method Details

    • 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 AbstractStateObject
      Parameters:
      children - The list used to store the children

    • getExpression

      public AbstractDoubleEncapsulatedExpression 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 AbstractEncapsulatedExpressionStateObject
      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)

    • getFirst

      public StateObject getFirst()
      Returns the StateObject representing the first expression.
      Returns:
      The first encapsulated StateObject or null if none exists

    • getFirstQueryBNFId

      protected abstract String getFirstQueryBNFId()
      Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the first encapsulated expression.
      Returns:
      The query BNF ID for the first encapsulated expression

    • getSecond

      public StateObject getSecond()
      Returns the StateObject representing the second expression.
      Returns:
      The second encapsulated StateObject or null if none exists

    • getSecondQueryBNFId

      protected abstract String getSecondQueryBNFId()
      Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the second encapsulated expression.
      Returns:
      The query BNF ID for the second encapsulated expression

    • hasFirst

      public boolean hasFirst()
      Determines whether the StateObject representing the first encapsulated expression is present or not.
      Returns:
      true if the first StateObject is not null; false otherwise

    • hasSecond

      public boolean hasSecond()
      Determines whether the StateObject representing the second encapsulated expression is present or not.
      Returns:
      true if the second StateObject is not null; false otherwise

    • 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

    • parseFirst

      public void parseFirst(String jpqlFragment)
      Parses the given JPQL fragment, which will represent the first encapsulated expression.
      Parameters:
      jpqlFragment - The string representation of the first encapsulated expression to parse and to convert into a StateObject representation

    • parseSecond

      public void parseSecond(String jpqlFragment)
      Parses the given JPQL fragment, which will represent the second encapsulated expression.
      Parameters:
      jpqlFragment - The string representation of the second encapsulated expression to parse and to convert into a StateObject representation

    • setFirst

      public void setFirst(StateObject firstStateObject)
      Sets the given StateObject to represent the first encapsulated expression.
      Parameters:
      firstStateObject - The new encapsulated StateObject representing the first expression

    • setSecond

      public void setSecond(StateObject secondStateObject)
      Sets the given StateObject to represent the second encapsulated expression.
      Parameters:
      secondStateObject - The new encapsulated StateObject representing the second expression

    • toTextEncapsulatedExpression

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