Top Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.tools.model.query

public Class DerivedPathIdentificationVariableDeclarationStateObject

extends AbstractIdentificationVariableDeclarationStateObject
Class Inheritance
Imports
org.eclipse.persistence.jpa.jpql.tools.spi.IManagedType, org.eclipse.persistence.jpa.jpql.utility.iterable.ListIterable
Author
Pascal Filion
Since
2.4
Version
2.5

Field Summary

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject:
JOINS_LIST

Constructor Summary

AccessConstructor and Description
public
DerivedPathIdentificationVariableDeclarationStateObject(SimpleFromClauseStateObject
The parent of this state object, which cannot be null
parent)

Creates a new IdentificationVariableDeclarationStateObject.

public
DerivedPathIdentificationVariableDeclarationStateObject(SimpleFromClauseStateObject
The parent of this state object, which cannot be null
parent, String
Either the derived singled-valued object field or the collection-valued path expression
path, String
The identification variable defining the given path
identificationVariable)

Creates a new IdentificationVariableDeclarationStateObject.

Method Summary

Modifier and TypeMethod and Description
public void
accept(StateObjectVisitor
The visitor to visit this object
visitor)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept.

Visits this StateObject by the given visitor.
protected AbstractRangeVariableDeclarationStateObject
buildRangeVariableDeclarationStateObject()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject.buildRangeVariableDeclarationStateObject.

Creates
public IManagedType
getManagedType(StateObject
The StateObject that should be an simple identification variable or an encapsulated identification variable with the identifier KEY or VALUE
stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.VariableDeclarationStateObject.getManagedType.

Returns the IManagedType for the given identification variable.
public SimpleFromClauseStateObject
getParent()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject.getParent.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getParent.

Returns the parent of this StateObject.
public String

Returns:

The path expression, which is never null
getPath()

Returns the string representation of the path expression, which is either a singled-valued object field or a collection-valued path expression.

public DerivedPathVariableDeclarationStateObject
getRangeVariableDeclaration()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject.getRangeVariableDeclaration.

Returns the StateObject representing the range variable declaration portion.
public CollectionValuedPathExpressionStateObject
getRootStateObject()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject.getRootStateObject.

Returns the StateObject representing the "root" for objects which may not be reachable by navigation.
public ListIterable<JoinStateObject>
items()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.items.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.items.

Returns an ListIterable over the children.
Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject:
addChildrenaddInnerJoinaddJoinaddJoinaddJoinaddJoinaddLeftJoinaddLeftOuterJoingetExpressiongetIdentificationVariablegetIdentificationVariableStateObjectgetRootPathidentificationVariablesinitializeisEquivalentlistNameparseJoinsetExpressionsetIdentificationVariablesetRootPathtoTextInternal

Constructor Detail

DerivedPathIdentificationVariableDeclarationStateObjectback to summary
public DerivedPathIdentificationVariableDeclarationStateObject(SimpleFromClauseStateObject parent)

Creates a new IdentificationVariableDeclarationStateObject.

Parameters
parent:SimpleFromClauseStateObject

The parent of this state object, which cannot be null

Exceptions
NullPointerException:
The given parent cannot be null
DerivedPathIdentificationVariableDeclarationStateObjectback to summary
public DerivedPathIdentificationVariableDeclarationStateObject(SimpleFromClauseStateObject parent, String path, String identificationVariable)

Creates a new IdentificationVariableDeclarationStateObject.

Parameters
parent:SimpleFromClauseStateObject

The parent of this state object, which cannot be null

path:String

Either the derived singled-valued object field or the collection-valued path expression

identificationVariable:String

The identification variable defining the given path

Exceptions
NullPointerException:
The given parent cannot be null

Method Detail

acceptback to summary
public void accept(StateObjectVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept.

Visits this StateObject by the given visitor.

Parameters
visitor:StateObjectVisitor

The visitor to visit this object

Annotations
@Override
buildRangeVariableDeclarationStateObjectback to summary
protected AbstractRangeVariableDeclarationStateObject buildRangeVariableDeclarationStateObject()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject.buildRangeVariableDeclarationStateObject.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject.buildRangeVariableDeclarationStateObject.

Creates

Annotations
@Override
getManagedTypeback to summary
public IManagedType getManagedType(StateObject stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.VariableDeclarationStateObject.getManagedType.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.VariableDeclarationStateObject.getManagedType.

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:StateObject

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

Returns:IManagedType

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

Annotations
@Override
getParentback to summary
public SimpleFromClauseStateObject getParent()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject.getParent.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getParent.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getParent.

Returns the parent of this StateObject.

Returns:SimpleFromClauseStateObject

Returns the parent of this StateObject, which is null only when this is the root of the hierarchy

Annotations
@Override
getPathback to summary
public String getPath()

Returns the string representation of the path expression, which is either a singled-valued object field or a collection-valued path expression.

Returns:String

The path expression, which is never null

getRangeVariableDeclarationback to summary
public DerivedPathVariableDeclarationStateObject getRangeVariableDeclaration()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject.getRangeVariableDeclaration.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject.getRangeVariableDeclaration.

Returns the StateObject representing the range variable declaration portion.

Returns:DerivedPathVariableDeclarationStateObject

The concrete instance

Annotations
@Override
getRootStateObjectback to summary
public CollectionValuedPathExpressionStateObject getRootStateObject()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject.getRootStateObject.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractIdentificationVariableDeclarationStateObject.getRootStateObject.

Returns the StateObject representing the "root" for objects which may not be reachable by navigation.

Returns:CollectionValuedPathExpressionStateObject

The StateObject representing one of the possible valid "root"

Annotations
@Override
itemsback to summary
public ListIterable<JoinStateObject> items()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.items.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.items.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.items.

Returns an ListIterable over the children.

Returns:ListIterable<JoinStateObject>

An ListIterable that is iterating over the children

Annotations
@Override
@SuppressWarnings:unchecked