org.hibernate.hql.ast
Class FromElement

java.lang.Object
  extended byantlr.BaseAST
      extended byantlr.CommonAST
          extended byorg.hibernate.hql.ast.SqlNode
              extended byorg.hibernate.hql.ast.HqlSqlWalkerNode
                  extended byorg.hibernate.hql.ast.FromElement
All Implemented Interfaces:
antlr.collections.AST, DisplayableNode, org.hibernate.hql.ast.InitializeableNode, Serializable
Direct Known Subclasses:
ImpliedFromElement

public class FromElement
extends org.hibernate.hql.ast.HqlSqlWalkerNode
implements DisplayableNode

Represents a single mapped class mentioned in an HQL FROM clause. Each class reference will have the following symbols:


User: josh
Date: Dec 6, 2003
Time: 10:28:17 AM

See Also:
Serialized Form

Field Summary
 
Fields inherited from class antlr.BaseAST
down, right
 
Constructor Summary
FromElement()
           
 
Method Summary
protected  void appendDisplayText(StringBuffer buf)
           
 boolean equals(Object obj)
           
 org.hibernate.hql.ast.AliasGenerator getAliasGenerator()
           
 antlr.ASTFactory getASTFactory()
           
 String getClassAlias()
           
 String getClassName()
           
 String getCollectionSuffix()
           
 String getCollectionTableAlias()
           
 Type getDataType()
           
 String getDisplayText()
          Returns additional display text for the AST node.
 EntityPersister getEntityPersister()
           
 org.hibernate.hql.ast.FromClause getFromClause()
           
 String getIdentityColumn()
           
 JoinSequence getJoinSequence()
           
 FromElement getOrigin()
           
 Type getPropertyType(String propertyName, String propertyPath)
          Returns the type of a property, given it's name (the last part) and the full path.
 Queryable getQueryable()
           
 QueryableCollection getQueryableCollection()
           
 Type getSelectType()
           
 int getSequence()
           
 org.hibernate.hql.ast.SessionFactoryHelper getSessionFactoryHelper()
           
 String getTableAlias()
           
 HqlSqlWalker getWalker()
           
 int hashCode()
           
 void initialize(Object param)
          Initializes the node with the parameter.
 boolean isAllPropertyFetch()
           
 boolean isCollectionJoin()
           
 boolean isCollectionOfValuesOrComponents()
           
 boolean isEntity()
           
 boolean isFetch()
           
 boolean isIncludeSubclasses()
           
 void setAllPropertyFetch(boolean fetch)
           
 void setCollectionJoin(boolean collectionJoin)
           
 void setCollectionTableAlias(String collectionTableAlias)
           
 void setColumns(String[] columns)
           
 void setFetch(boolean fetch)
           
 void setIncludeSubclasses(boolean includeSubclasses)
           
 void setInProjectionList(boolean inProjectionList)
           
 void setJoinSequence(JoinSequence joinSequence)
           
 void setOrigin(FromElement origin, boolean manyToMany)
           
 void setQueryableCollection(QueryableCollection queryableCollection)
           
 void setRole(String role)
           
 void setText(String s)
           
 
Methods inherited from class antlr.CommonAST
getText, getType, initialize, initialize, initialize, setType
 
Methods inherited from class antlr.BaseAST
addChild, decode, encode, equals, equalsList, equalsListPartial, equalsTree, equalsTreePartial, findAll, findAllPartial, getColumn, getFirstChild, getLine, getNextSibling, getNumberOfChildren, getTokenNames, removeChildren, setFirstChild, setNextSibling, setVerboseStringConversion, toString, toStringList, toStringTree, xmlSerialize, xmlSerializeNode, xmlSerializeRootClose, xmlSerializeRootOpen
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FromElement

public FromElement()
Method Detail

getCollectionSuffix

public String getCollectionSuffix()

getEntityPersister

public EntityPersister getEntityPersister()

getDataType

public Type getDataType()

getSelectType

public Type getSelectType()

getQueryable

public Queryable getQueryable()

getClassName

public String getClassName()

getClassAlias

public String getClassAlias()

getTableAlias

public String getTableAlias()

getFromClause

public org.hibernate.hql.ast.FromClause getFromClause()

getDisplayText

public String getDisplayText()
Returns additional display text for the AST node.

Specified by:
getDisplayText in interface DisplayableNode
Returns:
String - The additional display text.

appendDisplayText

protected void appendDisplayText(StringBuffer buf)

hashCode

public int hashCode()

equals

public boolean equals(Object obj)

setJoinSequence

public void setJoinSequence(JoinSequence joinSequence)

getJoinSequence

public JoinSequence getJoinSequence()

setIncludeSubclasses

public void setIncludeSubclasses(boolean includeSubclasses)

isIncludeSubclasses

public boolean isIncludeSubclasses()

getIdentityColumn

public String getIdentityColumn()

setCollectionJoin

public void setCollectionJoin(boolean collectionJoin)

isCollectionJoin

public boolean isCollectionJoin()

setRole

public void setRole(String role)

setQueryableCollection

public void setQueryableCollection(QueryableCollection queryableCollection)

getQueryableCollection

public QueryableCollection getQueryableCollection()

setColumns

public void setColumns(String[] columns)

setOrigin

public void setOrigin(FromElement origin,
                      boolean manyToMany)

getOrigin

public FromElement getOrigin()

getPropertyType

public Type getPropertyType(String propertyName,
                            String propertyPath)
Returns the type of a property, given it's name (the last part) and the full path.

Parameters:
propertyName - The last part of the full path to the property.
Returns:
The type.

setFetch

public void setFetch(boolean fetch)

isFetch

public boolean isFetch()

getSequence

public int getSequence()

setCollectionTableAlias

public void setCollectionTableAlias(String collectionTableAlias)

getCollectionTableAlias

public String getCollectionTableAlias()

isCollectionOfValuesOrComponents

public boolean isCollectionOfValuesOrComponents()

isEntity

public boolean isEntity()

setInProjectionList

public void setInProjectionList(boolean inProjectionList)

isAllPropertyFetch

public boolean isAllPropertyFetch()

setAllPropertyFetch

public void setAllPropertyFetch(boolean fetch)

initialize

public void initialize(Object param)
Description copied from interface: org.hibernate.hql.ast.InitializeableNode
Initializes the node with the parameter.

Specified by:
initialize in interface org.hibernate.hql.ast.InitializeableNode
Parameters:
param - the initialization parameter.

getWalker

public HqlSqlWalker getWalker()

getSessionFactoryHelper

public org.hibernate.hql.ast.SessionFactoryHelper getSessionFactoryHelper()

getASTFactory

public antlr.ASTFactory getASTFactory()

getAliasGenerator

public org.hibernate.hql.ast.AliasGenerator getAliasGenerator()

setText

public void setText(String s)