java.lang.Object
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
- - org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject<JoinStateObject>
  - - org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject

All Implemented Interfaces:

ListHolderStateObject<JoinStateObject>, StateObject, VariableDeclarationStateObject

Direct Known Subclasses:

DerivedPathIdentificationVariableDeclarationStateObject, IdentificationVariableDeclarationStateObject
```
public abstract class AbstractIdentificationVariableDeclarationStateObject
extends AbstractListHolderStateObject<JoinStateObject>
implements VariableDeclarationStateObject
```
Since:

2.4

Version:

2.5

Author:

Pascal Filion

Field Summary

Fields
Modifier and Type Field Description

static String JOINS_LIST
Notifies the content of the list of JoinStateObject has changed.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`JoinStateObject`	`addInnerJoin(String path, String identificationVariable)`	Adds a new `INNER JOIN` expression to this declaration.
`JoinStateObject`	`addJoin(String joinType)`	Adds a new `JOIN` expression to this declaration.
`JoinStateObject`	`addJoin(String path, String identificationVariable)`	Adds a new `JOIN` expression to this declaration.
`JoinStateObject`	`addJoin(String joinType, String path, String identificationVariable)`	Adds a new `JOIN` expression to this declaration.
`JoinStateObject`	`addJoin(String joinType, ListIterator<String> paths, String identificationVariable)`	Adds a new `JOIN` expression to this declaration.
`JoinStateObject`	`addLeftJoin(String path, String identificationVariable)`	Adds a new `LEFT JOIN` expression to this declaration.
`JoinStateObject`	`addLeftOuterJoin(String path, String identificationVariable)`	Adds a new `LEFT OUTER JOIN` expression to this declaration.
`IdentificationVariableDeclaration`	`getExpression()`	Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query.
`String`	`getIdentificationVariable()`	Returns the identification variable identifying the "root".
`IdentificationVariableStateObject`	`getIdentificationVariableStateObject()`	Returns the `IdentificationVariableStateObject` holding onto the identification variable.
`AbstractFromClauseStateObject`	`getParent()`	Returns the parent of this `StateObject`.
`AbstractRangeVariableDeclarationStateObject`	`getRangeVariableDeclaration()`	Returns the `StateObject` representing the range variable declaration portion.
`String`	`getRootPath()`	Returns the "root" object for objects which may not be reachable by navigation.
`StateObject`	`getRootStateObject()`	Returns the `StateObject` representing the "root" for objects which may not be reachable by navigation.
`ListIterable<IdentificationVariableStateObject>`	`identificationVariables()`	Returns the `IdentificationVariableStateObject` that are used by this state object.
`boolean`	`isEquivalent(StateObject stateObject)`	Determines whether the given `StateObject` is equivalent to this one, i.e.
`void`	`parseJoin(String jpqlFragment)`	Parses the given JPQL fragment that should contain a single `JOIN` expression.
`void`	`setExpression(IdentificationVariableDeclaration 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`.
`void`	`setIdentificationVariable(String identificationVariable)`	Sets the new identification variable that will range over the "root".
`void`	`setRootPath(String root)`	Sets the "root" object for objects which may not be reachable by navigation.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject
addItem, addItems, addListChangeListener, canMoveDown, canMoveUp, getItem, hasItems, items, itemsSize, moveDown, moveUp, removeItem, removeItems, removeListChangeListener

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, 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, addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText

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

- Field Detail
  - JOINS_LIST
```
public static final String JOINS_LIST
```
    Notifies the content of the list of JoinStateObject has changed.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - addInnerJoin
```
public JoinStateObject addInnerJoin(String path,
                                    String identificationVariable)
```
    Adds a new INNER JOIN expression to this declaration.
    
    Parameters:
    
    path - The join association path expression
    
    identificationVariable - The new variable defining the join association path
    
    Returns:
    
    A new JoinStateObject
  - addJoin
```
public JoinStateObject addJoin(String joinType)
```
    Adds a new JOIN expression to this declaration.
    
    Parameters:
    
    joinType - One of the joining types: LEFT JOIN, LEFT OUTER JOIN, INNER JOIN or JOIN
    
    Returns:
    
    A new JoinStateObject
  - addJoin
```
public JoinStateObject addJoin(String joinType,
                               ListIterator<String> paths,
                               String identificationVariable)
```
    Adds a new JOIN expression to this declaration.
    
    Parameters:
    
    joinType - One of the joining types: LEFT JOIN, LEFT OUTER JOIN, INNER JOIN or JOIN
    
    paths - The join association path expression
    
    identificationVariable - The new variable defining the join association path
    
    Returns:
    
    A new JoinStateObject
  - addJoin
