Top Description Fields Constructors Methods
org.hibernate.hql.ast.tree

public abstract Class FromReferenceNode

extends AbstractSelectExpression
implements ResolvableNode, DisplayableNode, InitializeableNode, PathNode
Class Inheritance
All Implemented Interfaces
org.hibernate.hql.ast.tree.PathNode, org.hibernate.hql.ast.tree.InitializeableNode, org.hibernate.hql.ast.tree.DisplayableNode, org.hibernate.hql.ast.tree.ResolvableNode
Known Direct Subclasses
org.hibernate.hql.ast.tree.IdentNode, org.hibernate.hql.ast.tree.IndexNode, org.hibernate.hql.ast.tree.AbstractMapComponentNode, org.hibernate.hql.ast.tree.SelectExpressionImpl, org.hibernate.hql.ast.tree.DotNode
Imports
antlr.SemanticException, antlr.collections.AST, org.slf4j.Logger, .LoggerFactory
Represents a reference to a FROM element, for example a class alias in a WHERE clause.
Author
josh

Field Summary

Modifier and TypeField and Description
private FromElement
fromElement

Deprecated as a consequence of FromElement being deprecated.
private static final Logger
log

private boolean
resolved

public static final int
ROOT_LEVEL

Constructor Summary

AccessConstructor and Description
public
FromReferenceNode()

Method Summary

Modifier and TypeMethod and Description
public String
getDisplayText()

Implements org.hibernate.hql.ast.tree.DisplayableNode.getDisplayText.

Returns additional display text for the AST node.
public FromElement
getFromElement()

Overrides org.hibernate.hql.ast.tree.AbstractSelectExpression.getFromElement.

Implements org.hibernate.hql.ast.tree.SelectExpression.getFromElement.

Deprecated as a consequence of FromElement being deprecated.
Returns the FROM element that this expression refers to.
public FromElement

Returns:

an implied join created by this from reference.
getImpliedJoin()

Deprecated as a consequence of FromElement being deprecated.
Sub-classes can override this method if they produce implied joins (e.g. DotNode).
public String
getPath()

Implements org.hibernate.hql.ast.tree.PathNode.getPath.

Returns the full path name represented by the node.
public boolean
isResolved()

public boolean
isReturnableEntity()

Overrides org.hibernate.hql.ast.tree.AbstractSelectExpression.isReturnableEntity.

Implements org.hibernate.hql.ast.tree.SelectExpression.isReturnableEntity.

Returns true if this select expression represents an entity that can be returned.
public void
prepareForDot(String propertyName)

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

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

public void
resolve(boolean generateJoin, boolean implicitJoin)

Implements org.hibernate.hql.ast.tree.ResolvableNode.resolve.

Does the work of resolving an identifier or a dot, but without a parent node or alias
public void
resolve(boolean generateJoin, boolean implicitJoin, String classAlias)

Implements org.hibernate.hql.ast.tree.ResolvableNode.resolve.

Does the work of resolving an identifier or a dot, but without a parent node
public void
resolveFirstChild()

Resolves the left hand side of the DOT.

public void
resolveInFunctionCall(boolean generateJoin, boolean implicitJoin)

Implements org.hibernate.hql.ast.tree.ResolvableNode.resolveInFunctionCall.

Does the work of resolving inside of the scope of a function call
public void
setFromElement(FromElement fromElement)

Deprecated as a consequence of FromElement being deprecated.
public void
setResolved()

Inherited from org.hibernate.hql.ast.tree.AbstractSelectExpression:
getAliasgetScalarColumnIndexisConstructorisScalarsetAliassetScalarColumn

Field Detail

fromElementback to summary
private FromElement fromElement

Deprecated

as a consequence of FromElement being deprecated. See corresponding docs for further information.

logback to summary
private static final Logger log
resolvedback to summary
private boolean resolved
ROOT_LEVELback to summary
public static final int ROOT_LEVEL

Constructor Detail

FromReferenceNodeback to summary
public FromReferenceNode()

Method Detail

getDisplayTextback to summary
public String getDisplayText()

Implements org.hibernate.hql.ast.tree.DisplayableNode.getDisplayText.

Doc from org.hibernate.hql.ast.tree.DisplayableNode.getDisplayText.

Returns additional display text for the AST node.

Returns:String

String - The additional display text.

getFromElementback to summary
public FromElement getFromElement()

Overrides org.hibernate.hql.ast.tree.AbstractSelectExpression.getFromElement.

Implements org.hibernate.hql.ast.tree.SelectExpression.getFromElement.

Doc from org.hibernate.hql.ast.tree.SelectExpression.getFromElement.

Deprecated

as a consequence of FromElement being deprecated. See corresponding docs for further information.

Returns the FROM element that this expression refers to.

Returns:FromElement

The FROM element.

getImpliedJoinback to summary
public FromElement getImpliedJoin()

Deprecated

as a consequence of FromElement being deprecated. See corresponding docs for further information.

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

Returns:FromElement

an implied join created by this from reference.

getPathback to summary
public String getPath()

Implements org.hibernate.hql.ast.tree.PathNode.getPath.

Doc from org.hibernate.hql.ast.tree.PathNode.getPath.

Returns the full path name represented by the node.

Returns:String

the full path name represented by the node.

isResolvedback to summary
public boolean isResolved()
isReturnableEntityback to summary
public boolean isReturnableEntity() throws SemanticException

Overrides org.hibernate.hql.ast.tree.AbstractSelectExpression.isReturnableEntity.

Implements org.hibernate.hql.ast.tree.SelectExpression.isReturnableEntity.

Doc from org.hibernate.hql.ast.tree.SelectExpression.isReturnableEntity.

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

Returns:boolean

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

prepareForDotback to summary
public void prepareForDot(String propertyName) throws SemanticException
recursiveResolveback to summary
public void recursiveResolve(int level, boolean impliedAtRoot, String classAlias) throws SemanticException
recursiveResolveback to summary
public void recursiveResolve(int level, boolean impliedAtRoot, String classAlias, AST parent) throws SemanticException
resolveback to summary
public void resolve(boolean generateJoin, boolean implicitJoin) throws SemanticException

Implements org.hibernate.hql.ast.tree.ResolvableNode.resolve.

Doc from org.hibernate.hql.ast.tree.ResolvableNode.resolve.

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

resolveback to summary
public void resolve(boolean generateJoin, boolean implicitJoin, String classAlias) throws SemanticException

Implements org.hibernate.hql.ast.tree.ResolvableNode.resolve.

Doc from org.hibernate.hql.ast.tree.ResolvableNode.resolve.

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

resolveFirstChildback to summary
public void resolveFirstChild() throws SemanticException

Resolves the left hand side of the DOT.

resolveInFunctionCallback to summary
public void resolveInFunctionCall(boolean generateJoin, boolean implicitJoin) throws SemanticException

Implements org.hibernate.hql.ast.tree.ResolvableNode.resolveInFunctionCall.

Doc from org.hibernate.hql.ast.tree.ResolvableNode.resolveInFunctionCall.

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

setFromElementback to summary
public void setFromElement(FromElement fromElement)

Deprecated

as a consequence of FromElement being deprecated. See corresponding docs for further information.

setResolvedback to summary
public void setResolved()