Module org.eclipse.persistence.jpa.jpql

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

Interface VariableDeclarationStateObject

All Superinterfaces:

StateObject

All Known Implementing Classes:

AbstractIdentificationVariableDeclarationStateObject, AbstractRangeVariableDeclarationStateObject, CollectionMemberDeclarationStateObject, DerivedPathIdentificationVariableDeclarationStateObject, DerivedPathVariableDeclarationStateObject, IdentificationVariableDeclarationStateObject, RangeVariableDeclarationStateObject

public interface VariableDeclarationStateObject
extends StateObject

This defines a variable declaration, which has a "root" object and an identification variable.

Since:

2.4

Version:

2.5

See Also:

• CollectionMemberDeclarationStateObject
• DerivedPathIdentificationVariableDeclarationStateObject
• DerivedPathVariableDeclarationStateObject
• IdentificationVariableDeclarationStateObject
• RangeVariableDeclarationStateObject

Method Summary

Modifier and Type	Method	Description
IManagedType	getManagedType(StateObject stateObject)	Returns the IManagedType for the given identification variable.
ListIterable<IdentificationVariableStateObject>	identificationVariables()	Returns the IdentificationVariableStateObject that are used by this state object.

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

accept, addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getExpression, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, isDecorated, isEquivalent, removePropertyChangeListener, setParent, toString, toText

Method Details

getManagedType

IManagedType getManagedType(StateObject stateObject)

Returns the IManagedType for the given identification variable. The search does not traverse up the query hierarchy if this declaration is for a subquery.

SELECT e FROM Department d JOIN KEY(d.employees).addresses a

In the above query, the managed type associated with the identification variable:

• d is "Department"
• a is "Address"

Parameters:

stateObject - The StateObject that should be an simple identification variable or an encapsulated identification variable with the identifier KEY or VALUE

Returns:

The IManagedType representing the domain object declared by the given identification variable

identificationVariables

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.

Returns:

The list of IdentificationVariableStateObject