Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ASTUtil.CollectingNodeVisitor
public static interface	ASTUtil.FilterPredicate Filters nodes out of a tree.
public abstract static class	ASTUtil.IncludePredicate A predicate that uses inclusion, rather than exclusion semantics.

Constructor Summary

Access	Constructor and Description
private	ASTUtil() Deprecated (tellclovertoignorethis) Disallow instantiation.

Method Summary

Modifier and Type	Method and Description
public static void	appendSibling(AST n, AST s)
public static List<E>	collectChildren(AST root, ASTUtil.FilterPredicate predicate)
public static AST	Returns: AST - A single node tree. create(ASTFactory The factory. astFactory, int The node type. type, String The node text. text) Deprecated silly Creates a single node AST.
private static ASTArray	createAstArray(ASTFactory factory, int size, int parentType, String parentText, AST child1)
public static AST	Returns: AST - A new sub-tree of the form "(parent child1 child2)" createBinarySubtree(ASTFactory The AST factory. factory, int The type of the parent node. parentType, String The text of the parent node. parentText, AST The first child. child1, AST The second child. child2) Creates a 'binary operator' subtree, given the information about the parent and the two child nodex.
public static AST	Returns: AST - A new sub-tree of the form "(parent child)" createParent(ASTFactory The AST factory. factory, int The type of the parent node. parentType, String The text of the parent node. parentText, AST The child. child) Creates a single parent of the specified child (i.e. a 'unary operator' subtree).
public static AST	Returns: The created AST node. createSibling(ASTFactory The factory. astFactory, int The node type. type, String The node text. text, AST The previous sibling. prevSibling) Creates a single node AST as a sibling of the passed prevSibling, taking care to reorganize the tree correctly to account for this newly created node.
public static AST	createTree(ASTFactory factory, AST[] nestedChildren)
private static Integer	extractIntegerValue(Field field)
public static AST	Returns: the previous sibling of the child findPreviousSibling(AST the parent node parent, AST the child to find the previous sibling of child) Find the previous sibling in the parent for the given child.
public static AST	Returns: The first node of the specified type, or null if not found. findTypeInChildren(AST The parent parent, int The type to find. type) Finds the first node of the specified type in the chain of children.
public static Map<K, V>	Returns: The generated map. generateTokenNameCache(Class<T> The *TokenTypes interface (or implementor of said interface). tokenTypeInterface) Method to generate a map of token type names, keyed by their token type values.
public static String	Returns: The token type name, or the integer value if the name could not be found. getConstantName(Class<T> The class which defines the constant owner, int The value of the constant. value) Deprecated Use #getTokenTypeName instead Get the name of a constant defined on the given class which has the given value.
public static String	Returns: The list representation of the tree. getDebugString(AST The tree. n) Returns the 'list' representation with some brackets around it for debugging.
public static AST	Returns: The last direct child of 'n'. getLastChild(AST The parent n) Returns the last direct child of 'n'.
private static AST	Returns: The last sibling of 'a'. getLastSibling(AST The sibling. a) Returns the last sibling of 'a'.
public static String	getPathText(AST n)
private static void	getPathText(StringBuffer buf, AST n)
public static String	Returns: The corresponding name. getTokenTypeName(Class<T> The *TokenTypes interface (or one of its implementors). tokenTypeInterface, int The token type value. tokenType) Intended to retrieve the name of an AST token type based on the token type interface.
public static boolean	hasExactlyOneChild(AST n)
public static void	insertChild(AST the parent parent, AST the new first child child) Inserts the child as the first child of the parent, all other children are shifted over to the 'right'.
public static AST	Returns: The return is the same as the node parameter passed in. insertSibling(AST The node to insert node, AST The previous node at the sibling position where we want this node inserted. prevSibling) Inserts a node into a child subtree as a particularly positioned sibling taking care to properly reorganize the tree to account for this new addition.
public static boolean	Returns: True if child is contained in the parent's collection of children. isSubtreeChild(AST The node against which to testto be checked for children. fixture, AST The node to be tested as being a subtree child of the parent. test) Determine if a given node (test) is contained anywhere in the subtree of another given node (fixture).
public static void	makeSiblingOfParent(AST the parent parent, AST the child child) Makes the child node a sibling of the parent, reconnecting all siblings.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ASTUtil	back to summary
private ASTUtil() Deprecated (tellclovertoignorethis) Disallow instantiation.

Method Detail

appendSibling	back to summary
public static void appendSibling(AST n, AST s)

collectChildren	back to summary
public static List<E> collectChildren(AST root, ASTUtil.FilterPredicate predicate)

create	back to summary
public static AST create(ASTFactory astFactory, int type, String text) Deprecated silly Creates a single node AST. TODO : this is silly, remove it... Parameters astFactory:ASTFactory The factory. type:int The node type. text:String The node text. Returns:AST AST - A single node tree.

