TParseTreeNode (gudusoft.gsqlparser 2.0.1.0 API)

java.lang.Object
- gudusoft.gsqlparser.nodes.TParseTreeNode

All Implemented Interfaces:

Visitable

Direct Known Subclasses:

TAbortSqlNode, TAliasClause, TAlterAccessPolicySqlNode, TAlterAuthenticationSqlNode, TAlterDatabaseSqlNode, TAlterFaultGroupSqlNode, TAlterFunctionSqlNode, TAlterIndexSqlNode, TAlterLibrarySqlNode, TAlterNodeSqlNode, TAlterSchemaSqlNode, TAlterSequenceSqlNode, TAlterTableOption, TAlterTableSqlNode, TAlterTriggerSqlNode, TAlterViewSqlNode, TAnalyticFunction, TArrayAccess, TArrayConstruct, TAtBeforeClause, TAttributeOption, TAutomaticProperty, TBeginTranSqlNode, TBindArgument, TBinding, TBlockSqlNode, TBreakSqlNode, TBuildIndexesSqlNode, TCallSpec, TCallSqlNode, TCaseExpression, TCloseSqlNode, TCollectColumnIndex, TCollectFromOption, TCollectStatisticsSqlNode, TColumnAttribute, TColumnDefinition, TColumnReference, TColumnWithSortOrder, TCommentSqlNode, TCompoundSqlNode, TCompoundTriggerBodyNode, TComputeClause, TComputeClauseItem, TComputeExpr, TConnectByClause, TConnectSqlNode, TConstant, TConstraint, TConstructorBody, TConstructorSpec, TContainsTable, TContinueSqlNode, TCopyIntoNode, TCreateAccessPolicySqlNode, TCreateDatabaseSqlNode, TCreateDirectorySqlNode, TCreateFunctionOption, TCreateFunctionSqlNode, TCreateIndexSqlNode, TCreateMaterializedViewLogSqlNode, TCreateMaterializedViewSqlNode, TCreatePackageSqlNode, TCreateProcedureSqlNode, TCreateRowTypeSqlNode, TCreateSchemaSqlNode, TCreateSequenceSqlNode, TCreateSynonymSqlNode, TCreateTableSqlNode, TCreateTriggerSqlNode, TCreateUserSqlNode, TCreateViewSqlNode, TCTE, TCustomSqlStatement, TDataChangeTable, TDatatypeAttribute, TDatetimeExpression, TDaxExprPair, TDaxNameExpression, TDaxOrderByExpr, TDaxVar, TDeallocatePrepareSqlNode, TDeclareSqlNode, TDeclareVariable, TDeleteSqlNode, TDeleteStatisticsSqlNode, TDescribeSqlNode, TDropDatabaseSqlNode, TDropDbObjectSqlNode, TDropIndexItem, TDropIndexSqlNode, TDropProcedureSqlNode, TDropSchemaSqlNode, TDropSequenceSqlNode, TDropTableSqlNode, TDropViewSqlNode, TDummy, TElseIfSqlNode, TEndTranSqlNode, TErrorLoggingClause, TExceptionClause, TExceptionHandler, TExecImmeNode, TExecParameter, TExecuteAsClause, TExecuteAsSqlNode, TExecuteOption, TExecuteSqlNode, TExpandOnClause, TExplicitDataTypeConversion, TExportToVerticaSqlNode, TExpression, TExpressionCallTarget, TFetchFirstClause, TFetchSqlNode, TFlashback, TForSqlNode, TForUpdate, TFrameExclusionClause, TFunctionCall, TGenerateStatisticsSqlNode, TGetDiagSqlNode, TGrantSqlNode, TGroomTableSqlNode, TGroupBy, TGroupByItem, TGroupConcatParam, TGroupingExpressionItem, TGroupingSet, TGroupingSetItem, THierarchical, THintClause, THiveAnalyzeSqlNode, THiveClusterBy, THiveCreateRoleSqlNode, THiveDescribeSqlNode, THiveDescTablePartition, THiveDescTabType, THiveDistributeBy, THiveDropDBSqlNode, THiveDropFunctionSqlNode, THiveDropRoleSqlNode, THiveExplainSqlNode, THiveExportSqlNode, THiveFromQuerySqlNode, THiveGrantRoleSqlNode, THiveGrantSqlNode, THiveHintClause, THiveHintItem, THiveImportSqlNode, THiveIndexProperties, THiveKeyValueProperty, THiveLateralView, THiveLoadSqlNode, THiveMetastoreCheckSqlNode, THivePartitionedTableFunction, THivePrincipalName, THivePrivilegeDef, THiveRecordReader, THiveRecordWriter, THiveRowFormat, THiveShowGrantSqlNode, THiveShowRoleGrantSqlNode, THiveShowSqlNode, THiveSortBy, THiveSwitchDBSqlNode, THiveTableBuckets, THiveTableFileFormat, THiveTablePartition, THiveTableProperties, THiveTableSkewed, THiveTerminatedIdentifier, THiveTransformClause, THiveVariable, THiveWithDBPropertiesClause, TIfSqlNode, TIncludeColumns, TIndexColName, TIndexDefinition, TIndexKeyTerm, TIndexRef, TIndices, TIndirection, TInExpr, TInferKeyspaceSqlNode, TInformixOuterClause, TInsertBulkSqlNode, TInsertCondition, TInsertIntoValue, TInsertSqlNode, TIntervalExpression, TIntoClause, TIntoTableClause, TInvokerRightsClause, TIsolationClause, TJoinItem, TKeepDenseRankClause, TKeyAction, TKeyReference, TKeyspaceRef, TLimitClause, TLockingClause, TLockSqlNode, TLoopSqlNode, TMaterializedViewProps, TMdxAlterCubeNode, TMdxAxis, TMdxCalcPropNode, TMdxCallNode, TMdxCreateMeasureNode, TMdxCreateMemberNode, TMdxCreateSessionCubeNode, TMdxCreateSetNode, TMdxCreateSubCubeNode, TMdxDimContentNode, TMdxDrillthroughNode, TMdxExpNode, TMdxKeySegment, TMdxLevelContentNode, TMdxNameSegment, TMdxObjectNode, TMdxScopeNode, TMdxSelectNode, TMdxWhereNode, TMdxWithNode, TMergeDeleteClause, TMergeInsertClause, TMergeSqlNode, TMergeUpdateClause, TMergeWhenClause, TModeChoice, TMoveSqlNode, TMssqlBeginConversationTimerSqlNode, TMssqlBeginDialogSqlNode, TMssqlBulkInsertSqlNode, TMssqlCreateTriggerUpdateColumn, TMssqlCreateTypeSqlNode, TMssqlCreateXmlSchemaCollectionSqlNode, TMssqlDeallocateSqlNode, TMssqlEndConversationSqlNode, TMssqlGotoSqlNode, TMssqlLabelSqlNode, TMssqlRaiserrorSqlNode, TMssqlReconfigureSqlNode, TMssqlRevertSqlNode, TMssqlSendOnConversationSqlNode, TMssqlSetSqlNode, TMssqlStmtStubSqlNode, TMssqlThrowSqlNode, TMssqlUpdateTextSqlNode, TMultiTarget, TMySQLCreateTableOption, TMySQLIndexOption, TMySQLIndexStorageType, TMySQLPrepareSqlNode, TNameValuePair, TNewVariantTypeArgument, TNodeWithAliasClause, TNullSqlNode, TObjectAccess, TObjectConstruct, TObjectName, TObjectReference, TOffsetClause, TOpenDatasource, TOpenQuery, TOpenRowSet, TOpenSqlNode, TOpenXML, TOptimizeForClause, TOptionClause, TOracleBuildClause, TOracleCacheClause, TOracleCreateLibrarySqlNode, TOracleCreateMvRefresh, TOracleCreateMvRefreshOption, TOracleLoggingClause, TOracleParallelClause, TOracleUsingIndex, TOrderBy, TOrderByItem, TOutputClause, TOutputFormatPhrase, TPair, TParallelEnableClause, TParameterDeclaration, TParameterMode, TParseErrorSqlNode, TParseTreeNodeList, TPartitionByClause, TPartitionClause, TPartitionExtensionClause, TPerformSqlNode, TPhysicalAttributesClause, TPhysicalAttributesItem, TPhysicalProperties, TPivotedTable, TPivotInClause, TPrecisionScale, TProcedureOption, TPTNodeList, TPxGranule, TQualifyClause, TQueryHint, TReclaimChoice, TRelationExpr, TRepeatSqlNode, TRestrictionClause, TResultCacheClause, TResultSetDefinition, TReturningClause, TReturnSqlNode, TRevokeSqlNode, TRoleSpec, TRollupCube, TSampleClause, TSegmentAttributesClause, TSegmentAttributesItem, TSelectDistinct, TSelectSqlNode, TSequenceOption, TSetAssignment, TSetRowCountSqlNode, TSetSqlNode, TSizeClause, TStatementList, TStatementSqlNode, TStorageClause, TStorageItem, TStreamingClause, TStubStmtSqlNode, TSubscripts, TSupplementalLogging, TSybaseDumpTranSqlNode, TSybaseUpdateIndexStatisticsSqlNode, TTableElement, TTableHint, TTableReference, TTableSample, TTableSamplePart, TTDUnpivot, TTeradataCreateMacroSqlNode, TTeradataGiveSqlNode, TTeradataLockClause, TTeradataLockSqlNode, TTeradataStmtStubSqlNode, TTeradataUsingSqlNode, TTeradataWithClause, TTeradataWithClauseItem, TTimeSeries, TTimeTravel, TTimingPoint, TTopClause, TTriggerAction, TTriggerEventClause, TTriggerEventItem, TTriggeringClause, TTriggerReferencingClause, TTriggerReferencingItem, TTrimArgument, TTruncateTableSqlNode, TTypeAttribute, TTypeName, TUnnestClause, TUnpivotInClause, TUnpivotInClauseItem, TUpdateFor, TUpdateSqlNode, TUpsertSqlNode, TUseKeyIndex, TValueClause, TValueRowItem, TViewAliasClause, TViewAliasItem, TWhenClauseItem, TWhereClause, TWhileSqlNode, TWindowClause, TWindowDef, TWindowDefinition, TWindowFrame, TWindowFrameBoundary, TWindowPartitioningSpec, TWindowSpecification, TWithinGroup, TWithTableLock, TWritetextSqlNode, TXMLAttributesClause, TXmlElement, TXMLPassingClause, TXmlRoot, TXmlSerialize, TXmlTable, TXmlTableParameter
```
public abstract class TParseTreeNode
extends Object
implements Visitable
```
This class is the root class for all syntax/parse tree nodes. A syntax/parse tree node is composed of a sequence of tokens generated by the lexer.
The syntax node usually includes sub-nodes such as a where clause including expression node.
Check getNodeType() for type of this node.
This node includes all tokens from start token and end token

