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.AbstractTripleEncapsulatedExpressionStateObject
    - - org.eclipse.persistence.jpa.jpql.tools.model.query.SubstringExpressionStateObject

All Implemented Interfaces:

StateObject
```
public class SubstringExpressionStateObject
extends AbstractTripleEncapsulatedExpressionStateObject
```
The second and third arguments of the SUBSTRING function denote the starting position and length of the substring to be returned. These arguments are integers. The first position of a string is denoted by 1. The SUBSTRING function returns a string.
JPA 1.0:
BNF ::= SUBSTRING(string_primary, simple_arithmetic_expression, simple_arithmetic_expression)
JPA 2.0:
BNF ::= SUBSTRING(string_primary, simple_arithmetic_expression [, simple_arithmetic_expression])

Since:

2.4

Version:

2.4

Author:

Pascal Filion

See Also:

SubstringExpression

Field Summary
- Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractTripleEncapsulatedExpressionStateObject
  FIRST_STATE_OBJECT_PROPERTY, SECOND_STATE_OBJECT_PROPERTY, THIRD_STATE_OBJECT_PROPERTY

Constructor Summary

Constructors
Constructor	Description
`SubstringExpressionStateObject(StateObject parent)`	Creates a new `SubstringExpressionStateObject`.
`SubstringExpressionStateObject(StateObject parent, String firstJpqlFragment, String secondJpqlFragment)`	Creates a new `SubstringExpressionStateObject`.
`SubstringExpressionStateObject(StateObject parent, String firstJpqlFragment, String secondJpqlFragment, String thirdJpqlFragment)`	Creates a new `SubstringExpressionStateObject`.
`SubstringExpressionStateObject(StateObject parent, StateObject firstStateObject, StateObject secondStateObject)`	Creates a new `SubstringExpressionStateObject`.
`SubstringExpressionStateObject(StateObject parent, StateObject firstStateObject, StateObject secondStateObject, StateObject thirdStateObject)`	Creates a new `SubstringExpressionStateObject`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(StateObjectVisitor visitor)`	Visits this `StateObject` by the given `visitor`.
`SubstringExpression`	`getExpression()`	Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query.
`String`	`getIdentifier()`	Returns the JPQL identifier of the expression represented by this `AbstractSingleEncapsulatedExpressionStateObject`.
`void`	`setExpression(SubstringExpression 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`.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractTripleEncapsulatedExpressionStateObject
getFirst, getSecond, getThird, hasFirst, hasSecond, hasThird, isEquivalent, parseFirst, parseSecond, parseThird, setFirst, setSecond, setThird

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

- Constructor Detail
  - SubstringExpressionStateObject
```
public SubstringExpressionStateObject(StateObject parent)
```
    Creates a new SubstringExpressionStateObject.
    
    Parameters:
    
    parent - The parent of this state object, which cannot be null
    
    Throws:
    
    NullPointerException - The given parent cannot be null
  - SubstringExpressionStateObject
```
public SubstringExpressionStateObject(StateObject parent,
                                      StateObject firstStateObject,
                                      StateObject secondStateObject)
```
    Creates a new SubstringExpressionStateObject.
    
    Parameters:
    
    parent - The parent of this state object, which cannot be null
    
    firstStateObject - The StateObject of the first expression
    
    secondStateObject - The StateObject of the second expression
    
    Throws:
    
    NullPointerException - The given parent cannot be null
  - SubstringExpressionStateObject
```
public SubstringExpressionStateObject(StateObject parent,
                                      StateObject firstStateObject,
                                      StateObject secondStateObject,
                                      StateObject thirdStateObject)
```
    Creates a new SubstringExpressionStateObject.
    
    Parameters:
    
    parent - The parent of this state object, which cannot be null
    
    firstStateObject - The StateObject of the first expression
    
    secondStateObject - The StateObject of the second expression
    
    thirdStateObject - The StateObject of the third encapsulated expression
    
    Throws:
    
    NullPointerException - The given parent cannot be null
  - SubstringExpressionStateObject
```
public SubstringExpressionStateObject(StateObject parent,
                                      String firstJpqlFragment,
                                      String secondJpqlFragment)
```
    Creates a new SubstringExpressionStateObject.
    
    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
  - SubstringExpressionStateObject
```
public SubstringExpressionStateObject(StateObject parent,
                                      String firstJpqlFragment,
                                      String secondJpqlFragment,
                                      String thirdJpqlFragment)
```
    Creates a new SubstringExpressionStateObject.
    
    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
    
    thirdJpqlFragment - The string representation of the third encapsulated expression to parse and to convert into a StateObject representation
    
    Throws:
    
    NullPointerException - The given parent cannot be null
- Method Detail
  - accept
```
public void accept(StateObjectVisitor visitor)
```
    Visits this StateObject by the given visitor.
    
    Parameters:
    
    visitor - The visitor to visit this object
  - getExpression
```
public SubstringExpression 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 AbstractTripleEncapsulatedExpressionStateObject
    
    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)
  - getIdentifier
```
public String getIdentifier()
```
    Returns the JPQL identifier of the expression represented by this AbstractSingleEncapsulatedExpressionStateObject.
    
    Specified by:
    
    getIdentifier in class AbstractEncapsulatedExpressionStateObject
    
    Returns:
    
    The JPQL identifier that is shown before the left parenthesis
  - setExpression
```
public void setExpression(SubstringExpression 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 SUBSTRING expression

Class SubstringExpressionStateObject

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractTripleEncapsulatedExpressionStateObject

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

SubstringExpressionStateObject

SubstringExpressionStateObject

SubstringExpressionStateObject

SubstringExpressionStateObject

SubstringExpressionStateObject

Method Detail

accept

getExpression

getIdentifier

setExpression