create

back to summary

public static AST create(ASTFactory astFactory, int type, String text)

Deprecated

silly

Creates a single node AST.

TODO : this is silly, remove it...

Parameters

astFactory:ASTFactory: The factory.
type:int: The node type.
text:String: The node text.

Returns:AST

AST - A single node tree.

createAstArray	back to summary
private static ASTArray createAstArray(ASTFactory factory, int size, int parentType, String parentText, AST child1)

createBinarySubtree	back to summary
public static AST createBinarySubtree(ASTFactory factory, int parentType, String parentText, AST child1, AST child2) Creates a 'binary operator' subtree, given the information about the parent and the two child nodex. Parameters factory:ASTFactory The AST factory. parentType:int The type of the parent node. parentText:String The text of the parent node. child1:AST The first child. child2:AST The second child. Returns:AST AST - A new sub-tree of the form "(parent child1 child2)"

createBinarySubtree

back to summary

public static AST createBinarySubtree(ASTFactory factory, int parentType, String parentText, AST child1, AST child2)

Creates a 'binary operator' subtree, given the information about the parent and the two child nodex.

Parameters

factory:ASTFactory: The AST factory.
parentType:int: The type of the parent node.
parentText:String: The text of the parent node.
child1:AST: The first child.
child2:AST: The second child.

Returns:AST

AST - A new sub-tree of the form "(parent child1 child2)"

createParent	back to summary
public static AST createParent(ASTFactory factory, int parentType, String parentText, AST child) Creates a single parent of the specified child (i.e. a 'unary operator' subtree). Parameters factory:ASTFactory The AST factory. parentType:int The type of the parent node. parentText:String The text of the parent node. child:AST The child. Returns:AST AST - A new sub-tree of the form "(parent child)"

createParent

back to summary

public static AST createParent(ASTFactory factory, int parentType, String parentText, AST child)

Creates a single parent of the specified child (i.e. a 'unary operator' subtree).

Parameters

factory:ASTFactory: The AST factory.
parentType:int: The type of the parent node.
parentText:String: The text of the parent node.
child:AST: The child.

Returns:AST

AST - A new sub-tree of the form "(parent child)"

createSibling	back to summary
public static AST createSibling(ASTFactory astFactory, int type, String text, AST prevSibling) Creates a single node AST as a sibling of the passed prevSibling, taking care to reorganize the tree correctly to account for this newly created node. Parameters astFactory:ASTFactory The factory. type:int The node type. text:String The node text. prevSibling:AST The previous sibling. Returns:AST The created AST node.

createSibling

back to summary

public static AST createSibling(ASTFactory astFactory, int type, String text, AST prevSibling)

Creates a single node AST as a sibling of the passed prevSibling, taking care to reorganize the tree correctly to account for this newly created node.

Parameters

astFactory:ASTFactory: The factory.
type:int: The node type.
text:String: The node text.
prevSibling:AST: The previous sibling.

Returns:AST

The created AST node.

createTree	back to summary
public static AST createTree(ASTFactory factory, AST[] nestedChildren)

extractIntegerValue	back to summary
private static Integer extractIntegerValue(Field field)

findPreviousSibling	back to summary
public static AST findPreviousSibling(AST parent, AST child) Find the previous sibling in the parent for the given child. Parameters parent:AST the parent node child:AST the child to find the previous sibling of Returns:AST the previous sibling of the child

findPreviousSibling

back to summary

public static AST findPreviousSibling(AST parent, AST child)

Find the previous sibling in the parent for the given child.

Parameters

parent:AST: the parent node
child:AST: the child to find the previous sibling of

Returns:AST

the previous sibling of the child

findTypeInChildren	back to summary
public static AST findTypeInChildren(AST parent, int type) Finds the first node of the specified type in the chain of children. Parameters parent:AST The parent type:int The type to find. Returns:AST The first node of the specified type, or null if not found.

findTypeInChildren

back to summary

public static AST findTypeInChildren(AST parent, int type)

Finds the first node of the specified type in the chain of children.

Parameters

parent:AST: The parent
type:int: The type to find.

Returns:AST

The first node of the specified type, or null if not found.

generateTokenNameCache	back to summary
public static Map<K, V> generateTokenNameCache(Class<T> tokenTypeInterface) Method to generate a map of token type names, keyed by their token type values. Parameters tokenTypeInterface:Class<T> The *TokenTypes interface (or implementor of said interface). Returns:Map<K, V> The generated map.

generateTokenNameCache

back to summary

public static Map<K, V> generateTokenNameCache(Class<T> tokenTypeInterface)

Method to generate a map of token type names, keyed by their token type values.

Parameters

tokenTypeInterface:Class<T>: The *TokenTypes interface (or implementor of said interface).

