Package gudusoft.gsqlparser.stmt

Class TVarDeclStmt

Object

gudusoft.gsqlparser.nodes.TParseTreeNode

gudusoft.gsqlparser.TCustomSqlStatement

gudusoft.gsqlparser.stmt.TVarDeclStmt

All Implemented Interfaces:

IRelation, Visitable, Iterator<TSourceToken>

public class TVarDeclStmt
extends TCustomSqlStatement

Represents declare statement that used to decalre variable, constant, exception and subtype. Or Signifies that the statement is a pragma (compiler directive), including exception_init_pragma, autonomous_transaction_pragma, restrict_references_pragma, serially_resuable_pragma and pragma_timestamp

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	whatDeclared_constant	Deprecated. As of v1.4.8.8, replaced by EDeclareType.constant
static final int	whatDeclared_exception	Deprecated. As of v1.4.8.8, replaced by EDeclareType.exception
static final int	whatDeclared_pragma_autonomous_transaction	Deprecated. As of v1.4.8.8, replaced by EDeclareType.pragma_autonomous_transaction
static final int	whatDeclared_pragma_exception_init	Deprecated. As of v1.4.8.8, replaced by EDeclareType.pragma_exception_init
static final int	whatDeclared_pragma_interface	Deprecated. As of v1.4.8.8, replaced by EDeclareType.pragma_interface
static final int	whatDeclared_pragma_restrict_references	Deprecated. As of v1.4.8.8, replaced by EDeclareType.pragma_restrict_references
static final int	whatDeclared_pragma_serially_reusable	Deprecated. As of v1.4.8.8, replaced by EDeclareType.pragma_serially_reusable
static final int	whatDeclared_pragma_timestamp	Deprecated. As of v1.4.8.8, replaced by EDeclareType.pragma_timestamp
static final int	whatDeclared_subtype	Deprecated. As of v1.4.8.8, replaced by EDeclareType.subtype
static final int	whatDeclared_variable	Deprecated. As of v1.4.8.8, replaced by EDeclareType.variable

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
TVarDeclStmt()
TVarDeclStmt(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)
TObjectName	getAliasItem()
TObjectName	getCollateName()
TTypeName	getDataType()	Datatype of declared element.
EDeclareType	getDeclareType()
TExpression	getDefaultValue()	Default value of a variable or constant that declared.
TObjectName	getElementName()	Name of element that declared.
TExpression	getError_number()	Any valid Oracle Database error number.
TObjectName	getException_name()	Name of a user-defined exception declared within the current scope.
int	getHowtoSetValue()	How deafult value of a variable or constant was set.
boolean	getNotNull()	Specifies that no element can have the value NULL.
TExpression	getValue()	Deprecated. As of v1.4.8.8, replaced by getDefaultValue()
int	getWhatDeclared()	Indicates what's kind of element this delcare statement declared such as variable, constant, exception, subtype and various pragma clause.
void	init(Object arg1)	Initialize a query tree node.
void	init(Object arg1, Object arg2)
void	init(Object arg1, Object arg2, Object arg3, Object arg4)
void	setAliasItem(TObjectName aliasItem)
void	setCollateName(TObjectName collateName)
void	setDataType(TTypeName dataType)
void	setDeclareType(EDeclareType declareType)
void	setDefaultValue(TExpression defaultValue)
void	setElementName(TObjectName elementName)
void	setError_number(TExpression error_number)
void	setException_name(TObjectName exception_name)
void	setHowtoSetValue(int howtoSetValue)
void	setNotNull(boolean notNull)
void	setValue(TExpression value)
void	setWhatDeclared(int whatDeclared)

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, getEndlabelName, getErrorCount, getErrormessage, getExpandedResultColumns, getFirstPhysicalTable, getFrameStack, getFromClause, getFromSourceJoin, getFromSourceTable, getGlobalScope, getIndexColumns, getJoins, getLabelName, 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, 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

whatDeclared_variable

public static final int whatDeclared_variable

Deprecated.

As of v1.4.8.8, replaced by EDeclareType.variable

See Also:

• Constant Field Values

whatDeclared_constant

public static final int whatDeclared_constant

Deprecated.

As of v1.4.8.8, replaced by EDeclareType.constant

