public abstract class

FromReferenceNode

extends AbstractSelectExpression
implements DisplayableNode InitializeableNode PathNode ResolvableNode
java.lang.Object
   ↳ antlr.CommonAST
     ↳ org.hibernate.hql.ast.tree.Node
       ↳ org.hibernate.hql.ast.tree.SqlNode
         ↳ org.hibernate.hql.ast.tree.HqlSqlWalkerNode
           ↳ org.hibernate.hql.ast.tree.AbstractSelectExpression
             ↳ org.hibernate.hql.ast.tree.FromReferenceNode
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Represents a reference to a FROM element, for example a class alias in a WHERE clause.

Summary

Constants
int ROOT_LEVEL
Public Constructors
FromReferenceNode()
Public Methods
String getDisplayText()
Returns additional display text for the AST node.
FromElement getFromElement()
Returns the FROM element that this expression refers to.
FromElement getImpliedJoin()
Sub-classes can override this method if they produce implied joins (e.g.
String getPath()
Returns the full path name represented by the node.
boolean isResolved()
boolean isReturnableEntity()
Returns true if this select expression represents an entity that can be returned.
void prepareForDot(String propertyName)
void recursiveResolve(int level, boolean impliedAtRoot, String classAlias, AST parent)
void recursiveResolve(int level, boolean impliedAtRoot, String classAlias)
void resolve(boolean generateJoin, boolean implicitJoin)
Does the work of resolving an identifier or a dot, but without a parent node or alias
void resolve(boolean generateJoin, boolean implicitJoin, String classAlias)
Does the work of resolving an identifier or a dot, but without a parent node
void resolveFirstChild()
Resolves the left hand side of the DOT.
void resolveInFunctionCall(boolean generateJoin, boolean implicitJoin)
Does the work of resolving inside of the scope of a function call
void setFromElement(FromElement fromElement)
void setResolved()
[Expand]
Inherited Methods
From class org.hibernate.hql.ast.tree.AbstractSelectExpression
From class org.hibernate.hql.ast.tree.HqlSqlWalkerNode
From class org.hibernate.hql.ast.tree.SqlNode
From class org.hibernate.hql.ast.tree.Node
From class java.lang.Object
From interface org.hibernate.hql.ast.tree.DisplayableNode
From interface org.hibernate.hql.ast.tree.InitializeableNode
From interface org.hibernate.hql.ast.tree.PathNode
From interface org.hibernate.hql.ast.tree.ResolvableNode
From interface org.hibernate.hql.ast.tree.SelectExpression

Constants

public static final int ROOT_LEVEL

Constant Value: 0 (0x00000000)

Public Constructors

public FromReferenceNode ()

Public Methods

public String getDisplayText ()

Returns additional display text for the AST node.

Returns
  • String - The additional display text.

public FromElement getFromElement ()

Returns the FROM element that this expression refers to.

Returns
  • The FROM element.

public FromElement getImpliedJoin ()

Sub-classes can override this method if they produce implied joins (e.g. DotNode).

Returns
  • an implied join created by this from reference.

public String getPath ()

Returns the full path name represented by the node.

Returns
  • the full path name represented by the node.

public boolean isResolved ()

public boolean isReturnableEntity ()

Returns true if this select expression represents an entity that can be returned.

Returns
  • true if this select expression represents an entity that can be returned.
Throws
SemanticException

public void prepareForDot (String propertyName)

Throws
SemanticException

public void recursiveResolve (int level, boolean impliedAtRoot, String classAlias, AST parent)

Throws
SemanticException

public void recursiveResolve (int level, boolean impliedAtRoot, String classAlias)

Throws
SemanticException

public void resolve (boolean generateJoin, boolean implicitJoin)

Does the work of resolving an identifier or a dot, but without a parent node or alias

Throws
SemanticException

public void resolve (boolean generateJoin, boolean implicitJoin, String classAlias)

Does the work of resolving an identifier or a dot, but without a parent node

Throws
SemanticException

public void resolveFirstChild ()

Resolves the left hand side of the DOT.

Throws
SemanticException

public void resolveInFunctionCall (boolean generateJoin, boolean implicitJoin)

Does the work of resolving inside of the scope of a function call

Throws
SemanticException

public void setFromElement (FromElement fromElement)

public void setResolved ()