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

Class ComparisonExpressionStateObject

  • All Implemented Interfaces:
    StateObject
    public class ComparisonExpressionStateObject
extends CompoundExpressionStateObject
    Only the values of like types are permitted to be compared. A type is like another type if they correspond to the same Java language type, or if one is a primitive Java language type and the other is the wrapped Java class type equivalent (e.g., int and Integer are like types in this sense).

    There is one exception to this rule: it is valid to compare numeric values for which the rules of numeric promotion apply. Conditional expressions attempting to compare non-like type values are disallowed except for this numeric case.

    Note that the arithmetic operators and comparison operators are permitted to be applied to state-fields and input parameters of the wrapped Java class equivalents to the primitive numeric Java types. Two entities of the same abstract schema type are equal if and only if they have the same primary key value. Only equality/inequality comparisons over enumeration constants are required to be supported.

    JPA 1.0 - BNF: 

    comparison_expression ::= string_expression comparison_operator {string_expression | all_or_any_expression} |
                          boolean_expression {=|<>} {boolean_expression | all_or_any_expression} |
                          enum_expression {=|<>} {enum_expression | all_or_any_expression} |
                          datetime_expression comparison_operator {datetime_expression | all_or_any_expression} |
                          entity_expression {=|<>} {entity_expression | all_or_any_expression} |
                          arithmetic_expression comparison_operator {arithmetic_expression | all_or_any_expression}
    JPA 2.0 - BNF: 
    comparison_expression ::= string_expression comparison_operator {string_expression | all_or_any_expression} |
                          boolean_expression {=|<>} {boolean_expression | all_or_any_expression} |
                          enum_expression {=|<>} {enum_expression | all_or_any_expression} |
                          datetime_expression comparison_operator {datetime_expression | all_or_any_expression} |
                          entity_expression {=|<>} {entity_expression | all_or_any_expression} |
                          arithmetic_expression comparison_operator {arithmetic_expression | all_or_any_expression} |
                          entity_type_expression {=|<>} entity_type_expression}
    Version:
    2.4
    See Also:
    ComparisonExpression
    Author:
    Pascal Filion
    Since:
    2.4

    • Field Detail

      • IDENTIFIER_PROPERTY

        public static final java.lang.String IDENTIFIER_PROPERTY
        Notifies the identifier property has changed.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ComparisonExpressionStateObject

        public ComparisonExpressionStateObject​(StateObject parent,
                                       StateObject leftStateObject,
                                       java.lang.String identifier,
                                       StateObject rightStateObject)
        Creates a new ComparisonExpressionStateObject.
        Parameters:
        parent - The parent of this state object, which cannot be null
        leftStateObject - The StateObject representing the left expression
        identifier - The comparison identifier, either <, <=, =, >=, <>
        rightStateObject - The StateObject representing the right expression
        Throws:
        java.lang.NullPointerException - The given parent cannot be null

      • ComparisonExpressionStateObject

        public ComparisonExpressionStateObject​(StateObject parent,
                                       java.lang.String identifier)
        Creates a new ComparisonExpressionStateObject.
        Parameters:
        parent - The parent of this state object, which cannot be null
        identifier - The comparison identifier, either <, <=, =, >=, <>
        Throws:
        java.lang.NullPointerException - The given parent cannot be null

      • ComparisonExpressionStateObject

        public ComparisonExpressionStateObject​(StateObject parent,
                                       java.lang.String leftJpqlFragment,
                                       java.lang.String identifier,
                                       java.lang.String rightJpqlFragment)
        Creates a new ComparisonExpressionStateObject.
        Parameters:
        parent - The parent of this state object, which cannot be null
        leftJpqlFragment - The string representation of the left expression to parse and to convert into a StateObject
        identifier - The comparison identifier, either <, <=, =, >=, <>
        rightJpqlFragment - The string representation of the right expression to parse and to convert into a StateObject
        Throws:
        java.lang.NullPointerException - The given parent cannot be null

    • Method Detail

      • getLeftQueryBNFId

        protected java.lang.String getLeftQueryBNFId()
        Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the left side of the expression.
        Specified by:
        getLeftQueryBNFId in class CompoundExpressionStateObject
        Returns:
        The query BNF ID for the left side of the expression

      • getRightQueryBNFId

        protected java.lang.String getRightQueryBNFId()
        Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the right side of the expression.
        Specified by:
        getRightQueryBNFId in class CompoundExpressionStateObject
        Returns:
        The query BNF ID for the right side of the expression

      • setExpression

        public void setExpression​(ComparisonExpression 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 a comparison expression

      • setIdentifier

        public void setIdentifier​(java.lang.String identifier)
        Sets the comparison identifier to one of the following: <, <=, =, >=, <>.
        Parameters:
        identifier - The new comparison identifier, either <, <=, =, >=, <>

      • validateIdentifier

        protected void validateIdentifier​(java.lang.String identifier)