org.hibernate.hql.ast.tree

Class FromElement

Implemented Interfaces:
DisplayableNode, InitializeableNode
Known Direct Subclasses:
ImpliedFromElement

public class FromElement
extends HqlSqlWalkerNode
implements DisplayableNode

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

Constructor Summary

FromElement()

Method Summary

protected void
appendDisplayText(StringBuffer buf)
boolean
equals(Object obj)
String
getClassAlias()
String
getClassName()
String
getCollectionSuffix()
String
getCollectionTableAlias()
Type
getDataType()
List
getDestinations()
String
getDisplayText()
Returns additional display text for the AST node.
EntityPersister
getEntityPersister()
FromClause
getFromClause()
String
getIdentityColumn()
JoinSequence
getJoinSequence()
FromElement
getOrigin()
PropertyMapping
getPropertyMapping(String propertyName)
Type
getPropertyType(String propertyName, String propertyPath)
Queryable
getQueryable()
QueryableCollection
getQueryableCollection()
FromElement
getRealOrigin()
Type
getSelectType()
int
getSequence()
String
getTableAlias()
String
getWithClauseFragment()
String
getWithClauseJoinAlias()
void
handlePropertyBeingDereferenced(Type propertySource, String propertyName)
boolean
hasCacheablePersister()
int
hashCode()
boolean
inProjectionList()
void
initializeCollection(FromClause fromClause, String classAlias, String tableAlias)
void
initializeEntity(FromClause fromClause, String className, EntityPersister persister, EntityType type, String classAlias, String tableAlias)
boolean
isAllPropertyFetch()
boolean
isCollectionJoin()
boolean
isCollectionOfValuesOrComponents()
boolean
isDereferencedBySubclassProperty()
boolean
isDereferencedBySuperclassOrSubclassProperty()
boolean
isDereferencedBySuperclassProperty()
boolean
isEntity()
boolean
isFetch()
boolean
isFilter()
boolean
isFromOrJoinFragment()
boolean
isImplied()
Returns true if this FromElement was implied by a path, or false if this FROM element is explicitly declared in the FROM clause.
boolean
isImpliedInFromClause()
boolean
isIncludeSubclasses()
boolean
isManyToMany()
void
setAllPropertyFetch(boolean fetch)
void
setCollectionJoin(boolean collectionJoin)
void
setCollectionSuffix(String suffix)
void
setCollectionTableAlias(String collectionTableAlias)
void
setColumns(String[] columns)
void
setFetch(boolean fetch)
void
setFilter(boolean b)
void
setImpliedInFromClause(boolean flag)
void
setInProjectionList(boolean inProjectionList)
void
setIncludeSubclasses(boolean includeSubclasses)
void
setJoinSequence(JoinSequence joinSequence)
void
setOrigin(FromElement origin, boolean manyToMany)
void
setQueryableCollection(QueryableCollection queryableCollection)
void
setRole(String role)
void
setUseFromFragment(boolean useFromFragment)
void
setUseWhereFragment(boolean b)
void
setWithClauseFragment(String withClauseJoinAlias, String withClauseFragment)
String[]
toColumns(String tableAlias, String path, boolean inSelect)
String[]
toColumns(String tableAlias, String path, boolean inSelect, boolean forceAlias)
boolean
useFromFragment()
boolean
useWhereFragment()

Methods inherited from class org.hibernate.hql.ast.tree.HqlSqlWalkerNode

getASTFactory, getAliasGenerator, getSessionFactoryHelper, getWalker, initialize

Methods inherited from class org.hibernate.hql.ast.tree.SqlNode

getDataType, getOriginalText, setDataType, setText

Methods inherited from class org.hibernate.hql.ast.tree.Node

getColumn, getFilename, getLine, getRenderText, getTextLength, initialize, initialize

Constructor Details

FromElement

public FromElement()

Method Details

appendDisplayText

protected void appendDisplayText(StringBuffer buf)

equals

public boolean equals(Object obj)

getClassAlias

public String getClassAlias()

getClassName

public String getClassName()

getCollectionSuffix

public String getCollectionSuffix()

getCollectionTableAlias

public String getCollectionTableAlias()

getDataType

public Type getDataType()
Overrides:
getDataType in interface SqlNode

getDestinations

public List getDestinations()

getDisplayText

