Package org.queryman.builder.ast

Interface AbstractSyntaxTree

public interface AbstractSyntaxTree

This class provides API to manipulate abstract syntax tree of SQL tokens. Each node must start with startNode(NodeMetadata) and end with endNode(). Each node may have or may not have leaves.

Example: AbstractSyntaxTree tree = new AbstractSyntaxTree(); tree.startNode(SELECT, ", "); .addLeaf("id"); .addLeaf("name"); .addLeaf("phone"); tree.addLeaves("date", "email"); tree.startNode(FROM); tree.addLeaf("table1").addLeaf("table2").setDelimiter(" "); tree.endNode(); tree.startNode(WHERE, "") .addLeaf("id") .addLeaf("=") .addLeaf("id") .endNode(); tree.endNode();

Method Summary

Modifier and Type	Method	Description
AbstractSyntaxTree	addChildNode(Node node)	Insert child node into the parent node.
AbstractSyntaxTree	addLeaf(Token token)	Add leaf into current node.
AbstractSyntaxTree	addLeaves(java.util.List<Token> tokens)	Add leaves into current node.
AbstractSyntaxTree	addLeaves(Token... tokens)	Add leaves into current node.
AbstractSyntaxTree	endNode()	Each node must be closed.
Node	getRootNode()
AbstractSyntaxTree	peek(AstVisitor node)	It look into node object, then the method AstVisitor.assemble(AbstractSyntaxTree) is called.
AbstractSyntaxTree	reinitialize()	Destroy an assembled tree then new one is initialized.
AbstractSyntaxTree	setDelimiter(java.lang.String delimiter)	Each leaves must separated by delimiter token.
AbstractSyntaxTree	startNode(NodeMetadata metadata)	Each node must have a metadata object.
AbstractSyntaxTree	startNode(NodeMetadata metadata, java.lang.String delimiter)	Each node must have a metadata.

Method Detail

startNode

AbstractSyntaxTree startNode(NodeMetadata metadata)

Each node must have a metadata object.

startNode

AbstractSyntaxTree startNode(NodeMetadata metadata,
                             java.lang.String delimiter)

Each node must have a metadata. And override a default delimiter by provides a new one.

See Also:

setDelimiter(String), startNode(NodeMetadata)

setDelimiter

AbstractSyntaxTree setDelimiter(java.lang.String delimiter)

Each leaves must separated by delimiter token. If it is not specified, space " " is used as default delimiter.

endNode

AbstractSyntaxTree endNode()

Each node must be closed.

addLeaf

AbstractSyntaxTree addLeaf(Token token)

Add leaf into current node. Kinds of leaf are SQL tokens.

See Also:

addLeaves(Token...), Token

addLeaves

AbstractSyntaxTree addLeaves(Token... tokens)

Add leaves into current node. Kinds of leaves are SQL tokens.

See Also:

addLeaf(Token), (Token), Token

addLeaves

AbstractSyntaxTree addLeaves(java.util.List<Token> tokens)

Add leaves into current node. Kinds of leaves are SQL tokens.

See Also:

addLeaf(Token), addLeaves(Token...), Token

addChildNode

AbstractSyntaxTree addChildNode(Node node)

Insert child node into the parent node.

reinitialize

AbstractSyntaxTree reinitialize()

Destroy an assembled tree then new one is initialized.

peek

AbstractSyntaxTree peek(AstVisitor node)

It look into node object, then the method AstVisitor.assemble(AbstractSyntaxTree) is called.

getRootNode

Node getRootNode()