public class

SqlFragment

extends Node
implements ParameterContainer
java.lang.Object
   ↳ antlr.CommonAST
     ↳ org.hibernate.hql.ast.tree.Node
       ↳ org.hibernate.hql.ast.tree.SqlFragment

Class Overview

Represents an SQL fragment in the AST.

Summary

Public Constructors
SqlFragment()
Public Methods
void addEmbeddedParameter(ParameterSpecification specification)
Adds a parameter specification for a parameter encountered within this node.
ParameterSpecification[] getEmbeddedParameters()
Retrieve all embedded parameter specifications.
FromElement getFromElement()
boolean hasEmbeddedParameters()
Determine whether this node contains embedded parameters.
boolean hasFilterCondition()
void setFromElement(FromElement fromElement)
void setJoinFragment(JoinFragment joinFragment)
[Expand]
Inherited Methods
From class org.hibernate.hql.ast.tree.Node
From class java.lang.Object
From interface org.hibernate.hql.ast.tree.ParameterContainer

Public Constructors

public SqlFragment ()

Public Methods

public void addEmbeddedParameter (ParameterSpecification specification)

Adds a parameter specification for a parameter encountered within this node. We use the term 'embedded' here because of the fact that the parameter was simply encountered as part of the node's text; it does not exist as part of a subtree as it might in a true AST.

Parameters
specification The generated specification.

public ParameterSpecification[] getEmbeddedParameters ()

Retrieve all embedded parameter specifications.

Returns
  • All embedded parameter specifications; may return null.

public FromElement getFromElement ()

public boolean hasEmbeddedParameters ()

Determine whether this node contains embedded parameters. The implication is that getEmbeddedParameters() is allowed to return null if this method returns false.

Returns
  • True if this node contains embedded parameters; false otherwise.

public boolean hasFilterCondition ()

public void setFromElement (FromElement fromElement)

public void setJoinFragment (JoinFragment joinFragment)