```
public JoinStateObject addJoin(String path,
                               String identificationVariable)
```
    Adds a new JOIN expression to this declaration.
    
    Parameters:
    
    path - The join association path expression
    
    identificationVariable - The new variable defining the join association path
    
    Returns:
    
    A new JoinStateObject
  - addJoin
```
public JoinStateObject addJoin(String joinType,
                               String path,
                               String identificationVariable)
```
    Adds a new JOIN expression to this declaration.
    
    Parameters:
    
    joinType - One of the joining types: LEFT JOIN, LEFT OUTER JOIN, INNER JOIN or JOIN
    
    path - The join association path expression
    
    identificationVariable - The new variable defining the join association path
    
    Returns:
    
    A new JoinStateObject
  - addLeftJoin
```
public JoinStateObject addLeftJoin(String path,
                                   String identificationVariable)
```
    Adds a new LEFT JOIN expression to this declaration.
    
    Parameters:
    
    path - The join association path expression
    
    identificationVariable - The new variable defining the join association path
    
    Returns:
    
    A new JoinStateObject
  - addLeftOuterJoin
```
public JoinStateObject addLeftOuterJoin(String path,
                                        String identificationVariable)
```
    Adds a new LEFT OUTER JOIN expression to this declaration.
    
    Parameters:
    
    path - The join association path expression
    
    identificationVariable - The new variable defining the join association path
    
    Returns:
    
    A new JoinStateObject
  - getExpression
```
public IdentificationVariableDeclaration 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)
  - getIdentificationVariable
```
public String getIdentificationVariable()
```
    Returns the identification variable identifying the "root".
    
    Returns:
    
    A case insensitive unique identifier declaring the "root" of the declaration
  - getIdentificationVariableStateObject
```
public IdentificationVariableStateObject getIdentificationVariableStateObject()
```
    Returns the IdentificationVariableStateObject holding onto the identification variable.
    
    Returns:
    
    The IdentificationVariableStateObject, which is never null
  - getParent
```
public AbstractFromClauseStateObject getParent()
```
    Returns the parent of this StateObject.
    
    Specified by:
    
    getParent in interface StateObject
    
    Overrides:
    
    getParent in class AbstractStateObject
    
    Returns:
    
    Returns the parent of this StateObject, which is null only when this is the root of the hierarchy
  - getRangeVariableDeclaration
```
public AbstractRangeVariableDeclarationStateObject getRangeVariableDeclaration()
```
    Returns the StateObject representing the range variable declaration portion.
    
    Returns:
    
    The concrete instance
  - getRootPath
```
public String getRootPath()
```
    Returns the "root" object for objects which may not be reachable by navigation.
    
    Returns:
    
    The "root" object
  - getRootStateObject
```
public StateObject getRootStateObject()
```
    Returns the StateObject representing the "root" for objects which may not be reachable by navigation.
    
    Returns:
    
    The StateObject representing one of the possible valid "root"
  - identificationVariables
```
public ListIterable<IdentificationVariableStateObject> identificationVariables()
```
    Returns the IdentificationVariableStateObject that are used by this state object. It is possible more than one declaration exists, like a range variable declaration has also joins and join fetches.
    
    Specified by:
    
    identificationVariables in interface VariableDeclarationStateObject
    
    Returns:
    
    The list of IdentificationVariableStateObject
  - 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
  - parseJoin
```
public void parseJoin(String jpqlFragment)
```
    Parses the given JPQL fragment that should contain a single JOIN expression.
    
    Parameters:
    
    jpqlFragment - The portion representing a JOIN expression
  - setExpression
```
public void setExpression(IdentificationVariableDeclaration 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 an identification variable declaration
  - setIdentificationVariable
```
public void setIdentificationVariable(String identificationVariable)
```
    Sets the new identification variable that will range over the "root".
    
    Parameters:
    
    identificationVariable - The new identification variable
  - setRootPath
```
public void setRootPath(String root)
```
    Sets the "root" object for objects which may not be reachable by navigation.
    
    Parameters:
    
    root - The "root" object

Class AbstractIdentificationVariableDeclarationStateObject

Field Summary

Method Summary

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

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

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

Field Detail

JOINS_LIST

Method Detail

addInnerJoin

addJoin

addJoin

addJoin

addJoin

addLeftJoin

addLeftOuterJoin

getExpression

getIdentificationVariable

getIdentificationVariableStateObject

getParent

getRangeVariableDeclaration

getRootPath

getRootStateObject

identificationVariables

isEquivalent

parseJoin

setExpression

setIdentificationVariable

setRootPath