TParseTreeNode (General SQL Parser Java Library Core 3.0.9.1 API)

Object
- gudusoft.gsqlparser.nodes.TParseTreeNode

All Implemented Interfaces:

Visitable, Iterator<TSourceToken>

Direct Known Subclasses:

TAbortSqlNode, TAliasClause, TAlterAccessPolicySqlNode, TAlterAuthenticationSqlNode, TAlterDatabaseSqlNode, TAlterFaultGroupSqlNode, TAlterFunctionSqlNode, TAlterIndexSqlNode, TAlterLibrarySqlNode, TAlterNodeSqlNode, TAlterPartitionFunctionSqlNode, TAlterPartitionSchemeSqlNode, TAlterProcedureSqlNode, TAlterSchemaSqlNode, TAlterSequenceSqlNode, TAlterSessionSqlNode, TAlterTableOption, TAlterTableSqlNode, TAlterTriggerSqlNode, TAlterTypeOption, TAlterTypeSqlNode, TAlterViewSqlNode, TAnalyticFunction, TAnalyzeSqlNode, TArrayAccess, TArrayConstruct, TAtBeforeClause, TAttributeOption, TAttributeOrMethod, TAuthorizationClause, TAutomaticProperty, TBaseTablePartition, TBeginTranSqlNode, TBindArgument, TBinding, TBreakSqlNode, TBuildIndexesSqlNode, TCallSpec, TCallSqlNode, TCaseExpression, TCaseJoinClause, TCaseJoinItem, TCharacterDatatypeProperty, TCloseSqlNode, TClusterBy, TCollectColumnIndex, TCollectFromOption, TCollectStatisticsSqlNode, TColumnAttribute, TColumnDefinition, TColumnGeneratedClause, TColumnReference, TColumnStorage, TColumnWithSortOrder, TCommentSqlNode, TCommitSqlNode, TCompoundSqlNode, TCompoundTriggerBodyNode, TComputeClause, TComputeClauseItem, TComputeExpr, TConnectByClause, TConnectSqlNode, TConstant, TConstraint, TConstructorBody, TConstructorSpec, TContainsTable, TContinueSqlNode, TCopyIntoNode, TCopyIntoSqlNode, TCopySqlNode, TCreateAccessPolicySqlNode, TCreateDatabaseSqlNode, TCreateDirectorySqlNode, TCreateFunctionOption, TCreateFunctionSqlNode, TCreateIndexSqlNode, TCreateMacroSqlNode, TCreateMaterializedViewLogSqlNode, TCreateMaterializedViewSqlNode, TCreatePackageSqlNode, TCreatePartitionFunctionSqlNode, TCreatePartitionSchemeSqlNode, TCreatePipeSqlNode, TCreateProcedureSqlNode, TCreateRowTypeSqlNode, TCreateSchemaSqlNode, TCreateSecurityPolicySqlNode, TCreateSequenceSqlNode, TCreateStageSqlNode, TCreateStreamSqlNode, TCreateSynonymSqlNode, TCreateTableOption, TCreateTableSqlNode, TCreateTaskSqlNode, TCreateTriggerSqlNode, TCreateTypeSqlNode, TCreateUserSqlNode, TCreateViewSqlNode, TCustomForXMLItem, TCustomSqlStatement, TDataChangeTable, TDataConversion, TDataConversionItem, TDataDefinition, TDatatypeAttribute, TDatetimeExpression, TDaxExprPair, TDaxNameExpression, TDaxOrderByExpr, TDaxVar, TDeallocatePrepareSqlNode, TDeclareSqlNode, TDeclareVariable, TDeleteSqlNode, TDeleteStatisticsSqlNode, TDescribeSqlNode, TDisableEnableTriggerSqlNode, TDistributeBy, TDoExecuteBlockSqlNode, TDropDatabaseSqlNode, TDropDbObjectSqlNode, TDropFunctionSqlNode, TDropIndexItem, TDropIndexSqlNode, TDropProcedureSqlNode, TDropSchemaSqlNode, TDropSequenceSqlNode, TDropTableSqlNode, TDropViewSqlNode, TDummy, TElseIfSqlNode, TEndTranSqlNode, TErrorLoggingClause, TExceptionClause, TExceptionHandler, TExceptReplaceClause, TExecImmeNode, TExecParameter, TExecuteAsClause, TExecuteAsSqlNode, TExecuteOption, TExecuteSqlNode, TExpandOnClause, TExplicitDataTypeConversion, TExportDataSqlNode, TExportToVerticaSqlNode, TExpression, TExpressionCallTarget, TExternalTableOption, TFetchFirstClause, TFetchSqlNode, TFileFormatSqlNode, TFlashback, TForSqlNode, TForUpdate, TForXMLClause, TFrameExclusionClause, TFunctionCall, TFunctionHeader, TGenerateStatisticsSqlNode, TGetDiagSqlNode, TGrantSqlNode, TGroomTableSqlNode, TGroupBy, TGroupByItem, TGroupConcatParam, TGroupingExpressionItem, TGroupingSet, TGroupingSetItem, THandlerForCondition, THashByClause, THavingClause, THierarchical, THintClause, THiveCreateRoleSqlNode, THiveDescribeSqlNode, THiveDescTablePartition, THiveDescTabType, THiveDropDBSqlNode, THiveDropFunctionSqlNode, THiveDropRoleSqlNode, THiveExplainSqlNode, THiveExportSqlNode, THiveFromQuerySqlNode, THiveGrantRoleSqlNode, THiveGrantSqlNode, THiveHintClause, THiveHintItem, THiveImportSqlNode, THiveIndexProperties, THiveKeyValueProperty, THiveLoadSqlNode, THivePartitionedTableFunction, THivePrincipalName, THivePrivilegeDef, THiveRecordReader, THiveRecordWriter, THiveRowFormat, THiveShowGrantSqlNode, THiveShowRoleGrantSqlNode, THiveShowSqlNode, THiveSwitchDBSqlNode, THiveTableBuckets, THiveTableFileFormat, THiveTablePartition, THiveTableProperties, THiveTableSkewed, THiveTerminatedIdentifier, THiveTransformClause, THiveVariable, THiveWithDBPropertiesClause, TIdentityClause, TIfSqlNode, TIncludeColumns, TIndexColName, TIndexDefinition, TIndexKeyTerm, TIndexRef, TIndices, TIndirection, TInExpr, TInferKeyspaceSqlNode, TInformixOuterClause, TInheritsClause, TInsertBulkSqlNode, TInsertCondition, TInsertIntoValue, TInsertSqlNode, TIntervalExpression, TIntoClause, TIntoTableClause, TInvokerRightsClause, TIsolationClause, TIterateSqlNode, TJoinItem, TJsonObjectKeyValue, TKeepDenseRankClause, TKeyAction, TKeyReference, TKeyspaceRef, TKeyValueSqlNode, TLateralView, TLeaveSqlNode, TLimitClause, TListaggOverflow, TListSubpartitionDesc, TListValuesClause, TLockingClause, TLockSqlNode, TMaterializedViewProps, TMdxAlterCubeNode, TMdxAxis, TMdxCalcPropNode, TMdxCallNode, TMdxCreateMeasureNode, TMdxCreateMemberNode, TMdxCreateSessionCubeNode, TMdxCreateSetNode, TMdxCreateSubCubeNode, TMdxDimContentNode, TMdxDrillthroughNode, TMdxExpNode, TMdxKeySegment, TMdxLevelContentNode, TMdxNameSegment, TMdxObjectNode, TMdxScopeNode, TMdxSelectNode, TMdxWhereNode, TMdxWithNode, TMergeActionClause, TMergeSqlNode, TMergeWhenClause, TModeChoice, TMoveSqlNode, TMSCKSqlNode, TMssqlBeginConversationTimerSqlNode, TMssqlBeginDialogSqlNode, TMssqlBulkInsertSqlNode, TMssqlCreateTriggerUpdateColumn, TMssqlCreateTypeSqlNode, TMssqlCreateXmlSchemaCollectionSqlNode, TMssqlDeallocateSqlNode, TMssqlEndConversationSqlNode, TMssqlGotoSqlNode, TMssqlLabelSqlNode, TMssqlRaiserrorSqlNode, TMssqlReconfigureSqlNode, TMssqlRevertSqlNode, TMssqlSendOnConversationSqlNode, TMssqlSetSqlNode, TMssqlStmtStubSqlNode, TMssqlThrowSqlNode, TMssqlUpdateTextSqlNode, TMultiTarget, TMySQLCreateTableOption, TMySQLIndexOption, TMySQLIndexStorageType, TNameValuePair, TNewVariantTypeArgument, TNodeWithAliasClause, TNodeWithLabel, 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, TPartitionBoundSpecSqlNode, TPartitionByClause, TPartitionClause, TPartitionDefinition, TPartitionExtensionClause, TPartitioningLevel, TPartitionSplitMergeClause, TPathSqlNode, TPerformSqlNode, TPeriodForClause, TPhysicalAttributesClause, TPhysicalAttributesItem, TPhysicalProperties, TPivotedTable, TPivotInClause, TPrecisionScale, TPredictArgument, TPrepareSqlNode, TProcedureOption, TPTNodeList, TPxGranule, TQualifyClause, TQueryHint, TRangeNFunctionItem, TRangeSubpartitionDesc, TRangeValuesClause, TReclaimChoice, TRedshiftTableAttributes, TRelationExpr, TReplaceExprAsIdentifier, TResetSqlNode, TRestrictionClause, TResultCacheClause, TResultSetDefinition, TReturningClause, TReturnSqlNode, TRevokeSqlNode, TRoleSpec, TRollbackSqlNode, TRollupCube, TSampleClause, TScriptSqlNode, TSegmentAttributesClause, TSegmentAttributesItem, TSelectDistinct, TSelectModifier, TSelectSqlNode, TSequenceOption, TSetAssignment, TSetRowCountSqlNode, TSetSessionSqlNode, TSetSqlNode, TSignalSqlNode, TSizeClause, TSortBy, TStageLocation, TStageReference, TStatementList, TStatementSqlNode, TStorageClause, TStorageItem, TStreamingClause, TStubStmtSqlNode, TSubPartitionByClause, TSubscripts, TSupplementalLogging, TSybaseDumpTranSqlNode, TSybaseUpdateIndexStatisticsSqlNode, TTableElement, TTableHint, TTablePartitionItem, TTableProperties, TTableReference, TTableSample, TTableSamplePart, TTaskOption, TTDUnpivot, TTeradataGiveSqlNode, TTeradataLockClause, TTeradataLockSqlNode, TTeradataStmtStubSqlNode, TTeradataUsingSqlNode, TTeradataWithClause, TTeradataWithClauseItem, TTimeSeries, TTimeTravel, TTimingPoint, TTopClause, TTriggerAction, TTriggerEventClause, TTriggerEventItem, TTriggeringClause, TTriggerReferencingClause, TTriggerReferencingItem, TTrimArgument, TTruncateTableSqlNode, TTypeAttribute, TTypeName, TUnloadSqlNode, TUnnestClause, TUnpackOption, TUnpivotInClause, TUnpivotInClauseItem, TUnsetSqlNode, TUpdateFor, TUpdateSqlNode, TUpsertSqlNode, TUseKeyIndex, TVacuumSqlNode, TValueClause, TValueRowItem, TViewAliasClause, TViewAliasItem, TWhenClauseItem, TWhereClause, 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, Iterator<TSourceToken>
```
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

Field Summary

Fields
Modifier and Type	Field and Description
`EDbVendor`	`dbvendor` SQL dialect of this statement.
`static boolean`	`doubleLinkedTokenListToString`
`static int`	`nodeActionAppend`
`static int`	`nodeActionInsert`
`static int`	`nodeActionRemove`
`static int`	`nodeActionUnknown`
`static int`	`nodeActionUpdate`
`static int`	`nodeActionUpdateText`
`static int`	`nodeChangeEndToken`
`static int`	`nodeChangeStartToken`

Constructor Summary

Constructors
Constructor and Description

TParseTreeNode()

Constructors
Constructor and Description
`TParseTreeNode()`

Method Summary

All Methods Static 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 .
`void`	`addToTokenChain(TSourceToken anchorToken, boolean beforeAnchorToken)`
`void`	`appendNewNode(TParseTreeNode newNode, boolean needCommaBefore)`
`void`	`calculateTokenCount()`
`protected void`	`doAppendNewNode(TParseTreeNode newNode, TParseTreeNode anchorNode, boolean needCommaBefore)`
`void`	`doParse(TCustomSqlStatement psql, ESqlClause plocation)` Analyze the sub-nodes inside this node.
`void`	`fastSetString(String sqlSegment)`
`TParseTreeNode`	`getAnchorNode()`
`long`	`getColumnNo()` Column position of the first token of this node
`String`	`getCommentAfterNode()`
`String`	`getCommentBeforeNode()` return null if no comment is found before this node.
`String`	`getCompactString()` representation of this node by removing all spaces, return and comments
`int`	`getDummyTag()` A temporary value can be used for any purposes
`TSourceToken`	`getEndToken()` The last token of the node
`Class<?>`	`getEvaluateDatatype()` Support String, Integer, Double and Boolean type
`Object`	`getEvalValue()`
`TGSqlParser`	`getGsqlparser()` The parser that generate this node.
`long`	`getLineNo()` Line number of the first token of this node
`ESqlClause`	`getLocation()` SQL clause that include this objectName such as select list, from clause, set clause
`String`	`getMd5()` md5 hash code of the string representation of this node.
`ENodeStatus`	`getNodeStatus()`
`int`	`getNodeType()` A unique value to distinguish this node from others
`TParseTreeNode`	`getParentObjectName()`
`String`	`getPlainText()`
`TSourceToken`	`getStartToken()` The first token in this parse tree node
`int`	`getTokenCount()`
`boolean`	`hasNext()`
`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)`
`void`	`insertAfterAToken(TSourceToken anchorToken)`
`void`	`insertNewNodeBeforeMe(TParseTreeNode newNode, boolean needCommaBefore)`
`boolean`	`isChanged()` Detect wether this node is modified by checking all tokens included in this node.
`boolean`	`isTokensInChain()`
`TSourceToken`	`next()`
`void`	`refreshAllNodesTokenCount()`
`void`	`remove()`
`protected int`	`removeAllMyTokensFromTokenList(TSourceToken additionalToken)` Deprecated. since v1.8.8.0, use scriptWriter technology to modify the node
`void`	`removeTokens()`
`static void`	`removeTokensBetweenNodes(TParseTreeNode startNode, TParseTreeNode endNode)`
`static void`	`removeTokensBetweenToken(TSourceToken startToken, TSourceToken endToken)` both begin and end token will be removed from the chain
`void`	`replaceWithNewNode(TParseTreeNode newNode)`
`void`	`resetIterator()`
`void`	`setAnchorNode(TParseTreeNode anchorNode)`
`void`	`setChanged()`
`void`	`setDummyTag(int dummyTag)`
`void`	`setEndToken(ArrayList endNode)`
`void`	`setEndToken(TFromTableList endNode)`
`void`	`setEndToken(TParseTreeNode endNode)`
`void`	`setEndToken(TSourceToken newEndToken)`
`void`	`setEndToken(TSourceTokenList endTokenList)`
`void`	`setEndTokenDirectly(TSourceToken newEndToken)`
`void`	`setEvaluateDatatype(Class<?> evaluateDatatype)`
`void`	`setEvalValue(Object evalValue)`
`void`	`setGsqlparser(TGSqlParser gsqlparser)`
`void`	`setIncludingComment(boolean includingComment)`
`void`	`setLocation(ESqlClause location)`
`void`	`setNewSubNode(TParseTreeNode oldSubNode, TParseTreeNode newSubNode, TParseTreeNode anchorNode)`
`void`	`setNodeStatus(ENodeStatus nodeStatus)`
`void`	`setNodeType(int nodeType)` Set the node type for this node.
`void`	`setParent(TParseTreeNode parent)`
`void`	`setPlainText(String plainText)`
`void`	`setStartToken(ArrayList startNode)`
`void`	`setStartToken(TParseTreeNode startNode)`
`void`	`setStartToken(TSourceToken newStartToken)`
`void`	`setStartToken(TSourceTokenList startTokenList)`
`void`	`setStartTokenDirectly(TSourceToken newStartToken)`
`void`	`setString(String sqlSegment)` Set the text of the node and update the corresponding source tokens synchronously.
`void`	`setString2(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
`static boolean`	`subNodeInNode(TParseTreeNode subNode, TParseTreeNode wholeNode)`
`String`	`toScript()` Return the 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()` The returned text is formed by concatenating the source tokens contained in this node one by one.
`String`	`toString2()` String representation of this parse tree node.

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

Methods inherited from interface Iterator
forEachRemaining

Field Detail
- doubleLinkedTokenListToString
```
public static boolean doubleLinkedTokenListToString
```
- nodeActionUnknown
```
public static final int nodeActionUnknown
```
  See Also:
  
  Constant Field Values
- nodeActionRemove
```
public static final int nodeActionRemove
```
  See Also:
  
  Constant Field Values
- nodeActionInsert
```
public static final int nodeActionInsert
```
  See Also:
  
  Constant Field Values
- nodeActionUpdate
```
public static final int nodeActionUpdate
```
  See Also:
  
  Constant Field Values
- nodeActionUpdateText
```
public static final int nodeActionUpdateText
```
  See Also:
  
  Constant Field Values
- nodeActionAppend
```
public static final int nodeActionAppend
```
  See Also:
  
  Constant Field Values
- nodeChangeStartToken
```
public static final int nodeChangeStartToken
```
  See Also:
  
  Constant Field Values
- nodeChangeEndToken
```
public static final int nodeChangeEndToken
```
  See Also:
  
  Constant Field Values
- dbvendor
```
public EDbVendor dbvendor
```
  SQL dialect of this statement.

Constructor Detail
- TParseTreeNode
```
public TParseTreeNode()
```

Method Detail

setEvaluateDatatype

public void setEvaluateDatatype(Class<?> evaluateDatatype)

getEvaluateDatatype
```
public Class<?> getEvaluateDatatype()
```
Support String, Integer, Double and Boolean type

Returns:

setEvalValue

public void setEvalValue(Object evalValue)

getEvalValue
```
public Object getEvalValue()
```

setPlainText

public void setPlainText(String plainText)

getPlainText
```
public String getPlainText()
```

setLocation

public void setLocation(ESqlClause location)

getLocation
```
public ESqlClause getLocation()
```
SQL clause that include this objectName such as select list, from clause, set clause

Returns:

SQL clause that include this objectName

getCompactString
```
public String getCompactString()
```
representation of this node by removing all spaces, return and comments

Returns:

string representation of this node by removing all spaces, return and comments

getMd5
```
public String getMd5()
```
md5 hash code of the string representation of this node. If the string of this node is empty, return the md5 value of the class name of this node. 1. remove all spaces, return, comments inside the node
2. turn number constant in where clause into ? character.
3. turn string constant in where clause into ?? character.
4. turn all string of the token into uppercase if it's not a delimited identifier.

Returns:

md5 hash code of the string representation of this node

getParentObjectName

public TParseTreeNode getParentObjectName()

setParent

public void setParent(TParseTreeNode parent)

insertAfterAToken

public void insertAfterAToken(TSourceToken anchorToken)

insertNewNodeBeforeMe

public void insertNewNodeBeforeMe(TParseTreeNode newNode,
                                  boolean needCommaBefore)

appendNewNode

public void appendNewNode(TParseTreeNode newNode,
                          boolean needCommaBefore)

replaceWithNewNode

public void replaceWithNewNode(TParseTreeNode newNode)

resetIterator
```
public void resetIterator()
```

hasNext
```
public boolean hasNext()
```
Specified by:

hasNext in interface Iterator<TSourceToken>

next
```
public TSourceToken next()
```
Specified by:

next in interface Iterator<TSourceToken>

remove
```
public void remove()
```
Specified by:

remove in interface Iterator<TSourceToken>

setNodeStatus

public void setNodeStatus(ENodeStatus nodeStatus)

getNodeStatus
```
public ENodeStatus getNodeStatus()
```

addToTokenChain

public void addToTokenChain(TSourceToken anchorToken,
                            boolean beforeAnchorToken)

getTokenCount
```
public int getTokenCount()
```

refreshAllNodesTokenCount

public void refreshAllNodesTokenCount()

calculateTokenCount
```
public void calculateTokenCount()
```

removeTokensBetweenToken

public static void removeTokensBetweenToken(TSourceToken startToken,
                                            TSourceToken endToken)

both begin and end token will be removed from the chain

Parameters:: startToken -; endToken -

removeTokensBetweenNodes

public static void removeTokensBetweenNodes(TParseTreeNode startNode,
                                            TParseTreeNode endNode)

removeTokens
```
public void removeTokens()
```

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 newStartToken)

setStartToken

public void setStartToken(TSourceTokenList startTokenList)

setStartToken

public void setStartToken(TParseTreeNode startNode)

setStartTokenDirectly

public void setStartTokenDirectly(TSourceToken newStartToken)

setEndTokenDirectly

public void setEndTokenDirectly(TSourceToken newEndToken)

setEndToken

public void setEndToken(TSourceToken newEndToken)

setEndToken

public void setEndToken(TSourceTokenList endTokenList)

setEndToken

public void setEndToken(TFromTableList endNode)

setEndToken

public void setEndToken(TParseTreeNode endNode)

setString2
```
public void setString2(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.

setString
```
public void setString(String sqlSegment)
```
Set the text of the node and update the corresponding source tokens synchronously. This way, when the toString() method of the node itself or its parent node is called, it will return the modified text.

Parameters:

sqlSegment -

fastSetString

public void fastSetString(String sqlSegment)

getCommentBeforeNode
```
public String getCommentBeforeNode()
```
return null if no comment is found before this node.

Returns:

the comment before this node

getCommentAfterNode
```
public String getCommentAfterNode()
```

toString2
```
public String toString2()
```
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, then use toScript() to get string representation of this node.

Returns:

string representation of this parse tree node

toString
```
public String toString()
```
The returned text is formed by concatenating the source tokens contained in this node one by one.

Overrides:

toString in class Object

Returns:

isTokensInChain
```
public boolean isTokensInChain()
```

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

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()
```
Return the 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

setChanged
```
public void setChanged()
```

isChanged
```
public boolean isChanged()
```
Detect wether this node is modified by checking all tokens included in this node.

Returns:

true if this node is modified.

doAppendNewNode

protected void doAppendNewNode(TParseTreeNode newNode,
                               TParseTreeNode anchorNode,
                               boolean needCommaBefore)

setAnchorNode

public void setAnchorNode(TParseTreeNode anchorNode)

getAnchorNode
```
public TParseTreeNode getAnchorNode()
```

setNewSubNode

public void setNewSubNode(TParseTreeNode oldSubNode,
                          TParseTreeNode newSubNode,
                          TParseTreeNode anchorNode)

subNodeInNode

public static boolean subNodeInNode(TParseTreeNode subNode,
                                    TParseTreeNode wholeNode)

Class TParseTreeNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface Iterator

Field Detail

doubleLinkedTokenListToString

nodeActionUnknown

nodeActionRemove

nodeActionInsert

nodeActionUpdate

nodeActionUpdateText

nodeActionAppend

nodeChangeStartToken

nodeChangeEndToken

dbvendor

Constructor Detail

TParseTreeNode

Method Detail

setEvaluateDatatype

getEvaluateDatatype

setEvalValue

getEvalValue

setPlainText

getPlainText

setLocation

getLocation

getCompactString

getMd5

getParentObjectName

setParent

insertAfterAToken

insertNewNodeBeforeMe

appendNewNode

replaceWithNewNode

resetIterator

hasNext

next

remove

setNodeStatus

getNodeStatus

addToTokenChain

getTokenCount

refreshAllNodesTokenCount

calculateTokenCount

removeTokensBetweenToken

removeTokensBetweenNodes

removeTokens

getGsqlparser

setIncludingComment

setGsqlparser

setDummyTag

getDummyTag

getStartToken

getEndToken

getColumnNo

getLineNo

setNodeType

getNodeType

init

init

init

init

init

init

doParse

setStartToken

setEndToken

setStartToken

setStartToken

setStartToken

setStartTokenDirectly

setEndTokenDirectly

setEndToken

setEndToken

setEndToken

setEndToken

setString2

setString