Hibernate Core 3.6.10.Final · org.hibernate.hql.ast.tree.FromClause

Modifier and Type	Field and Description
private Set<E>	childFromClauses Collection of FROM clauses of which this is the parent.
private static ASTUtil.FilterPredicate	collectionFetchPredicate
private Map<K, V>	collectionJoinFromElementsByPath All of the implicit FROM xxx JOIN yyy elements that are the destination of a collection.
private static ASTUtil.FilterPredicate	explicitFromPredicate
private Map<K, V>	fromElementByClassAlias
private Map<K, V>	fromElementByTableAlias
private int	fromElementCounter Counts the from elements as they are added.
private static ASTUtil.FilterPredicate	fromElementPredicate
private Set<E>	fromElements
private Map<K, V>	fromElementsByPath
private List<E>	impliedElements Implied FROM elements to add onto the end of the FROM clause.
private int	level
private static Logger	log
private FromClause	parentFromClause Pointer to the parent FROM clause, if there is one.
private static ASTUtil.FilterPredicate	projectionListPredicate
public static final int	ROOT_LEVEL

Access	Constructor and Description
public	FromClause()

Method Summary

Modifier and Type	Method and Description
private void	addChild(FromClause fromClause)
pack-priv void	addCollectionJoinFromElementByPath(String path, FromElement destination) Deprecated as a consequence of `FromElement` being deprecated.
pack-priv void	addDuplicateAlias(String alias, FromElement element) Deprecated as a consequence of `FromElement` being deprecated.
public FromElement	Returns: FromElement - The new FROM element. addFromElement(String The reference to the class. path, AST The alias AST. alias) Deprecated as a consequence of `FromElement` being deprecated. Adds a new from element to the from node.
public void	addImpliedFromElement(FromElement element) Deprecated as a consequence of `FromElement` being deprecated.
pack-priv void	addJoinByPathMap(String path, FromElement destination) Deprecated as a consequence of `FromElement` being deprecated.
private void	checkForDuplicateClassAlias(String classAlias)
public boolean	Returns: true if the from node contains the class alias name. containsClassAlias(String The HQL class alias name. alias) Returns true if the from node contains the class alias name.
public boolean	Returns: true if the from node contains the table alias name. containsTableAlias(String The SQL table alias name. alias) Returns true if the from node contains the table alias name.
pack-priv FromElement	findCollectionJoin(String path) Deprecated as a consequence of `FromElement` being deprecated.
public FromElement	findFromElementBySqlAlias(String sqlAlias) Deprecated as a consequence of `FromElement` being deprecated.
public FromElement	findFromElementByUserOrSqlAlias(String userAlias, String sqlAlias) Deprecated as a consequence of `FromElement` being deprecated.
private FromElement	findIntendedAliasedFromElementBasedOnCrazyJPARequirements(String specifiedAlias) Deprecated as a consequence of `FromElement` being deprecated.
pack-priv FromElement	findJoinByPath(String path) Deprecated as a consequence of `FromElement` being deprecated. Look for an existing implicit or explicit join by the given path.
pack-priv FromElement	findJoinByPathLocal(String path) Deprecated as a consequence of `FromElement` being deprecated.
public List<E>	getCollectionFetches()
public String	getDisplayText() Implements org.hibernate.hql.ast.tree.DisplayableNode.getDisplayText. Returns additional display text for the AST node.
public List<E>	getExplicitFromElements()
public FromElement	Returns: The from-element assigned the given alias, or null if none. getFromElement(String The alias by which to locate the from-element. aliasOrClassName) Deprecated as a consequence of `FromElement` being deprecated. Retreives the from-element represented by the given alias.
public FromElement	getFromElement() Deprecated as a consequence of `FromElement` being deprecated.
public List<E>	Returns: the list of from elements (instances of FromElement). getFromElements() Returns the list of from elements in order.
public int	getLevel()
public FromClause	getParentFromClause()
public List<E>	Returns: the list of from elements that will be part of the result set. getProjectionList() Returns the list of from elements that will be part of the result set.
public boolean	hasCollectionFecthes()
public boolean	Returns: True if the possibleAlias is an alias to a from-element visible from this point in the query graph. isFromElementAlias(String The potential from-element alias to check. possibleAlias) Convenience method to check whether a given token represents a from-element alias.
public boolean	isSubQuery()
public FromClause	locateChildFromClauseWithJoinByPath(String path)
public int	nextFromElementCounter()
public void	promoteJoin(FromElement elem) Deprecated as a consequence of `FromElement` being deprecated.
pack-priv void	registerFromElement(FromElement element) Deprecated as a consequence of `FromElement` being deprecated.
public void	resolve()
public void	setParentFromClause(FromClause parentFromClause)
public String	toString() Overrides antlr.BaseAST.toString. Implements antlr.collections.AST.toString. Returns a string representation of the object.

