Package gudusoft.gsqlparser.stmt

Class TLoopStmt

Object

gudusoft.gsqlparser.nodes.TParseTreeNode

gudusoft.gsqlparser.TCustomSqlStatement

gudusoft.gsqlparser.stmt.TBlockSqlStatement

gudusoft.gsqlparser.stmt.TLoopStmt

All Implemented Interfaces:

IRelation, Visitable, Iterator<TSourceToken>

public class TLoopStmt
extends TBlockSqlStatement

A LOOP statement executes a sequence of statements multiple times. PL/SQL provides these loop statements:

• Basic loop
• WHILE loop
• FOR loop

  FOR indexName IN lower_bound .. upper_bound LOOP statements END LOOP

• Cursor FOR loop

See Also:

• TBlockSqlStatement.bodyStatements

Nested Class Summary

Nested classes/interfaces inherited from class gudusoft.gsqlparser.TCustomSqlStatement

TCustomSqlStatement.SqlNormalizationProfile

Field Summary

Fields

Modifier and Type	Field	Description
static final int	basic_loop
static final int	cursor_for_loop
static final int	for_loop
static final int	while_loop

Fields inherited from class gudusoft.gsqlparser.stmt.TBlockSqlStatement

blockBody, bodyStatements, declareStatements, exceptionClause

Fields inherited from class gudusoft.gsqlparser.TCustomSqlStatement

dummytag, fromClause, fromSourceJoin, fromSourceTable, isctequery, isparsed, joins, parser, plsqlparser, relationAttributes, rootNode, semicolonended, sourcetokenlist, sqlstatementtype, stmtScope, tables

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

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

Constructor Summary

Constructors

Constructor	Description
TLoopStmt()
TLoopStmt(EDbVendor dbvendor)

Method Summary

Modifier and Type	Method	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
int	doParseStatement(TCustomSqlStatement psql)
TExpression	getCondition()	Used in while-loop-statement
TObjectName	getCursorName()
TExpressionList	getCursorParameterNames()
TExpression	getExecuteExpr()
TExpressionList	getExecuteUsingVars()
TObjectName	getIndexName()	An undeclared identifier that names the loop index.
int	getKind()
TExpression	getLower_bound()	Used in for-loop-statement.
TObjectName	getRecordName()
TObjectNameList	getScalarVariables()
TSelectSqlStatement	getSubquery()
TExpression	getUpper_bound()	Used in for-loop-statement.
void	init(Object arg1)	Initialize a query tree node.
void	init(Object arg1, Object arg2)
void	init(Object arg1, Object arg2, Object arg3)
void	init(Object arg1, Object arg2, Object arg3, Object arg4)
boolean	isReverse()
void	setCondition(TExpression condition)
void	setCursorName(TObjectName cursorName)
void	setCursorParameterNames(TExpressionList cursorParameterNames)
void	setExecuteExpr(TExpression executeExpr)
void	setExecuteUsingVars(TExpressionList executeUsingVars)
void	setIndexName(TObjectName indexName)
void	setKind(int kind)
void	setLower_bound(TExpression lower_bound)
void	setRecordName(TObjectName recordName)
void	setReverse(boolean reverse)
void	setSelectSqlNode(TSelectSqlNode selectSqlNode)
void	setSubquery(TSelectSqlStatement subquery)
void	setUpper_bound(TExpression upper_bound)

Methods inherited from class gudusoft.gsqlparser.stmt.TBlockSqlStatement

getBlockBody, getBodyStatements, getDeclareStatements, getEndlabelName, getExceptionClause, getLabelName, getLabelNameStr, setBodyStatements, setDeclareStatements, setExceptionClause

Methods inherited from class gudusoft.gsqlparser.TCustomSqlStatement

addToTables, addWhereClause, analyzeFromTable, analyzeFromTable, analyzeJoin, analyzeTablename, analyzeTableOrJoin, asCanonical, checkNonQualifiedColumnReferenceInSubQueryOfUplevelStmt, clearError, computeSqlHash, dochecksyntax, findTable, fireOnMetaDatabaseTableColumn, getAncestorStmt, getAttributes, getColumnsInTable, getColumnsInTable, getCteIncludeThisStmt, getCteList, getDaxFunctionStack, getErrorCount, getErrormessage, getExpandedResultColumns, getFirstPhysicalTable, getFrameStack, getFromClause, getFromSourceJoin, getFromSourceTable, getGlobalScope, getIndexColumns, getJoins, getOrphanColumns, getOutputClause, getParentObjectName, getParentStmt, getQueryId, getRelationName, getRelations, getResultColumnList, getReturningClause, getSqlEnv, getSqlHash, getSqlHash, getStatements, getStmtScope, getSymbolTable, getSyntaxErrors, getSyntaxHints, getTables, getTargetTable, getTokenList, getTopClause, getTopStatement, getUsingVariableList, getVariableStack, getWhereClause, isathenaplsql, isBigQueryplsql, isdatabricksplsql, isGaussDBStoredProcedure, isgreeplumplsql, isnzplsql, isoracleplsql, ispgplsql, isprestoplsql, issnowflakeplsql, isTableACTE, isverticaplsql, linkColumnReferenceToTable, linkColumnToTable, linkToFirstTable, locateVariableOrParameter, locateVariableOrParameter, OracleStatementCanBeSeparatedByBeginEndPair, parseerrormessagehandle, parsestatement, parsestatement, searchCTEList, searchDaxVariableInStack, searchFunctionInSQLEnv, setAlreadyAddToParent, setCteIncludeThisStmt, setCteList, setEndlabelName, setFrameStack, setFromClause, setLabelName, setOutputClause, setParentStmt, setParentStmtToNull, setQueryId, setResultColumnList, setReturningClause, setSqlHash, setStmtScope, setTargetTable, setTopClause, setUsingVariableList, setVariableStack, setWhereClause, size, toNormalizedSql, toScript, VerticaStatementCanBeSeparatedByBeginEndPair

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

