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

Class CaseExpressionStateObject

    • Field Detail

      • CASE_OPERAND_STATE_OBJECT_PROPERTY

        public static final java.lang.String CASE_OPERAND_STATE_OBJECT_PROPERTY
        Notify the StateObject representing the case operand that follows the CASE identifier has changed.
        See Also:
        Constant Field Values

      • ELSE_STATE_OBJECT_PROPERTY

        public static final java.lang.String ELSE_STATE_OBJECT_PROPERTY
        Notify the StateObject representing the else expression that follows the ELSE identifier has changed.
        See Also:
        Constant Field Values

      • WHEN_CLAUSE_STATE_OBJECT_LIST

        public static final java.lang.String WHEN_CLAUSE_STATE_OBJECT_LIST
        Notify the list of StateObjects representing the when clauses that follow the WHEN has changed.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CaseExpressionStateObject

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

      • CaseExpressionStateObject

        public CaseExpressionStateObject​(StateObject parent,
                                 java.util.List<WhenClauseStateObject> whenClauseStateObjects,
                                 StateObject elseStateObject)
        Creates a new CaseExpressionStateObject.
        Parameters:
        parent - The parent of this state object, which cannot be null
        whenClauseStateObjects - The list of WhenClauseStateObjects that are representing the WHEN clauses
        elseStateObject - The StateObject representing the scalar expression that is following the ELSE identifier
        Throws:
        java.lang.NullPointerException - The given parent cannot be null

      • CaseExpressionStateObject

        public CaseExpressionStateObject​(StateObject parent,
                                 StateObject caseOperandStateObject,
                                 java.util.List<WhenClauseStateObject> whenClauseStateObjects,
                                 StateObject elseStateObject)
        Creates a new CaseExpressionStateObject.
        Parameters:
        parent - The parent of this state object, which cannot be null
        caseOperandStateObject - The StateObject representing the case operand that is following the CASE identifier or null if none is declared
        whenClauseStateObjects - The list of WhenClauseStateObjects that are representing the WHEN clauses
        elseStateObject - The StateObject representing the scalar expression that is following the ELSE identifier
        Throws:
        java.lang.NullPointerException - The given parent cannot be null

    • Method Detail

      • addProblems

        protected void addProblems​(java.util.List<Problem> problems)
        Adds to the given list the problems that were found with the current state of this StateObject, which means there are validation issues.
        Overrides:
        addProblems in class AbstractStateObject
        Parameters:
        problems - The list to which the problems are added

      • addWhenClause

        public WhenClauseStateObject addWhenClause​(java.lang.String whenJpqlFragment,
                                           java.lang.String thenJpqlFragment)
        Adds the given two StateObjects as the WHEN expression and the THEN expression of the new WHEN clause.
        Parameters:
        whenJpqlFragment - The string representation of the WHEN to parse and to convert into a StateObject representation
        thenJpqlFragment - The string representation of the THEN to parse and to convert into a StateObject representation
        Returns:
        The newly created WhenClauseStateObject

      • getCaseOperand

        public StateObject getCaseOperand()
        Returns the StateObject representing the case operand.
        Returns:
        The StateObject representing the case operand or null if it is not present

      • getElse

        public StateObject getElse()
        Returns the StateObject representing the ELSE scalar expression.
        Returns:
        The StateObject representing the ELSE scalar expression or null if it is not present

      • getExpression

        public CaseExpression getExpression()
        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)

      • hasCaseOperand

        public boolean hasCaseOperand()
        Determines whether the StateObject representing the case operand is present.
        Returns:
        true the case operand exists; otherwise false

      • hasElse

        public boolean hasElse()
        Determines whether the StateObject representing the ELSE scalar expression is present.
        Returns:
        true the ELSE scalar expression exists; otherwise false

      • parseCaseOperand

        public void parseCaseOperand​(java.lang.String jpqlFragment)
        Parses the given JPQL fragment, which will represent the case operand. The JPQL fragment should not start with the identifier.
        Parameters:
        jpqlFragment - The string representation of the case operand to parse and to convert into a StateObject representation

      • parseElse

        public void parseElse​(java.lang.String jpqlFragment)
        Parses the given JPQL fragment, which will represent the ELSE expression. The JPQL fragment should not start with the identifier.
        Parameters:
        jpqlFragment - The string representation of the ELSE to parse and to convert into a StateObject representation

      • removeCaseOperand

        public void removeCaseOperand()
        Removes the case operand.

      • setCaseOperand

        public void setCaseOperand​(StateObject caseOperand)
        Sets the case operand to be the given StateObject.
        Parameters:
        caseOperand - The StateObject representing the case operand or null to remove it

      • setElse

        public void setElse​(StateObject elseStateObject)
        Sets the ELSE scalar expression to be the given StateObject.
        Parameters:
        elseStateObject - The StateObject representing the ELSE scalar expression or null to remove it

      • setExpression

        public void setExpression​(CaseExpression 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 CASE expression

      • toTextInternal

        public void toTextInternal​(java.lang.Appendable writer)
                    throws java.io.IOException
        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:
        java.io.IOException - This should never happens, it is only required because Appendable is used instead of any concrete class