gudusoft.gsqlparser.nodes

Class TBlockSqlNode

Object

gudusoft.gsqlparser.nodes.TParseTreeNode

gudusoft.gsqlparser.nodes.TNodeWithLabel

gudusoft.gsqlparser.nodes.TBlockSqlNode

All Implemented Interfaces:

Visitable, Iterator<TSourceToken>

public class TBlockSqlNode
extends TNodeWithLabel

TBlockSqlNode represents a block in a stored procedure. It's used in TCreateFunctionStmt and TCreateProcedureStmt to retrieve the declarations and statements as shown below.

The mainly used methods are getDeclareStmts() to retrieve the declarations, getBodyStatements() to retrieve the statements.

getExceptionClause() represents the exception section in the block if any.

 [ <<label>> ]
 [ DECLARE
     declarations ]
 BEGIN
     statements
 END [ label ];
 

See Also:

TCreateProcedureStmt, TCreateFunctionStmt

Field Summary

Fields

Modifier and Type	Field and Description
protected TStatementList	bodyStatements
protected TStatementList	declareStatements
protected TExceptionClause	exceptionClause
protected TObjectName	outerLabelName

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

dbvendor, doubleLinkedTokenListToString, nodeActionAppend, nodeActionInsert, nodeActionRemove, nodeActionUnknown, nodeActionUpdate, nodeActionUpdateText, nodeChangeEndToken, nodeChangeStartToken

Constructor Summary

Constructors

Constructor and Description
TBlockSqlNode()

Method Summary

Modifier and Type	Method and Description
void	accept(TParseTreeVisitor v) Accept a visitor
void	acceptChildren(TParseTreeVisitor v) Accept a visitor to iterate this class and sub-nodes of this class
void	doParse(TCustomSqlStatement psql, ESqlClause plocation) Analyze the sub-nodes inside this node.
TStatementList	getBodyStatements()
TStatementList	getDeclareStatements()
TStatementListSqlNode	getDeclareStmts()
TExceptionClause	getExceptionClause()
TObjectName	getOuterLabelName()
TStatementListSqlNode	getStmts()
void	init(Object arg1) Initialize a query tree node.
boolean	isParsed()
void	setBodyStatements(TStatementList bodyStatements)
void	setDeclareStatements(TStatementList declareStatements)
void	setDeclareStmts(TStatementListSqlNode declareStmts)
void	setExceptionClause(TExceptionClause exceptionClause)
void	setOuterLabelName(TObjectName outerLabelName)
void	setParsed(boolean parsed)
void	setStmts(TStatementListSqlNode stmts)

Methods inherited from class gudusoft.gsqlparser.nodes.TNodeWithLabel

getEndlabelName, getLabelName, getLabelNameStr, setEndlabelName, setLabelName

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

addAllMyTokensToTokenList, addToTokenChain, appendNewNode, calculateTokenCount, doAppendNewNode, fastSetString, getAnchorNode, getColumnNo, getCommentAfterNode, getCommentBeforeNode, getCompactString, getDummyTag, getEndToken, getEvaluateDatatype, getEvalValue, getGsqlparser, getLineNo, getLocation, getMd5, getNodeStatus, getNodeType, getParentObjectName, getPlainText, getStartToken, getTokenCount, hasNext, init, init, init, init, init, insertAfterAToken, insertNewNodeBeforeMe, isChanged, isTokensInChain, next, refreshAllNodesTokenCount, remove, removeAllMyTokensFromTokenList, removeTokens, removeTokensBetweenNodes, removeTokensBetweenToken, replaceWithNewNode, resetIterator, setAnchorNode, setChanged, setDummyTag, setEndToken, setEndToken, setEndToken, setEndToken, setEndToken, setEndTokenDirectly, setEvaluateDatatype, setEvalValue, setGsqlparser, setIncludingComment, setLocation, setNewSubNode, setNodeStatus, setNodeType, setParent, setPlainText, setStartToken, setStartToken, setStartToken, setStartToken, setStartTokenDirectly, setString, setString2, subNodeInNode, toScript, toString, toString2

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterator

forEachRemaining

Field Detail

outerLabelName

protected TObjectName outerLabelName

declareStatements

protected TStatementList declareStatements

bodyStatements

protected TStatementList bodyStatements

exceptionClause

protected TExceptionClause exceptionClause

Constructor Detail

TBlockSqlNode

public TBlockSqlNode()

Method Detail

setParsed

public void setParsed(boolean parsed)

isParsed

public boolean isParsed()

init

public void init(Object arg1)

Description copied from class: TParseTreeNode

Initialize a query tree node. Used internally

Overrides:

init in class TParseTreeNode

Parameters:

arg1 - first argument

getExceptionClause

public TExceptionClause getExceptionClause()

setExceptionClause

public void setExceptionClause(TExceptionClause exceptionClause)

getDeclareStmts

public TStatementListSqlNode getDeclareStmts()

getStmts

public TStatementListSqlNode getStmts()

setStmts

public void setStmts(TStatementListSqlNode stmts)

setDeclareStmts

public void setDeclareStmts(TStatementListSqlNode declareStmts)

setOuterLabelName

public void setOuterLabelName(TObjectName outerLabelName)

getOuterLabelName

public TObjectName getOuterLabelName()

setDeclareStatements

public void setDeclareStatements(TStatementList declareStatements)

getDeclareStatements

public TStatementList getDeclareStatements()

setBodyStatements

public void setBodyStatements(TStatementList bodyStatements)

getBodyStatements

public TStatementList getBodyStatements()

doParse

public void doParse(TCustomSqlStatement psql,
                    ESqlClause plocation)

Description copied from class: TParseTreeNode

Analyze the sub-nodes inside this node. Such as build the relationship between table and column.

Overrides:

doParse in class TParseTreeNode

Parameters:

psql - SQL statement this node belongs to

plocation - SQL clause this node belongs to

accept

public void accept(TParseTreeVisitor v)

Description copied from class: TParseTreeNode

Accept a visitor

Specified by:

accept in interface Visitable

Overrides:

accept in class TParseTreeNode

Parameters:

v - visitor is a descendant class of TParseTreeVisitor

acceptChildren

public void acceptChildren(TParseTreeVisitor v)

Description copied from class: TParseTreeNode

Accept a visitor to iterate this class and sub-nodes of this class

Specified by:

acceptChildren in interface Visitable

Overrides:

acceptChildren in class TParseTreeNode

Parameters:

v - visitor is a descendant class of TParseTreeVisitor