Constructor Summary

Constructors
Constructor and Description

TParseTreeNode()

Constructors
Constructor and Description
`TParseTreeNode()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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
`int`	`addAllMyTokensToTokenList(TSourceTokenList targetList, int index)` Deprecated. since v1.8.8.0, use scriptWriter technology to modify the node Inserts tokens(from start token to end token ) of this parse tree node at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right .
`protected void`	`appendString(String sqlSegment)` Deprecated. since v1.8.8.0, use scriptWriter technology to modify the node parse string to tokens, then add those tokens to the end of this parse tree node
`void`	`doParse(TCustomSqlStatement psql, ESqlClause plocation)` Analyze the sub-nodes inside this node.
`void`	`fastSetString(String sqlSegment)`
`long`	`getColumnNo()` Column position of the first token of this node
`int`	`getDummyTag()` A temporary value can be used for any purposes
`TSourceToken`	`getEndToken()` The last token of the node
`TGSqlParser`	`getGsqlparser()` The parser that generate this node.
`long`	`getLineNo()` Line number of the first token of this node
`int`	`getNodeType()` A unique value to distinguish this node from others
`TSourceToken`	`getStartToken()` The first token in this parse tree node
`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)`
`void`	`init(Object arg1, Object arg2, Object arg3, Object arg4, Object arg5)`
`void`	`init(Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6)`
`protected int`	`removeAllMyTokensFromTokenList(TSourceToken additionalToken)` Deprecated. since v1.8.8.0, use scriptWriter technology to modify the node
`void`	`setDummyTag(int dummyTag)`
`void`	`setEndToken(ArrayList endNode)`
`void`	`setEndToken(TParseTreeNode endNode)`
`void`	`setEndToken(TSourceToken endToken)`
`void`	`setEndToken(TSourceTokenList endTokenList)`
`void`	`setGsqlparser(TGSqlParser gsqlparser)`
`void`	`setIncludingComment(boolean includingComment)`
`void`	`setNodeType(int nodeType)` Set the node type for this node.
`void`	`setStartToken(ArrayList startNode)`
`void`	`setStartToken(TParseTreeNode startNode)`
`void`	`setStartToken(TSourceToken startToken)`
`void`	`setStartToken(TSourceTokenList startTokenList)`
`void`	`setString(String sqlSegment)` Deprecated. since v1.8.8.0, use scriptWriter technology to modify the node Set the new string text of a node will destroy all the sub-node structure
`String`	`toScript()` Text string of this node, the return value is the same as `toString()` if this node is not modified manually after created by parser.
`String`	`toString()` String representation of this parse tree node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TParseTreeNode
```
public TParseTreeNode()
```
- Method Detail
  - getGsqlparser
```
public TGSqlParser getGsqlparser()
```
    The parser that generate this node.
    
    Returns:
    
    parser that generate this node
  - setIncludingComment
```
public void setIncludingComment(boolean includingComment)
```
  - setGsqlparser
```
public void setGsqlparser(TGSqlParser gsqlparser)
```
  - setDummyTag
```
public void setDummyTag(int dummyTag)
```
  - getDummyTag
```
public int getDummyTag()
```
    A temporary value can be used for any purposes
    
    Returns:
    
    a temporary value used for any purposes
  - getStartToken
```
public TSourceToken getStartToken()
```
    The first token in this parse tree node
    
    Returns:
    
    the first token of node
  - getEndToken
```
public TSourceToken getEndToken()
```
    The last token of the node
    
    Returns:
    
    the last token of node
  - getColumnNo
```
public long getColumnNo()
```
    Column position of the first token of this node
    
    Returns:
    
    column position
  - getLineNo
```
public long getLineNo()
```
    Line number of the first token of this node
    
    Returns:
    
    line number
  - setNodeType
```
public void setNodeType(int nodeType)
```
    Set the node type for this node.
    
    Parameters:
    
    nodeType - The node type.
  - getNodeType
```
public int getNodeType()
```
    A unique value to distinguish this node from others
    
    Returns:
    
    enum value of node type
    
    See Also:
    
    ENodeType
  - init
```
public void init(Object arg1)
```
    Initialize a query tree node. Used internally
    
    Parameters:
    
    arg1 - first argument
  - init
```
public void init(Object arg1,
                 Object arg2)