See Also:

• Constant Field Values

whatDeclared_exception

public static final int whatDeclared_exception

Deprecated.

As of v1.4.8.8, replaced by EDeclareType.exception

See Also:

• Constant Field Values

whatDeclared_subtype

public static final int whatDeclared_subtype

Deprecated.

As of v1.4.8.8, replaced by EDeclareType.subtype

See Also:

• Constant Field Values

whatDeclared_pragma_exception_init

public static final int whatDeclared_pragma_exception_init

Deprecated.

As of v1.4.8.8, replaced by EDeclareType.pragma_exception_init

See Also:

• Constant Field Values

whatDeclared_pragma_autonomous_transaction

public static final int whatDeclared_pragma_autonomous_transaction

Deprecated.

As of v1.4.8.8, replaced by EDeclareType.pragma_autonomous_transaction

See Also:

• Constant Field Values

whatDeclared_pragma_serially_reusable

public static final int whatDeclared_pragma_serially_reusable

Deprecated.

As of v1.4.8.8, replaced by EDeclareType.pragma_serially_reusable

See Also:

• Constant Field Values

whatDeclared_pragma_timestamp

public static final int whatDeclared_pragma_timestamp

Deprecated.

As of v1.4.8.8, replaced by EDeclareType.pragma_timestamp

See Also:

• Constant Field Values

whatDeclared_pragma_restrict_references

public static final int whatDeclared_pragma_restrict_references

Deprecated.

As of v1.4.8.8, replaced by EDeclareType.pragma_restrict_references

See Also:

• Constant Field Values

whatDeclared_pragma_interface

public static final int whatDeclared_pragma_interface

Deprecated.

As of v1.4.8.8, replaced by EDeclareType.pragma_interface

See Also:

• Constant Field Values

Constructor Details

TVarDeclStmt

public TVarDeclStmt()

TVarDeclStmt

public TVarDeclStmt(EDbVendor dbvendor)

Method Details

setWhatDeclared

public void setWhatDeclared(int whatDeclared)

getWhatDeclared

public int getWhatDeclared()

Indicates what's kind of element this delcare statement declared such as variable, constant, exception, subtype and various pragma clause.

Returns:

getHowtoSetValue

public int getHowtoSetValue()

How deafult value of a variable or constant was set.

:= | DEFAULT

:= TBaseType.howtoSetValue_assign

or DEFAULT keyword TBaseType.howtoSetValue_default;

Returns:

getValue

public TExpression getValue()

Deprecated.

As of v1.4.8.8, replaced by getDefaultValue()

getNotNull

public boolean getNotNull()

Specifies that no element can have the value NULL.

Returns:

setDefaultValue

public void setDefaultValue(TExpression defaultValue)

getDefaultValue

public TExpression getDefaultValue()

Default value of a variable or constant that declared.

setCollateName

public void setCollateName(TObjectName collateName)

getCollateName

public TObjectName getCollateName()

setDeclareType

public void setDeclareType(EDeclareType declareType)

getDeclareType

public EDeclareType getDeclareType()

setError_number

public void setError_number(TExpression error_number)

setException_name

public void setException_name(TObjectName exception_name)

getError_number

public TExpression getError_number()

Any valid Oracle Database error number. Used when this class represents exception_init_pragma.

Returns:

getException_name

public TObjectName getException_name()

Name of a user-defined exception declared within the current scope. Used when this class represents exception_init_pragma.

Returns:

setAliasItem

public void setAliasItem(TObjectName aliasItem)

getAliasItem

public TObjectName getAliasItem()

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,
 Object arg4)

Overrides:

init in class TParseTreeNode

getDataType

public TTypeName getDataType()

Datatype of declared element.

Returns:

doParseStatement

public int doParseStatement(TCustomSqlStatement psql)

Overrides:

doParseStatement in class TCustomSqlStatement

getElementName

public TObjectName getElementName()

Name of element that declared.

Returns:

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

setElementName

public void setElementName(TObjectName elementName)

setDataType

public void setDataType(TTypeName dataType)

setNotNull

public void setNotNull(boolean notNull)

setValue

public void setValue(TExpression value)

setHowtoSetValue

public void setHowtoSetValue(int howtoSetValue)