public String getDisplayText()
Returns additional display text for the AST node.
Specified by:
getDisplayText in interface DisplayableNode
Returns:
String - The additional display text.

getEntityPersister

public EntityPersister getEntityPersister()

getFromClause

public FromClause getFromClause()

getIdentityColumn

public String getIdentityColumn()

getJoinSequence

public JoinSequence getJoinSequence()

getOrigin

public FromElement getOrigin()

getPropertyMapping

public PropertyMapping getPropertyMapping(String propertyName)

getPropertyType

public Type getPropertyType(String propertyName,
                            String propertyPath)

getQueryable

public Queryable getQueryable()

getQueryableCollection

public QueryableCollection getQueryableCollection()

getRealOrigin

public FromElement getRealOrigin()

getSelectType

public Type getSelectType()

getSequence

public int getSequence()

getTableAlias

public String getTableAlias()

getWithClauseFragment

public String getWithClauseFragment()

getWithClauseJoinAlias

public String getWithClauseJoinAlias()

handlePropertyBeingDereferenced

public void handlePropertyBeingDereferenced(Type propertySource,
                                            String propertyName)

hasCacheablePersister

public boolean hasCacheablePersister()

hashCode

public int hashCode()

inProjectionList

public boolean inProjectionList()

initializeCollection

public void initializeCollection(FromClause fromClause,
                                 String classAlias,
                                 String tableAlias)

initializeEntity

public void initializeEntity(FromClause fromClause,
                             String className,
                             EntityPersister persister,
                             EntityType type,
                             String classAlias,
                             String tableAlias)

isAllPropertyFetch

public boolean isAllPropertyFetch()

isCollectionJoin

public boolean isCollectionJoin()

isCollectionOfValuesOrComponents

public boolean isCollectionOfValuesOrComponents()

isDereferencedBySubclassProperty

public boolean isDereferencedBySubclassProperty()

isDereferencedBySuperclassOrSubclassProperty

public boolean isDereferencedBySuperclassOrSubclassProperty()

isDereferencedBySuperclassProperty

public boolean isDereferencedBySuperclassProperty()

isEntity

public boolean isEntity()

isFetch

public boolean isFetch()

isFilter

public boolean isFilter()

isFromOrJoinFragment

public boolean isFromOrJoinFragment()

isImplied

public boolean isImplied()
Returns true if this FromElement was implied by a path, or false if this FROM element is explicitly declared in the FROM clause.
Returns:
true if this FromElement was implied by a path, or false if this FROM element is explicitly declared

isImpliedInFromClause

public boolean isImpliedInFromClause()

isIncludeSubclasses

public boolean isIncludeSubclasses()

isManyToMany

public boolean isManyToMany()

setAllPropertyFetch

public void setAllPropertyFetch(boolean fetch)

setCollectionJoin

public void setCollectionJoin(boolean collectionJoin)

setCollectionSuffix

public void setCollectionSuffix(String suffix)

setCollectionTableAlias

public void setCollectionTableAlias(String collectionTableAlias)

setColumns

public void setColumns(String[] columns)

setFetch

public void setFetch(boolean fetch)

setFilter

public void setFilter(boolean b)

setImpliedInFromClause

public void setImpliedInFromClause(boolean flag)

setInProjectionList

public void setInProjectionList(boolean inProjectionList)

setIncludeSubclasses

public void setIncludeSubclasses(boolean includeSubclasses)

setJoinSequence

public void setJoinSequence(JoinSequence joinSequence)

setOrigin

public void setOrigin(FromElement origin,
                      boolean manyToMany)

setQueryableCollection

public void setQueryableCollection(QueryableCollection queryableCollection)

setRole

public void setRole(String role)

setUseFromFragment

public void setUseFromFragment(boolean useFromFragment)

setUseWhereFragment

public void setUseWhereFragment(boolean b)

setWithClauseFragment

public void setWithClauseFragment(String withClauseJoinAlias,
                                  String withClauseFragment)

toColumns

public String[] toColumns(String tableAlias,
                          String path,
                          boolean inSelect)

toColumns

public String[] toColumns(String tableAlias,
                          String path,
                          boolean inSelect,
                          boolean forceAlias)

useFromFragment

public boolean useFromFragment()

useWhereFragment

public boolean useWhereFragment()