Inherited from org.hibernate.hql.ast.tree.HqlSqlWalkerNode:: getAliasGenerator getASTFactory getSessionFactoryHelper getWalker initialize

childFromClauses	back to summary
private Set<E> childFromClauses Collection of FROM clauses of which this is the parent.

collectionFetchPredicate	back to summary
private static ASTUtil.FilterPredicate collectionFetchPredicate

collectionJoinFromElementsByPath	back to summary
private Map<K, V> collectionJoinFromElementsByPath All of the implicit FROM xxx JOIN yyy elements that are the destination of a collection. These are created from index operators on collection property references.

explicitFromPredicate	back to summary
private static ASTUtil.FilterPredicate explicitFromPredicate

fromElementByClassAlias	back to summary
private Map<K, V> fromElementByClassAlias

fromElementByTableAlias	back to summary
private Map<K, V> fromElementByTableAlias

fromElementCounter	back to summary
private int fromElementCounter Counts the from elements as they are added.

fromElementPredicate	back to summary
private static ASTUtil.FilterPredicate fromElementPredicate

fromElements	back to summary
private Set<E> fromElements

fromElementsByPath	back to summary
private Map<K, V> fromElementsByPath

impliedElements	back to summary
private List<E> impliedElements Implied FROM elements to add onto the end of the FROM clause.

level	back to summary
private int level

log	back to summary
private static Logger log

parentFromClause	back to summary
private FromClause parentFromClause Pointer to the parent FROM clause, if there is one.

projectionListPredicate	back to summary
private static ASTUtil.FilterPredicate projectionListPredicate

ROOT_LEVEL	back to summary
public static final int ROOT_LEVEL

FromClause	back to summary
public FromClause()

Method Detail

addChild	back to summary
private void addChild(FromClause fromClause)

addCollectionJoinFromElementByPath	back to summary
pack-priv void addCollectionJoinFromElementByPath(String path, FromElement destination) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

addDuplicateAlias	back to summary
pack-priv void addDuplicateAlias(String alias, FromElement element) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

addFromElement back to summary

addFromElement	back to summary
public FromElement addFromElement(String path, AST alias) throws SemanticException Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information. Adds a new from element to the from node. Parameters path:String The reference to the class. alias:AST The alias AST. Returns:FromElement FromElement - The new FROM element.

public FromElement addFromElement(String path, AST alias) throws SemanticException

Deprecated

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

Adds a new from element to the from node.

Parameters

path:String: The reference to the class.
alias:AST: The alias AST.

Returns:FromElement

FromElement - The new FROM element.

addImpliedFromElement	back to summary
public void addImpliedFromElement(FromElement element) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

addJoinByPathMap	back to summary
pack-priv void addJoinByPathMap(String path, FromElement destination) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

checkForDuplicateClassAlias	back to summary
private void checkForDuplicateClassAlias(String classAlias) throws SemanticException

containsClassAlias	back to summary
public boolean containsClassAlias(String alias) Returns true if the from node contains the class alias name. Parameters alias:String The HQL class alias name. Returns:boolean true if the from node contains the class alias name.

containsClassAlias

back to summary

public boolean containsClassAlias(String alias)

Returns true if the from node contains the class alias name.

