EclipseLink 2.5.0, build 'v20130425-368d603' API Reference

org.eclipse.persistence.jpa.jpql.tools.resolver
Class DerivedDeclaration

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.tools.resolver.Declaration
      extended by org.eclipse.persistence.jpa.jpql.tools.resolver.AbstractRangeDeclaration
          extended by org.eclipse.persistence.jpa.jpql.tools.resolver.DerivedDeclaration
All Implemented Interfaces:
JPQLQueryDeclaration

public class DerivedDeclaration
extends AbstractRangeDeclaration

This DerivedDeclaration represents an identification variable declaration that was declared in the FROM clause of a SELECT subquery. The "root" object is not an entity name but a derived path expression.

Version:
2.5
See Also:
IdentificationVariableDeclaration
Author:
Pascal Filion
Since:
2.5

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.persistence.jpa.jpql.JPQLQueryDeclaration
JPQLQueryDeclaration.Type
 
Field Summary
 
Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.resolver.AbstractRangeDeclaration
joins
 
Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.resolver.Declaration
baseExpression, declarationExpression, identificationVariable, rootPath
 
Constructor Summary
DerivedDeclaration()
          Creates a new DerivedDeclaration.
 
Method Summary
 java.lang.String getSuperqueryVariableName()
          If #isDerived() is true, then returns the identification variable used in the derived path expression that is defined in the superquery, otherwise returns an empty string.
 JPQLQueryDeclaration.Type getType()
          Determines the type this declaration represents.
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.resolver.AbstractRangeDeclaration
addJoin, getJoins, hasJoins
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.resolver.Declaration
getBaseExpression, getDeclarationExpression, getIdentificationVariable, getRootPath, getVariableName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DerivedDeclaration

public DerivedDeclaration()
Creates a new DerivedDeclaration.

Method Detail

getSuperqueryVariableName

public java.lang.String getSuperqueryVariableName()
If #isDerived() is true, then returns the identification variable used in the derived path expression that is defined in the superquery, otherwise returns an empty string.

Returns:
The identification variable from the superquery if the root path is a derived path expression

getType

public JPQLQueryDeclaration.Type getType()
Determines the type this declaration represents.

Returns:
One of the possible types

EclipseLink 2.5.0, build 'v20130425-368d603' API Reference