java.lang.Object
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
- - org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractConditionalClauseStateObject

All Implemented Interfaces:

StateObject

Direct Known Subclasses:

HavingClauseStateObject, WhenClauseStateObject, WhereClauseStateObject
```
public abstract class AbstractConditionalClauseStateObject
extends AbstractStateObject
```
Conditional expressions are composed of other conditional expressions, comparison operations, logical operations, path expressions that evaluate to boolean values, boolean literals, and boolean input parameters. Arithmetic expressions can be used in comparison expressions. Arithmetic expressions are composed of other arithmetic expressions, arithmetic operations, path expressions that evaluate to numeric values, numeric literals, and numeric input parameters. Arithmetic operations use numeric promotion. Standard bracketing () for ordering expression evaluation is supported.
BNF: expression ::= identifier conditional_expression

Since:

2.4

Version:

2.4

Author:

Pascal Filion

See Also:

AbstractConditionalClause

Field Summary

Fields
Modifier and Type Field Description

static String CONDITIONAL_STATE_OBJECT_PROPERTY
Notifies the conditional expression property has changed.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`AndExpressionStateObject`	`andParse(String jpqlFragment)`	Parses the given JPQL fragment as the right side of an `AND` expression.
`IConditionalExpressionStateObjectBuilder`	`getBuilder()`	Creates and returns a new `IConditionalExpressionStateObjectBuilder` that can be used to programmatically create a conditional expression and once the expression is complete, `IConditionalExpressionStateObjectBuilder.commit()` will push the `StateObject` representation of that expression as this clause's conditional expression.
`StateObject`	`getConditional()`	Returns the state object representing the composition of the conditional expressions.
`abstract String`	`getIdentifier()`	Returns the JPQL identifier of this clause.
`boolean`	`hasConditional()`	Determines whether the `StateObject` representing the conditional expression is present or not.
`boolean`	`isEquivalent(StateObject stateObject)`	Determines whether the given `StateObject` is equivalent to this one, i.e.
`OrExpressionStateObject`	`orParse(String jpqlFragment)`	Parses the given JPQL fragment as the right side of an `OR` expression.
`void`	`parse(String jpqlFragment)`	Parses the given JPQL fragment, which represents a conditional expression, and creates the `StateObject`.
`void`	`setConditional(StateObject conditionalStateObject)`	Sets the given `StateObject` to be the conditional expression of this clause.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getExpression, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, removePropertyChangeListener, setExpression, setParent, toString, toString, toText

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject
accept

- Field Detail
  - CONDITIONAL_STATE_OBJECT_PROPERTY
```
public static final String CONDITIONAL_STATE_OBJECT_PROPERTY
```
    Notifies the conditional expression property has changed.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - andParse
```
public AndExpressionStateObject andParse(String jpqlFragment)
```
    Parses the given JPQL fragment as the right side of an AND expression. The current conditional expression will become the left side of the AND expression.
    
    Parameters:
    
    jpqlFragment - The portion of the query representing the right side of the AND expression
    
    Returns:
    
    The newly created AndExpressionStateObject
  - getBuilder
```
public IConditionalExpressionStateObjectBuilder getBuilder()
```
    Creates and returns a new IConditionalExpressionStateObjectBuilder that can be used to programmatically create a conditional expression and once the expression is complete, IConditionalExpressionStateObjectBuilder.commit() will push the StateObject representation of that expression as this clause's conditional expression.
    
    Returns:
    
    A new builder that can be used to quickly create a conditional expression
  - getConditional
```
public StateObject getConditional()
```
    Returns the state object representing the composition of the conditional expressions.
    
    Returns:
    
    The actual conditional expression
  - getIdentifier
```
public abstract String getIdentifier()
```
    Returns the JPQL identifier of this clause.
    
    Returns:
    
    The JPQL identifier of this conditional clause
  - hasConditional
```
public boolean hasConditional()
```
    Determines whether the StateObject representing the conditional expression is present or not.
    
    Returns:
    
    true if the conditional expression is not null; false otherwise
  - isEquivalent
```
public boolean isEquivalent(StateObject 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
  - orParse
```
public OrExpressionStateObject orParse(String jpqlFragment)
```
    Parses the given JPQL fragment as the right side of an OR expression. The current conditional expression will become the left side of the OR expression.
    
    Parameters:
    
    jpqlFragment - The portion of the query representing the right side of the OR expression
    
    Returns:
    
    The newly created OrExpressionStateObject
  - parse
```
public void parse(String jpqlFragment)
```
    Parses the given JPQL fragment, which represents a conditional expression, and creates the StateObject.
    
    Parameters:
    
    jpqlFragment - The portion of the query representing a conditional expression
  - setConditional
```
public void setConditional(StateObject conditionalStateObject)
```
    Sets the given StateObject to be the conditional expression of this clause.
    
    Parameters:
    
    conditionalStateObject - The new StateObject representing the conditional expression

Class AbstractConditionalClauseStateObject

Field Summary

Method Summary

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject

Field Detail

CONDITIONAL_STATE_OBJECT_PROPERTY

Method Detail

andParse

getBuilder

getConditional

getIdentifier

hasConditional

isEquivalent

orParse

parse

setConditional