Returns:Map<K, V>

The generated map.

getConstantName	back to summary
public static String getConstantName(Class<T> owner, int value) Deprecated Use #getTokenTypeName instead Get the name of a constant defined on the given class which has the given value. Note, if multiple constants have this value, the first will be returned which is known to be different on different JVM implementations. Parameters owner:Class<T> The class which defines the constant value:int The value of the constant. Returns:String The token type name, or the integer value if the name could not be found.

getConstantName

back to summary

public static String getConstantName(Class<T> owner, int value)

Deprecated

Use #getTokenTypeName instead

Get the name of a constant defined on the given class which has the given value.

Note, if multiple constants have this value, the first will be returned which is known to be different on different JVM implementations.

Parameters

owner:Class<T>: The class which defines the constant
value:int: The value of the constant.

Returns:String

The token type name, *or* the integer value if the name could not be found.

getDebugString	back to summary
public static String getDebugString(AST n) Returns the 'list' representation with some brackets around it for debugging. Parameters n:AST The tree. Returns:String The list representation of the tree.

getDebugString

back to summary

public static String getDebugString(AST n)

Returns the 'list' representation with some brackets around it for debugging.

Parameters

n:AST: The tree.

Returns:String

The list representation of the tree.

getLastChild	back to summary
public static AST getLastChild(AST n) Returns the last direct child of 'n'. Parameters n:AST The parent Returns:AST The last direct child of 'n'.

getLastChild

back to summary

public static AST getLastChild(AST n)

Returns the last direct child of 'n'.

Parameters

n:AST: The parent

Returns:AST

The last direct child of 'n'.

getLastSibling	back to summary
private static AST getLastSibling(AST a) Returns the last sibling of 'a'. Parameters a:AST The sibling. Returns:AST The last sibling of 'a'.

getLastSibling

back to summary

private static AST getLastSibling(AST a)

Returns the last sibling of 'a'.

Parameters

a:AST: The sibling.

Returns:AST

The last sibling of 'a'.

getPathText	back to summary
public static String getPathText(AST n)

getPathText	back to summary
private static void getPathText(StringBuffer buf, AST n)

getTokenTypeName	back to summary
public static String getTokenTypeName(Class<T> tokenTypeInterface, int tokenType) Intended to retrieve the name of an AST token type based on the token type interface. However, this method can be used to look up the name of any constant defined on a class/interface based on the constant value. Note that if multiple constants have this value, the first will be returned which is known to be different on different JVM implementations. Parameters tokenTypeInterface:Class<T> The *TokenTypes interface (or one of its implementors). tokenType:int The token type value. Returns:String The corresponding name.

getTokenTypeName

back to summary

public static String getTokenTypeName(Class<T> tokenTypeInterface, int tokenType)

Intended to retrieve the name of an AST token type based on the token type interface. However, this method can be used to look up the name of any constant defined on a class/interface based on the constant value. Note that if multiple constants have this value, the first will be returned which is known to be different on different JVM implementations.

Parameters

tokenTypeInterface:Class<T>: The *TokenTypes interface (or one of its implementors).
tokenType:int: The token type value.

Returns:String

The corresponding name.

hasExactlyOneChild	back to summary
public static boolean hasExactlyOneChild(AST n)

insertChild	back to summary
public static void insertChild(AST parent, AST child) Inserts the child as the first child of the parent, all other children are shifted over to the 'right'. Parameters parent:AST the parent child:AST the new first child

insertChild

back to summary

public static void insertChild(AST parent, AST child)

Inserts the child as the first child of the parent, all other children are shifted over to the 'right'.

Parameters

parent:AST: the parent
child:AST: the new first child

insertSibling	back to summary
public static AST insertSibling(AST node, AST prevSibling) Inserts a node into a child subtree as a particularly positioned sibling taking care to properly reorganize the tree to account for this new addition. Parameters node:AST The node to insert prevSibling:AST The previous node at the sibling position where we want this node inserted. Returns:AST The return is the same as the node parameter passed in.

insertSibling

back to summary

public static AST insertSibling(AST node, AST prevSibling)

Inserts a node into a child subtree as a particularly positioned sibling taking care to properly reorganize the tree to account for this new addition.

Parameters

node:AST: The node to insert
prevSibling:AST: The previous node at the sibling position where we want this node inserted.

Returns:AST

The return is the same as the node parameter passed in.

isSubtreeChild	back to summary
public static boolean isSubtreeChild(AST fixture, AST test) Determine if a given node (test) is contained anywhere in the subtree of another given node (fixture). Parameters fixture:AST The node against which to testto be checked for children. test:AST The node to be tested as being a subtree child of the parent. Returns:boolean True if child is contained in the parent's collection of children.

isSubtreeChild

back to summary

