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.AbstractSingleEncapsulatedExpressionStateObject

All Implemented Interfaces:

StateObject

Direct Known Subclasses:

AbsExpressionStateObject, AggregateFunctionStateObject, AllOrAnyExpressionStateObject, EncapsulatedIdentificationVariableExpressionStateObject, ExistsExpressionStateObject, LengthExpressionStateObject, LowerExpressionStateObject, SizeExpressionStateObject, SqrtExpressionStateObject, SubExpressionStateObject, TrimExpressionStateObject, TypeExpressionStateObject, UpperExpressionStateObject
```
public abstract class AbstractSingleEncapsulatedExpressionStateObject
extends AbstractEncapsulatedExpressionStateObject
```
This StateObject represents a JPQL expression that has a JPQL identifier followed by an encapsulated expression with parenthesis.
BNF: expression ::= <identifier>(expression)

Since:

2.4

Version:

2.4

Author:

Pascal Filion

See Also:

AbstractSingleEncapsulatedExpression

Field Summary

Fields
Modifier and Type Field Description

static String STATE_OBJECT_PROPERTY
Notifies the encapsulated StateObject has changed.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AbstractSingleEncapsulatedExpression`	`getExpression()`	Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query.
`StateObject`	`getStateObject()`	Returns the encapsulated `StateObject`.
`boolean`	`hasStateObject()`	Determines whether the `StateObject` representing the encapsulated expression is present or not.
`boolean`	`isEquivalent(StateObject stateObject)`	Determines whether the given `StateObject` is equivalent to this one, i.e.
`void`	`parse(String jpqlFragment)`	Parses the given JPQL fragment, which represents the encapsulated expression, and creates the `StateObject`.

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

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, 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
  - STATE_OBJECT_PROPERTY
```
public static final String STATE_OBJECT_PROPERTY
```
    Notifies the encapsulated StateObject has changed.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getExpression
```
public AbstractSingleEncapsulatedExpression 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 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)
  - getStateObject
```
public StateObject getStateObject()
```
    Returns the encapsulated StateObject.
    
    Returns:
    
    The encapsulated StateObject
  - hasStateObject
```
public boolean hasStateObject()
```
    Determines whether the StateObject representing the encapsulated expression is present or not.
    
    Returns:
    
    true if the encapsulated StateObject 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
  - parse
```
public void parse(String jpqlFragment)
```
    Parses the given JPQL fragment, which represents the encapsulated expression, and creates the StateObject.
    
    Parameters:
    
    jpqlFragment - The portion of the query representing the encapsulated expression

Class AbstractSingleEncapsulatedExpressionStateObject

Field Summary

Method Summary

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

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

STATE_OBJECT_PROPERTY

Method Detail

getExpression

getStateObject

hasStateObject

isEquivalent

parse