addAllMyTokensToTokenList, addToTokenChain, appendNewNode, calculateTokenCount, doAppendNewNode, doParse, fastSetString, getAnchorNode, getColumnNo, getCommentAfterNode, getCommentBeforeNode, getCompactString, getDummyTag, getEndToken, getEvaluateDatatype, getEvalValue, getGsqlparser, getLineNo, getLocation, getMd5, getNodeStatus, getNodeType, getPlainText, getStartToken, getTokenCount, hasNext, 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, toString, toString2

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Details

basic_loop

public static final int basic_loop

See Also:

• Constant Field Values

while_loop

public static final int while_loop

See Also:

• Constant Field Values

for_loop

public static final int for_loop

See Also:

• Constant Field Values

cursor_for_loop

public static final int cursor_for_loop

See Also:

• Constant Field Values

Constructor Details

TLoopStmt

public TLoopStmt()

TLoopStmt

public TLoopStmt(EDbVendor dbvendor)

Method Details

setKind

public void setKind(int kind)

getKind

public int getKind()

Returns:

What's kind of loop statement: simple, while or for.

getScalarVariables

public TObjectNameList getScalarVariables()

getIndexName

public TObjectName getIndexName()

An undeclared identifier that names the loop index. Or, it should be a record-name when kind is cursor_for_loop.

Returns:

Index name used in for-loop-statement.

getRecordName

public TObjectName getRecordName()

setReverse

public void setReverse(boolean reverse)

isReverse

public boolean isReverse()

getUpper_bound

public TExpression getUpper_bound()

Used in for-loop-statement.

Returns:

getLower_bound

public TExpression getLower_bound()

Used in for-loop-statement.

Returns:

setSubquery

public void setSubquery(TSelectSqlStatement subquery)

getSubquery

public TSelectSqlStatement getSubquery()

Returns:

Select statement when kind is cursor_for_loop.

setSelectSqlNode

public void setSelectSqlNode(TSelectSqlNode selectSqlNode)

setCursorParameterNames

public void setCursorParameterNames(TExpressionList cursorParameterNames)

getCursorParameterNames

public TExpressionList getCursorParameterNames()

Returns:

Cursor parameter names when kind is cursor_for_loop if any.

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

init

public void init(Object arg1,
 Object arg2)

Overrides:

init in class TParseTreeNode

init

public void init(Object arg1,
 Object arg2,
 Object arg3)

Overrides:

init in class TParseTreeNode

init

public void init(Object arg1,
 Object arg2,
 Object arg3,
 Object arg4)

Overrides:

init in class TParseTreeNode

getCursorName

public TObjectName getCursorName()

Returns:

Cursor name when kind is cursor_for_loop.

getCondition

public TExpression getCondition()

Used in while-loop-statement

Returns:

If and only if the value of this expression is TRUE, the statements in while will execute.

setExecuteExpr

public void setExecuteExpr(TExpression executeExpr)

setExecuteUsingVars

public void setExecuteUsingVars(TExpressionList executeUsingVars)

getExecuteExpr

public TExpression getExecuteExpr()

getExecuteUsingVars

public TExpressionList getExecuteUsingVars()

doParseStatement

public int doParseStatement(TCustomSqlStatement psql)

Overrides:

doParseStatement in class TBlockSqlStatement

accept

public void accept(TParseTreeVisitor v)

Description copied from class: TParseTreeNode

Accept a visitor

Specified by:

accept in interface Visitable

Overrides:

accept in class TBlockSqlStatement

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 TBlockSqlStatement

Parameters:

v - visitor is a descendant class of TParseTreeVisitor

setIndexName

public void setIndexName(TObjectName indexName)

setRecordName

public void setRecordName(TObjectName recordName)

setLower_bound

public void setLower_bound(TExpression lower_bound)

setUpper_bound

public void setUpper_bound(TExpression upper_bound)

setCursorName

public void setCursorName(TObjectName cursorName)

setCondition

public void setCondition(TExpression condition)