Parameters

alias:String: The HQL class alias name.

Returns:boolean

true if the from node contains the class alias name.

containsTableAlias	back to summary
public boolean containsTableAlias(String alias) Returns true if the from node contains the table alias name. Parameters alias:String The SQL table alias name. Returns:boolean true if the from node contains the table alias name.

containsTableAlias

back to summary

public boolean containsTableAlias(String alias)

Returns true if the from node contains the table alias name.

Parameters

alias:String: The SQL table alias name.

Returns:boolean

true if the from node contains the table alias name.

findCollectionJoin	back to summary
pack-priv FromElement findCollectionJoin(String path) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

findFromElementBySqlAlias	back to summary
public FromElement findFromElementBySqlAlias(String sqlAlias) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

findFromElementByUserOrSqlAlias	back to summary
public FromElement findFromElementByUserOrSqlAlias(String userAlias, String sqlAlias) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

findIntendedAliasedFromElementBasedOnCrazyJPARequirements	back to summary
private FromElement findIntendedAliasedFromElementBasedOnCrazyJPARequirements(String specifiedAlias) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

findJoinByPath	back to summary
pack-priv FromElement findJoinByPath(String path) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information. Look for an existing implicit or explicit join by the given path.

findJoinByPathLocal	back to summary
pack-priv FromElement findJoinByPathLocal(String path) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

getCollectionFetches	back to summary
public List<E> getCollectionFetches()

getDisplayText	back 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.

getDisplayText

back 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.

getExplicitFromElements	back to summary
public List<E> getExplicitFromElements()

getFromElement back to summary

getFromElement	back to summary
public FromElement getFromElement(String aliasOrClassName) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information. Retreives the from-element represented by the given alias. Parameters aliasOrClassName:String The alias by which to locate the from-element. Returns:FromElement The from-element assigned the given alias, or null if none.

public FromElement getFromElement(String aliasOrClassName)

Deprecated

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

Retreives the from-element represented by the given alias.

Parameters

aliasOrClassName:String: The alias by which to locate the from-element.

Returns:FromElement

The from-element assigned the given alias, or null if none.

getFromElement	back to summary
public FromElement getFromElement() Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

getFromElements	back to summary
public List<E> getFromElements() Returns the list of from elements in order. Returns:List<E> the list of from elements (instances of FromElement).

getFromElements

back to summary

public List<E> getFromElements()

Returns the list of from elements in order.

Returns:List<E>: the list of from elements (instances of FromElement).

getLevel	back to summary
public int getLevel()

getParentFromClause	back to summary
public FromClause getParentFromClause()

getProjectionList	back to summary
public List<E> getProjectionList() Returns the list of from elements that will be part of the result set. Returns:List<E> the list of from elements that will be part of the result set.

getProjectionList

back to summary

public List<E> getProjectionList()

Returns the list of from elements that will be part of the result set.

Returns:List<E>: the list of from elements that will be part of the result set.

hasCollectionFecthes	back to summary
public boolean hasCollectionFecthes()

isFromElementAlias	back to summary
public boolean isFromElementAlias(String possibleAlias) Convenience method to check whether a given token represents a from-element alias. Parameters possibleAlias:String The potential from-element alias to check. Returns:boolean True if the possibleAlias is an alias to a from-element visible from this point in the query graph.

isFromElementAlias

back to summary

public boolean isFromElementAlias(String possibleAlias)

Convenience method to check whether a given token represents a from-element alias.

Parameters

possibleAlias:String: The potential from-element alias to check.

Returns:boolean

True if the possibleAlias is an alias to a from-element visible from this point in the query graph.

isSubQuery	back to summary
public boolean isSubQuery()

locateChildFromClauseWithJoinByPath	back to summary
public FromClause locateChildFromClauseWithJoinByPath(String path)

nextFromElementCounter	back to summary
public int nextFromElementCounter()

promoteJoin	back to summary
public void promoteJoin(FromElement elem) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

registerFromElement	back to summary
pack-priv void registerFromElement(FromElement element) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.