Package gudusoft.gsqlparser.nodes

Class TParameterDeclaration

Object

gudusoft.gsqlparser.nodes.TParseTreeNode

gudusoft.gsqlparser.nodes.TParameterDeclaration

All Implemented Interfaces:

Visitable, Iterator<TSourceToken>

public class TParameterDeclaration
extends TParseTreeNode

Parameters in create procedure/function statements. Field declaration in plsql record type definition Parameter declaration in plsql cursor declaration.

Field Summary

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

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

Constructor Summary

Constructors

Constructor	Description
TParameterDeclaration()

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
ArrayList<TDataConversion>	getDataConversions()
TTypeName	getDataType()	Datatype of declared element.
TExpression	getDefaultValue()	Specifies a default value for an IN parameter.
int	getHowtoSetValue()	How deafult value of parameter was set.
int	getMode()
Boolean	getNotNull()	Is valid when this class represents field declaration in plsql record type definition.
EParameterMode	getParameterMode()
TObjectName	getParameterName()	The name of the formal parameter that you are declaring, which you can reference in the body of the subprogram.
TConstant	getVaryPrecision()	SQL Server varying precision
void	init(Object arg1)	Initialize a query tree node.
void	init(Object arg1, Object arg2)
void	init(Object arg1, Object arg2, Object arg3)
boolean	isNocopy()	Specify NOCOPY to instruct the database to pass this argument as fast as possible.
boolean	isVarying()	SQL Server varying
void	setDataType(TTypeName dataType)
void	setDefaultValue(TExpression defaultValue)
void	setHowtoSetValue(int howtoSetValue)
void	setMode(int mode)
void	setNocopy(boolean nocopy)
void	setNotNull(Boolean notNull)
void	setParameterMode(EParameterMode parameterMode)
void	setParameterName(TObjectName parameterName)
void	setVarying(boolean isVarying)
void	setVaryPrecision(TConstant varyPrecision)

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, getParentObjectName, 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, toScript, 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

Constructor Details

TParameterDeclaration

public TParameterDeclaration()

Method Details

getParameterMode

public EParameterMode getParameterMode()

Returns:

Parameter modes that define the action of formal parameters:

Oracle plsq: in, out, in out.

SQL Server: out, output, readonly

setNocopy

public void setNocopy(boolean nocopy)

getDataType

public TTypeName getDataType()

Datatype of declared element.

Returns:

isNocopy

public boolean isNocopy()

Specify NOCOPY to instruct the database to pass this argument as fast as possible.

Returns:

setMode

public void setMode(int mode)

getMode

public int getMode()

Returns:

Parameter modes that define the action of formal parameters:

Oracle plsq: in, out, in out.

SQL Server: out, output, readonly Use instead

getDefaultValue

public TExpression getDefaultValue()

Specifies a default value for an IN parameter.

Returns:

getParameterName

public TObjectName getParameterName()

The name of the formal parameter that you are declaring, which you can reference in the body of the subprogram.

Or, the name of the field in field declaration of record type definition.

Returns:

setDefaultValue

public void setDefaultValue(TExpression defaultValue)

setNotNull

public void setNotNull(Boolean notNull)

getNotNull

public Boolean getNotNull()

Is valid when this class represents field declaration in plsql record type definition.

getHowtoSetValue

public int getHowtoSetValue()

How deafult value of parameter was set.

:= | DEFAULT

:= TBaseType.howtoSetValue_assign

or DEFAULT keyword TBaseType.howtoSetValue_default;

Returns:

isVarying

public boolean isVarying()

SQL Server varying

Returns:

setParameterMode

public void setParameterMode(EParameterMode parameterMode)

getVaryPrecision

public TConstant getVaryPrecision()

SQL Server varying precision

Returns:

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

getDataConversions

public ArrayList<TDataConversion> getDataConversions()

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

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

setParameterName

public void setParameterName(TObjectName parameterName)

setDataType

public void setDataType(TTypeName dataType)

setHowtoSetValue

public void setHowtoSetValue(int howtoSetValue)

setVarying

public void setVarying(boolean isVarying)

setVaryPrecision

public void setVaryPrecision(TConstant varyPrecision)