public static boolean isSubtreeChild(AST fixture, AST test)

Determine if a given node (test) is contained anywhere in the subtree of another given node (fixture).

Parameters

fixture:AST: The node against which to testto be checked for children.
test:AST: The node to be tested as being a subtree child of the parent.

Returns:boolean

True if child is contained in the parent's collection of children.

makeSiblingOfParent	back to summary
public static void makeSiblingOfParent(AST parent, AST child) Makes the child node a sibling of the parent, reconnecting all siblings. Parameters parent:AST the parent child:AST the child

makeSiblingOfParent

back to summary

public static void makeSiblingOfParent(AST parent, AST child)

Makes the child node a sibling of the parent, reconnecting all siblings.

Parameters

parent:AST: the parent
child:AST: the child

org.hibernate.hql.ast.util back to summary

private Class ASTUtil.CollectingNodeVisitor

Class Inheritance

extends Object
implements VisitationStrategy

java.lang.Object
org.hibernate.hql.ast.util.ASTUtil.CollectingNodeVisitor

All Implemented Interfaces

org.hibernate.hql.ast.util.NodeTraverser.VisitationStrategy

Field Summary

Modifier and Type	Field and Description
private final List<E>	collectedNodes
private final ASTUtil.FilterPredicate	predicate

Constructor Summary

Access	Constructor and Description
public	CollectingNodeVisitor(ASTUtil.FilterPredicate predicate)

Method Summary

Modifier and Type	Method and Description
public List<E>	collect(AST root)
public List<E>	getCollectedNodes()
public void	visit(AST node) Implements org.hibernate.hql.ast.util.NodeTraverser.VisitationStrategy.visit.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

collectedNodes	back to summary
private final List<E> collectedNodes

predicate	back to summary
private final ASTUtil.FilterPredicate predicate

Constructor Detail

CollectingNodeVisitor	back to summary
public CollectingNodeVisitor(ASTUtil.FilterPredicate predicate)

Method Detail

collect	back to summary
public List<E> collect(AST root)

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

visit	back to summary
public void visit(AST node) Implements org.hibernate.hql.ast.util.NodeTraverser.VisitationStrategy.visit.

org.hibernate.hql.ast.util back to summary

public Interface ASTUtil.FilterPredicate

Known Direct Implementers: org.hibernate.hql.ast.util.ASTUtil.IncludePredicate

Filters nodes out of a tree.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the node should be filtered out, false to keep the node. exclude(AST The node. n) Returns true if the node should be filtered out.

Method Detail

exclude	back to summary
public boolean exclude(AST n) Returns true if the node should be filtered out. Parameters n:AST The node. Returns:boolean true if the node should be filtered out, false to keep the node.

exclude

back to summary

public boolean exclude(AST n)

Returns true if the node should be filtered out.

Parameters

n:AST: The node.

Returns:boolean

true if the node should be filtered out, false to keep the node.

org.hibernate.hql.ast.util back to summary

public abstract Class ASTUtil.IncludePredicate

Class Inheritance

extends Object
implements FilterPredicate

java.lang.Object
org.hibernate.hql.ast.util.ASTUtil.IncludePredicate

All Implemented Interfaces

org.hibernate.hql.ast.util.ASTUtil.FilterPredicate

A predicate that uses inclusion, rather than exclusion semantics.

Constructor Summary

Access	Constructor and Description
public	IncludePredicate()

Method Summary

Modifier and Type	Method and Description
public final boolean	exclude(AST The node. node) Implements org.hibernate.hql.ast.util.ASTUtil.FilterPredicate.exclude. Returns true if the node should be filtered out.
public abstract boolean	include(AST node)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

IncludePredicate	back to summary
public IncludePredicate()

Method Detail

exclude	back to summary
public final boolean exclude(AST node) Implements org.hibernate.hql.ast.util.ASTUtil.FilterPredicate.exclude. Doc from org.hibernate.hql.ast.util.ASTUtil.FilterPredicate.exclude. Returns true if the node should be filtered out. Parameters node:AST The node. Returns:boolean true if the node should be filtered out, false to keep the node.

exclude

back to summary

public final boolean exclude(AST node)

Implements org.hibernate.hql.ast.util.ASTUtil.FilterPredicate.exclude.

Doc from org.hibernate.hql.ast.util.ASTUtil.FilterPredicate.exclude.

Returns true if the node should be filtered out.

Parameters

node:AST: The node.

Returns:boolean

true if the node should be filtered out, false to keep the node.

include	back to summary
public abstract boolean include(AST node)

public final Class ASTUtil

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class ASTUtil.CollectingNodeVisitor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ASTUtil.FilterPredicate

Method Summary

Method Detail

public abstract Class ASTUtil.IncludePredicate

Constructor Summary

Method Summary

Constructor Detail

Method Detail