```
  - init
```
public void init(Object arg1,
                 Object arg2,
                 Object arg3)
```
  - init
```
public void init(Object arg1,
                 Object arg2,
                 Object arg3,
                 Object arg4)
```
  - init
```
public void init(Object arg1,
                 Object arg2,
                 Object arg3,
                 Object arg4,
                 Object arg5)
```
  - init
```
public void init(Object arg1,
                 Object arg2,
                 Object arg3,
                 Object arg4,
                 Object arg5,
                 Object arg6)
```
  - doParse
```
public void doParse(TCustomSqlStatement psql,
                    ESqlClause plocation)
```
    Analyze the sub-nodes inside this node. Such as build the relationship between table and column.
    
    Parameters:
    
    psql - SQL statement this node belongs to
    
    plocation - SQL clause this node belongs to
  - setStartToken
```
public void setStartToken(ArrayList startNode)
```
  - setEndToken
```
public void setEndToken(ArrayList endNode)
```
  - setStartToken
```
public void setStartToken(TSourceToken startToken)
```
  - setStartToken
```
public void setStartToken(TSourceTokenList startTokenList)
```
  - setStartToken
```
public void setStartToken(TParseTreeNode startNode)
```
  - setEndToken
```
public void setEndToken(TSourceToken endToken)
```
  - setEndToken
```
public void setEndToken(TSourceTokenList endTokenList)
```
  - setEndToken
```
public void setEndToken(TParseTreeNode endNode)
```
  - setString
```
public void setString(String sqlSegment)
```
    Deprecated. since v1.8.8.0, use scriptWriter technology to modify the node Set the new string text of a node will destroy all the sub-node structure
    
    Parameters:
    
    sqlSegment - that override original text of this node.
  - fastSetString
```
public void fastSetString(String sqlSegment)
```
  - toString
```
public String toString()
```
    String representation of this parse tree node.
    This string was generated by collecting text from the start token of this node to the end token of this node. If this node was modified later, then use toScript() to get string representation of this node.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation of this parse tree node
  - addAllMyTokensToTokenList
```
public int addAllMyTokensToTokenList(TSourceTokenList targetList,
                                     int index)
```
    Deprecated. since v1.8.8.0, use scriptWriter technology to modify the node Inserts tokens(from start token to end token ) of this parse tree node at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right .
    
    Parameters:
    
    targetList - the new list of source tokens
    
    index - the position insert the targetList
    
    Returns:
    
    length of the source token list after insert targetList
  - removeAllMyTokensFromTokenList
```
protected int removeAllMyTokensFromTokenList(TSourceToken additionalToken)
```
    Deprecated. since v1.8.8.0, use scriptWriter technology to modify the node
    
    Parameters:
    
    additionalToken - usually was comma before or after this parse tree node that also need to be deleted
    
    Returns:
    
    length of the source token list after remove tokens
  - appendString
```
protected void appendString(String sqlSegment)
```
    Deprecated. since v1.8.8.0, use scriptWriter technology to modify the node parse string to tokens, then add those tokens to the end of this parse tree node
    
    Parameters:
    
    sqlSegment -
  - accept
```
public void accept(TParseTreeVisitor v)
```
    Accept a visitor
    
    Specified by:
    
    accept in interface Visitable
    
    Parameters:
    
    v - visitor is a descendant class of TParseTreeVisitor
  - acceptChildren
```
public void acceptChildren(TParseTreeVisitor v)
```
    Accept a visitor to iterate this class and sub-nodes of this class
    
    Specified by:
    
    acceptChildren in interface Visitable
    
    Parameters:
    
    v - visitor is a descendant class of TParseTreeVisitor
  - toScript
```
public String toScript()
```
    Text string of this node, the return value is the same as toString() if this node is not modified manually after created by parser.
    If this node is modified, then use this method to get string representation instead of the toString() method.
    
    Returns:
    
    text string of this node

Class TParseTreeNode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TParseTreeNode

Method Detail

getGsqlparser

setIncludingComment

setGsqlparser

setDummyTag

getDummyTag

getStartToken

getEndToken

getColumnNo

getLineNo

setNodeType

getNodeType

init

init

init

init

init

init

doParse

setStartToken

setEndToken

setStartToken

setStartToken

setStartToken

setEndToken

setEndToken

setEndToken

setString

fastSetString

toString

addAllMyTokensToTokenList

removeAllMyTokensFromTokenList

appendString

accept

acceptChildren

toScript