Package gudusoft.gsqlparser.nodes

Class TObjectName

Object

gudusoft.gsqlparser.nodes.TParseTreeNode

gudusoft.gsqlparser.nodes.TObjectName

All Implemented Interfaces:

Visitable, Cloneable, Iterator<TSourceToken>

public class TObjectName
extends TParseTreeNode
implements Cloneable

The qualified or unqualified name that identifies a database object. The qualified name may includes those parts: server,database,schema,object,part and dblink. This class represents database object in different database vendors such as Oracle, SQL Server in a uniform way.

The general syntax of database object in Oracle: [schema.]object[.part][@dblink]

The general syntax of database object in SQL Server: [server.][database.][schema.]object

The meaning of getObjectToken() and getPartToken() depends on the getDbObjectType(). If this database object is a schema object such as table, index, then the objectToken represents this database object and partToken is null.

If this TObjectName represents a column, the partToken represents the column name, the objectToken is table/view name of this column if this column is qualified like table.column, otherwise, the objectToken is null.

schemaToken, databaseToken, serverToken is the qualified part of a database object name. If this objectName represents a database name in the create database statement like this CREATE DATABASE menagerie, then, the objectToken is menagerie and databaseToken is null.

See Also:

• EDbObjectType

Field Summary

Fields

Modifier and Type	Field	Description
int	searchLevel	Internal use only
static final int	ttobjAttribute	Deprecated. replaced by EDbObjectType.
static final int	ttobjColumn	Deprecated. replaced by EDbObjectType.
static final int	ttobjColumnAlias	Deprecated. replaced by EDbObjectType.
static final int	ttobjColumnMethod	Deprecated. replaced by EDbObjectType.method.
static final int	ttobjConstraintName	Deprecated. replaced by EDbObjectType.constraint.
static final int	ttobjDatatype	Deprecated. replaced by EDbObjectType.
static final int	ttobjFunctionName	Deprecated. replaced by EDbObjectType.
static final int	ttobjNotAObject	Deprecated. replaced by EDbObjectType.
static final int	ttobjParameter	Deprecated. replaced by EDbObjectType.
static final int	ttobjPositionalParameters	Deprecated. replaced by EDbObjectType.
static final int	ttobjSchemaName	Deprecated. replaced by EDbObjectType.
static final int	ttobjStringConstant	Deprecated. replaced by EDbObjectType.
static final int	ttobjTable	Deprecated. replaced by EDbObjectType.
static final int	ttobjUnknown	Deprecated. replaced by EDbObjectType.
static final int	ttobjVariable	Deprecated. replaced by EDbObjectType.

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

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

Constructor Summary

Constructors

Constructor	Description
TObjectName()

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
void	appendObjectName(TObjectName objectName)
void	attributesToPropertyToken(TObjectNameList attributes)	used in Oracle and teradata SQL syntax
TObjectName	clone()
void	columnToProperty()
String	coordinate()	The X and Y position of this objectName in the SQL
static TObjectName	createObjectName(EDbVendor dbVendor, EDbObjectType dbObjectType)
static TObjectName	createObjectName(EDbVendor dbVendor, EDbObjectType dbObjectType, TSourceToken token1)
static TObjectName	createObjectName(EDbVendor dbVendor, EDbObjectType dbObjectType, TSourceToken token1, TSourceToken token2)
static TObjectName	createObjectName(EDbVendor dbVendor, EDbObjectType dbObjectType, TSourceToken token1, TSourceToken token2, TSourceToken token3)
static TObjectName	createObjectName(EDbVendor dbVendor, EDbObjectType dbObjectType, TSourceToken token1, TSourceToken token2, TSourceToken token3, TSourceToken token4)
static TObjectName	createObjectName(EDbVendor dbVendor, EDbObjectType dbObjectType, String str)
String	getAnsiCatalogName()	If a table name is not qualified with a database name, but GSP detect the database for this table in the metadata then, this method will return this detected database name.
String	getAnsiSchemaName()	In this SQL: select * from part1.part2, In Hive, MySQL and Teradata, part1 will be treated as a database name, returned in getDatabaseString(), while getSchemaString() return empty string.
TSourceToken	getAtsign()
ArrayList<TAttributeNode>	getAttributeNodesDerivedFromFromClause()	这个属性只有当 column 为 * 时有效 当 column 为 * 时， 本属性包含该 * 展开后对应的 attributeNode 列表，来源是 FROM CLAUSE中的 tables, 在 resolve star column 时给本属性赋值， TStmtScope.resolve(TObjectName objectName) 当 table 有metadata或DDL给出了明确的字段时，每table个展开的 attributeNode 包含明确的字段名，such as t.c 当 table 没有 metadata 和 DDL 时，每table个只展开的 一个 attributeNode，内容为 t.*
ArrayList<TColumnTableMatch>	getCandidateAttributeNodes()	非 star column 使用该属性存放可能包含该 column 的 attributeNode star column 使用 getAttributeNodesDerivedFromFromClause()
Map<TTable,Integer>	getCandidateTableDdlStatus()	Get DDL verification status for all candidate tables.
TTableList	getCandidateTables()
List<TTable>	getCandidateTables2()	Get all candidate tables (for ambiguous columns)
TObjectNameList	getColumnAttributes()	The data type of this column is structured UDT, this method returns the column's attributes.
String	getColumnNameOnly()	Returns only the column name if it's prefixed with a table name
long	getColumnNo()	The column position of this objectName in the SQL
TResultColumnList	getColumnsLinkedToStar()	if this is a star column(column name is *), and the value of this star column is derived from a subquery, then, this field points to the select list in the subquery
ArrayList<String>	getColumnsLinkedToStarColumn()
ColumnSource	getColumnSource()	Convenience method: get column source (most common access pattern)
TSourceToken	getColumnToken()	It's the same as getPartToken() if getDbObjectType() is EDbObjectType.column
TSourceToken	getCommentString()
String	getDatabaseString()	String text of the database name
TSourceToken	getDatabaseToken()	The database part of this objectName: [server.][database.][schema.]object
TObjectName	getDblink()	The database link part remoreserver in this objectName: scott.emp@remoreserver
EDbObjectType	getDbObjectType()	The database object type of this objectName such as table, view, column for example.
int	getDdlVerificationStatus(TTable table)	Check DDL verification status for a candidate table.
TExceptReplaceClause	getExceptReplaceClause()
TSourceToken	getExclamationmark()
String	getImplictDatabaseString()
String	getImplictSchemaString()	This is the schema fetched from the SQLEnv.
TIndirection	getIndirection()	Array element of this objectName
long	getLineNo()	The line number of this objectName in SQL
TColumnDefinition	getLinkedColumnDef()	The column definition in create/alter table statement that include this column name object.
gudusoft.gsqlparser.compiler.TVariable	getLinkedVariable()
TSourceToken	getMethodToken()
TObjectName	getNamespace()	The Couchbase namespace before keyspace
String	getNormalizedColumnString()	Get normalized column string with caching (Phase 5 optimization).
String	getNormalizedDatabaseString()	Get normalized database string with caching (Phase 5 optimization).
String	getNormalizedSchemaString()	Get normalized schema string with caching (Phase 5 optimization).
String	getNormalizedServerString()	Get normalized server string with caching (Phase 5 optimization).
String	getNormalizedTableString()	Get normalized table string with caching (Phase 5 optimization).
int	getNumberOfPart()	List the number of parts made up this objectName
String	getObjectString()	String text of the object name
TSourceToken	getObjectToken()	The object part of this objectName such as table name, view name.
int	getObjectType()	Deprecated. use getDbObjectType() instead.
TCustomSqlStatement	getOwnStmt()
String	getPackageString()	String text of the package name.
TSourceToken	getPackageToken()	Oracle package name
TObjectName	getParentObjectName()
String	getPartString()	String text of the part name
TSourceToken	getPartToken()	The column name of this objectName if getDbObjectType() is EDbObjectType.column.
TPathSqlNode	getPath()	stage path
TSourceToken	getPropertyToken()
EQuoteType	getQuoteType()	Tell whether this is a quoted objectName.
TObjectNameList	getReferencedObjects()
ResolutionResult	getResolution()	Get resolution result from new resolver
int	getResolveStatus()
String	getSchemaString()	String text of schema name in a qualified name of a schema object.
TSourceToken	getSchemaToken()	The schema name of this objectName.
String	getServerString()	String text of the server name
TSourceToken	getServerToken()	The server part of this objectName: [server.][database.][schema.]object
TAttributeNode	getSourceAttributeNode()	Deprecated. Since 3.4.0.5.
TResultColumn	getSourceColumn()	The result column which include this column
TTable	getSourceTable()	Get the immediate source table where this column is visible in the current scope.
ArrayList<TTable>	getSourceTableList()	source table list for star column, select * from emp,dept * column will be list to both emp and dept table.
ETableKind	getTableKind()
String	getTableString()	String text of the table name
TSourceToken	getTableToken()	The table name of this objectName, it's the same value as getObjectToken() if getDbObjectType() is EDbObjectType.table
int	getValidate_column_status()
void	init(EDbObjectType dbObjectType, Object arg1, Object arg2, Object arg3)
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)
boolean	isAmbiguous()	Check if this column reference is ambiguous
boolean	isAttributeNameInObjectName(TSourceToken leftparen, TSourceToken rightparen)
boolean	isCandidatesFromUnion()	Returns true if candidate tables came from UNION/CTE branch propagation, false if they came from ambiguity (e.g., unqualified column in multi-table query).
boolean	isContinueToSearch()
boolean	isImplicitDatabase()
boolean	isImplicitSchema()
boolean	isOrphanColumn()
boolean	isQualified()	Check whether a column is prefixed by a table like this: table.column
boolean	isReservedKeyword()
boolean	isResolved()	Check if this column reference has been resolved (by new resolver)
boolean	isSubscripts()	PostgreSQL column with array types
boolean	isTableDetermined()	Sometime, a non-qualified column can't be linked to a table without additional metadata from database.
boolean	isValidColumnName(EDbVendor pDBVendor)	Check whether a column name is syntax valid in a specific database vendor.
void	mergeObjectName(TObjectName objectName)	Used internally in hive .y file to merge two objectNames
void	mergeObjectName(TObjectName objectName, TObjectName objectName2)
boolean	resolveWithThisTable(TTable pTable)	This column must be in this syntax: table.column, otherwise, this method always return false.
protected TSQLSchema	searchImplicitSchema()
void	setAtsign(TSourceToken atsign)
void	setColumnAttributes(TObjectNameList columnAttributes)
void	setColumnsLinkedToStar(TResultColumnList columnsLinkedToStar)
void	setCommentString(TSourceToken commentString)
void	setDatabaseToken(TSourceToken databaseToken)
void	setDatabaseToken(TSourceToken databaseToken, boolean implicit)
void	setDblink(TObjectName dblink)
void	setDblink(TObjectName dblink, boolean linkToDB)
void	setDbObjectType(EDbObjectType dbObjectType)	Set object type of this objectName
void	setDbObjectType(EDbVendor dbVendor, EDbObjectType dbObjectType)
void	setDbObjectTypeDirectly(EDbObjectType dbObjectType)
void	setExceptReplaceClause(TExceptReplaceClause exceptReplaceClause)
void	setExclamationmark(TSourceToken exclamationmark)
void	setImplictDatabaseName(String implictDatabaseName)
void	setImplictSchemaName(String implictSchemaName)
void	setIndirection(TIndirection indirection)
void	setLinkedColumnDef(TColumnDefinition linkedColumnDef)
void	setLinkedVariable(gudusoft.gsqlparser.compiler.TVariable linkedVariable)
void	setMethodToken(TSourceToken methodToken)
void	setNamespace(TObjectName namespace)
void	setObjectToken(TSourceToken objectToken)
void	setObjectType(int objectType)	Deprecated. use setDbObjectType(gudusoft.gsqlparser.EDbVendor, gudusoft.gsqlparser.EDbObjectType) instead
void	setOrphanColumn(boolean orphanColumn)
void	setOwnStmt(TCustomSqlStatement ownStmt)
void	setPackageToken(TSourceToken packageToken)
void	setParentObjectName(TObjectName parentObjectName)
void	setPartToken(TSourceToken partToken)
void	setPath(TPathSqlNode path)
void	setPropertyToken(TSourceToken propertyToken)
void	setQuoteType(EQuoteType quoteType)
void	setResolution(ResolutionResult resolution)	Set resolution result (called by resolver2.NameResolver)
void	setResolveStatus(int resolveStatus)
void	setSchemaToken(TSourceToken schemaToken)
void	setSchemaToken(TSourceToken schemaToken, boolean implicit)
void	setServerToken(TSourceToken serverToken)
void	setSourceAttributeNode(TAttributeNode sourceAttributeNode)	Deprecated. Since 3.4.0.5.
void	setSourceColumn(TResultColumn sourceColumn)	Set the result column which include this column name.
void	setSourceColumnOnly(TResultColumn sourceColumn)	Set the source column without changing dbObjectType.
void	setSourceTable(TTable sourceTable)	Set the table this column belongs to.
void	setSourceTableBySQLResolver(TCustomSqlStatement sqlStatement, TAttributeNode attributeNode, TTable newSourceTable)
void	setSqlEnv(TSQLEnv sqlEnv)
void	setTableDetermined(boolean tableDetermined)
void	setTableKind(ETableKind tableKind)
void	setValidate_column_status(int validate_column_status)
void	splitNameInQuotedIdentifier()
void	TObjectName()
String	toString()	返回该对象名的字符串表示（中文说明）：

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Details

searchLevel

public int searchLevel

Internal use only

ttobjNotAObject

public static final int ttobjNotAObject

Deprecated.

replaced by EDbObjectType. this is not an object, like sysdate function in oracle database

See Also:

• Constant Field Values

ttobjUnknown

public static final int ttobjUnknown

Deprecated.

replaced by EDbObjectType. object type can't be determined.

See Also:

• Constant Field Values

ttobjColumn

public static final int ttobjColumn

Deprecated.

replaced by EDbObjectType. column in table, objectToken is table if specified, and partToken is column name.

See Also:

• Constant Field Values

ttobjColumnAlias

public static final int ttobjColumnAlias

Deprecated.

replaced by EDbObjectType. column alias in objectToken.

See Also:

• Constant Field Values

ttobjTable

public static final int ttobjTable

Deprecated.

replaced by EDbObjectType. table name in objectToken.

See Also:

• Constant Field Values

ttobjParameter

public static final int ttobjParameter

Deprecated.

replaced by EDbObjectType. parameter name in objectToken.

See Also:

• Constant Field Values

ttobjVariable

public static final int ttobjVariable

Deprecated.

replaced by EDbObjectType. variable name in objectToken.

See Also:

• Constant Field Values

ttobjColumnMethod

public static final int ttobjColumnMethod

Deprecated.

replaced by EDbObjectType.method. column method like SetXY below, column method in methodToken, and colomn name in partToken.

UPDATE Cities

SET Location.SetXY(23.5, 23.5)

See Also:

• Constant Field Values

ttobjFunctionName

public static final int ttobjFunctionName

Deprecated.

replaced by EDbObjectType. function name in objectToken

See Also:

• Constant Field Values

ttobjConstraintName

public static final int ttobjConstraintName

Deprecated.

replaced by EDbObjectType.constraint. constraint name in objectToken

See Also:

• Constant Field Values

ttobjStringConstant

public static final int ttobjStringConstant

Deprecated.

replaced by EDbObjectType. string constant in objectToken

See Also:

• Constant Field Values

ttobjAttribute

public static final int ttobjAttribute

Deprecated.

replaced by EDbObjectType. attribute name is in partToken

See Also:

• Constant Field Values

ttobjDatatype

public static final int ttobjDatatype

Deprecated.

replaced by EDbObjectType. datatype was not represented by a TObjectName object, this constant was used in source tokens that consist of TTypeName.

See Also:

• Constant Field Values

ttobjSchemaName

public static final int ttobjSchemaName

Deprecated.

replaced by EDbObjectType. schema name in schemaToken

See Also:

• Constant Field Values

ttobjPositionalParameters

public static final int ttobjPositionalParameters

Deprecated.

replaced by EDbObjectType. postgresql Positional Parameters, $1, $1[1], $1[1,10] parameter name is in partToken of $1, and parameter name is in objectToken of $1.columnName, and column name is in partToken

See Also:

• Constant Field Values

Constructor Details

TObjectName

public TObjectName()

Method Details

setOwnStmt

public void setOwnStmt(TCustomSqlStatement ownStmt)

getOwnStmt

public TCustomSqlStatement getOwnStmt()

getExceptReplaceClause

public TExceptReplaceClause getExceptReplaceClause()

setExceptReplaceClause

public void setExceptReplaceClause(TExceptReplaceClause exceptReplaceClause)

setTableKind

public void setTableKind(ETableKind tableKind)

getTableKind

public ETableKind getTableKind()

setLinkedVariable

public void setLinkedVariable(gudusoft.gsqlparser.compiler.TVariable linkedVariable)

getLinkedVariable

public gudusoft.gsqlparser.compiler.TVariable getLinkedVariable()

setSourceAttributeNode

@Deprecated
public void setSourceAttributeNode(TAttributeNode sourceAttributeNode)

Deprecated.

Since 3.4.0.5. Use TSQLResolver2 with setResolution(gudusoft.gsqlparser.resolver2.model.ResolutionResult) instead.

Sets the source attribute node for this object name.

This method is used only by the legacy TSQLResolver (RESOLVER). It is not used when using TSQLResolver2 (RESOLVER2) for name resolution. For RESOLVER2, use setResolution(gudusoft.gsqlparser.resolver2.model.ResolutionResult) instead.

Parameters:

sourceAttributeNode - the attribute node representing the resolved source

getSourceAttributeNode

@Deprecated
public TAttributeNode getSourceAttributeNode()

Deprecated.

Since 3.4.0.5. Use TSQLResolver2 with getResolution() instead.

Returns the source attribute node for this object name.

This method is used only by the legacy TSQLResolver (RESOLVER). It is not used when using TSQLResolver2 (RESOLVER2) for name resolution. For RESOLVER2, use getResolution() instead.

Returns:

the attribute node representing the resolved source, or null if not resolved

setResolution

public void setResolution(ResolutionResult resolution)

Set resolution result (called by resolver2.NameResolver)

getResolution

public ResolutionResult getResolution()

Get resolution result from new resolver

getColumnSource

public ColumnSource getColumnSource()

Convenience method: get column source (most common access pattern)

isAmbiguous

public boolean isAmbiguous()

Check if this column reference is ambiguous

isResolved

public boolean isResolved()

Check if this column reference has been resolved (by new resolver)

getCandidateTables2

public List<TTable> getCandidateTables2()

Get all candidate tables (for ambiguous columns)

clone

public TObjectName clone()

Overrides:

clone in class Object

setParentObjectName

public void setParentObjectName(TObjectName parentObjectName)

getParentObjectName

public TObjectName getParentObjectName()

Overrides:

getParentObjectName in class TParseTreeNode

setPath

public void setPath(TPathSqlNode path)

getPath

public TPathSqlNode getPath()

stage path

Returns:

getSourceTableList

public ArrayList<TTable> getSourceTableList()

source table list for star column,
select * from emp,dept
* column will be list to both emp and dept table.

Returns:

isImplicitSchema

public boolean isImplicitSchema()

isImplicitDatabase

public boolean isImplicitDatabase()

getAttributeNodesDerivedFromFromClause

public ArrayList<TAttributeNode> getAttributeNodesDerivedFromFromClause()

这个属性只有当 column 为 * 时有效 当 column 为 * 时， 本属性包含该 * 展开后对应的 attributeNode 列表，来源是 FROM CLAUSE中的 tables, 在 resolve star column 时给本属性赋值， TStmtScope.resolve(TObjectName objectName) 当 table 有metadata或DDL给出了明确的字段时，每table个展开的 attributeNode 包含明确的字段名，such as t.c 当 table 没有 metadata 和 DDL 时，每table个只展开的 一个 attributeNode，内容为 t.*

Returns:

getCandidateAttributeNodes

public ArrayList<TColumnTableMatch> getCandidateAttributeNodes()

非 star column 使用该属性存放可能包含该 column 的 attributeNode star column 使用 getAttributeNodesDerivedFromFromClause()

Returns:

getCandidateTables

public TTableList getCandidateTables()

isCandidatesFromUnion

public boolean isCandidatesFromUnion()

Returns true if candidate tables came from UNION/CTE branch propagation, false if they came from ambiguity (e.g., unqualified column in multi-table query). When true, the formatter should output all candidates instead of marking as "missed".

getDdlVerificationStatus

public int getDdlVerificationStatus(TTable table)

Check DDL verification status for a candidate table.

Returns a tri-state result:

• 1 = Column exists in table's DDL
• 0 = Column NOT found in table's DDL (DDL available but column missing)
• -1 = Cannot verify (no DDL available for this table)

Parameters:

table - The candidate table to check

Returns:

DDL verification status: 1 (exists), 0 (not found), -1 (no DDL)

getCandidateTableDdlStatus

public Map<TTable,Integer> getCandidateTableDdlStatus()

Get DDL verification status for all candidate tables.

Returns a map from each candidate table to its DDL verification status:

• 1 = Column exists in table's DDL
• 0 = Column NOT found in table's DDL
• -1 = Cannot verify (no DDL available)

Returns:

Map of candidate tables to their DDL verification status, or empty map if no candidates

setOrphanColumn

public void setOrphanColumn(boolean orphanColumn)

isOrphanColumn

public boolean isOrphanColumn()

isReservedKeyword

public boolean isReservedKeyword()

setLinkedColumnDef

public void setLinkedColumnDef(TColumnDefinition linkedColumnDef)

getLinkedColumnDef

public TColumnDefinition getLinkedColumnDef()

The column definition in create/alter table statement that include this column name object.

     CREATE TABLE table_name (
       column1 datatype,
       column2 datatype
    );
 

In above SQL, column1 datatype is the column definition while column1 is this object name.

Returns:

column definition in create/alter table statement

setNamespace

public void setNamespace(TObjectName namespace)

getNamespace

public TObjectName getNamespace()

The Couchbase namespace before keyspace

Returns:

the namespace

toString

public String toString()

返回该对象名的字符串表示（中文说明）：

1) 优先调用父类 Object.toString() 获取已构造好的整体标识文本； 若父类返回非空，则： - 对于 Snowflake，当文本以 IDENTIFIER(...) 形式出现时，仅提取并返回其中的 字面量部分（去除引号），以符合 Snowflake 标识符解析规则； - 其他情况直接返回父类结果。

2) 若父类返回为空（尚未生成整体文本），则回退到更细粒度的 token： - 若存在 part 级 token，返回其字符串； - 否则若存在 object 级 token，返回其字符串； - 若仍不存在，返回 null。

目的：统一并优先复用已构造的字符串表示，同时兼容特定数据库（如 Snowflake）的 标识符语义，从而在不同厂商 SQL 中提供稳定、符合预期的对象名输出。

Overrides:

toString in class TParseTreeNode

Returns:

节点对应的SQL字符串。

setQuoteType

public void setQuoteType(EQuoteType quoteType)

getQuoteType

public EQuoteType getQuoteType()

Tell whether this is a quoted objectName.

Returns:

EQuoteType.squareBracket or EQuoteType.doubleQuote if this objectName is quoted.

isContinueToSearch

public boolean isContinueToSearch()

setSourceColumn

public void setSourceColumn(TResultColumn sourceColumn)

Set the result column which include this column name. Used by parser internally.

Parameters:

sourceColumn - the result column includes this column name

setSourceColumnOnly

public void setSourceColumnOnly(TResultColumn sourceColumn)

Set the source column without changing dbObjectType. Used by resolver2 for legacy API compatibility when the column is already properly typed (e.g., star-inferred columns).

Parameters:

sourceColumn - the result column includes this column name

getSourceColumn

public TResultColumn getSourceColumn()

The result column which include this column

     select salary + 1000 from emp
 

In the above SQL, salary + 1000 is the result column while salary is this column name.

Returns:

the result column includes this column name

resolveWithThisTable

public boolean resolveWithThisTable(TTable pTable)

This column must be in this syntax: table.column, otherwise, this method always return false. Match tableToken with the input pTable, compare the alias of pTable to tableToken at first, If not the same, then compare the table name directly. This method can handle quoted name correctly. This method is used by parser internally.

Parameters:

pTable - table used to match getTableToken() of this column object

Returns:

true if input table is matched with tableToken of this column object

isQualified

public boolean isQualified()

Check whether a column is prefixed by a table like this: table.column

Returns:

true if this column is in syntax like this: table.column

getValidate_column_status

public int getValidate_column_status()

setValidate_column_status

public void setValidate_column_status(int validate_column_status)

isValidColumnName

public boolean isValidColumnName(EDbVendor pDBVendor)

Check whether a column name is syntax valid in a specific database vendor. For example, in Oracle, rowid is not a valid column name.

Parameters:

pDBVendor - in which the database vendor the syntax of this column is checked

Returns:

true if this objectName can be used as a column name in the specified database

getColumnsLinkedToStarColumn

public ArrayList<String> getColumnsLinkedToStarColumn()

setColumnsLinkedToStar

public void setColumnsLinkedToStar(TResultColumnList columnsLinkedToStar)

getColumnsLinkedToStar

public TResultColumnList getColumnsLinkedToStar()

if this is a star column(column name is *), and the value of this star column is derived from a subquery, then, this field points to the select list in the subquery

Returns:

the select list in the subquery

setSourceTable

public void setSourceTable(TTable sourceTable)

Set the table this column belongs to. Used by parser internally.

Parameters:

sourceTable - table contains this column

setSourceTableBySQLResolver

public void setSourceTableBySQLResolver(TCustomSqlStatement sqlStatement,
 TAttributeNode attributeNode,
 TTable newSourceTable)

getSourceTable

public TTable getSourceTable()

Get the immediate source table where this column is visible in the current scope.

This returns the table/subquery/CTE that directly exposes this column in the FROM clause, NOT the final physical table after tracing through subqueries or CTEs.

To get the final physical table (after tracing through all layers), use: getResolution().getColumnSource().getFinalTable()

Example

 SELECT title FROM (SELECT * FROM books) sub

 For the 'title' column in outer SELECT:
 - getSourceTable()           → TTable for subquery 'sub' (tableType=subquery)
 - resolution.getFinalTable() → TTable for 'books' (the physical table)
 

Returns:

The immediate source table, or null if not resolved

See Also:

• sourceTable
• ColumnSource.getFinalTable()

setResolveStatus

public void setResolveStatus(int resolveStatus)

getResolveStatus

public int getResolveStatus()

TObjectName

public void TObjectName()

isSubscripts

public boolean isSubscripts()

PostgreSQL column with array types

     CREATE TABLE sal_emp (
          name            text,
          pay_by_quarter  integer[],
          schedule        text[][]
     );
 

In the above SQL, this method returns true for pay_by_quarter column.

Returns:

true if this objectName is array type

setIndirection

public void setIndirection(TIndirection indirection)

getIndirection

public TIndirection getIndirection()

Array element of this objectName

     select arraycolumn[4] from t;
 

In the above SQL, this method returns [4] of this objectName.

Returns:

array element of this objectName

See Also:

• TIndirection

setPropertyToken

public void setPropertyToken(TSourceToken propertyToken)

getAtsign

public TSourceToken getAtsign()

getMethodToken

public TSourceToken getMethodToken()

getPropertyToken

public TSourceToken getPropertyToken()

getServerToken

public TSourceToken getServerToken()

The server part of this objectName: [server.][database.][schema.]object

Returns:

server part of the objectName

getExclamationmark

public TSourceToken getExclamationmark()

getDblink

public TObjectName getDblink()

The database link part remoreserver in this objectName: scott.emp@remoreserver

Returns:

database link

getDatabaseToken

public TSourceToken getDatabaseToken()

The database part of this objectName: [server.][database.][schema.]object

Returns:

database part of the objectName

setTableDetermined

public void setTableDetermined(boolean tableDetermined)

isTableDetermined

public boolean isTableDetermined()

Sometime, a non-qualified column can't be linked to a table without additional metadata from database.

     select name from emp, dept
 

In the above SQL, the name column can't be determined which table it belongs to. Below is a more complicated SQL that shows the relationship between column and table.

   select
          s2.s2t1a1,
          s3.s3t1a1
   from
       (
         select *
           from subselect2table1 s2t1
       ) s2,
       (
          select *
             from  subselect3table1, subselect3table2
       ) s3
 

column s2t1a1 was linked to subselect2table1, isTableDetermined() returns true for this column.
column s3t1a1 was linked to both subselect3table1 and subselect3table2 due to lack of meta information from database, isTableDetermined() returns false for this column.

Provide database metadata will help GSP links the column to the table correctly.

Returns:

true if this column can be linked to a table without doubt.

See Also:

• TGSqlParser.setMetaDatabase(gudusoft.gsqlparser.IMetaDatabase)

attributesToPropertyToken

public void attributesToPropertyToken(TObjectNameList attributes)

used in Oracle and teradata SQL syntax

teradata:

column.attribute()

column.attribute().attribute()

Parameters:

attributes -

setColumnAttributes

public void setColumnAttributes(TObjectNameList columnAttributes)

getColumnAttributes

public TObjectNameList getColumnAttributes()

The data type of this column is structured UDT, this method returns the column's attributes. Below is the sample SQL from teradata.

          CREATE TYPE school_record AS (
           school_name VARCHAR(20),
           GPA         FLOAT);

          CREATE TYPE college_record AS (
           school school_record,
           major  VARCHAR(20),
           minor  VARCHAR(20));

          CREATE TABLE student_record (
           student_id  INTEGER,
           Last_name   VARCHAR(20),
           First_name  VARCHAR(20),
           high_school school_record,
           college     college_record);

          SELECT student_id, last_name, first_name,
           high_school.school_name(), high_school.GPA(),
           college.school().school_name(), college.school().GPA(),
           college.major(), college.minor()
          FROM student_record;

          SELECT *.ALL FROM student_record;
          SELECT student_record.*.ALL;
 

Take this column college.school().school_name() for example, the partToken of this objectName should be college, and the value returned by this method should be school().school_name()

PLEASE NOTE THAT CURRENT VERSION CAN'T HANDLE THE ABOVE SQL CORRECTLY.

Returns:

attributes of this structured UDT column

setObjectType

public void setObjectType(int objectType)

Deprecated.

use setDbObjectType(gudusoft.gsqlparser.EDbVendor, gudusoft.gsqlparser.EDbObjectType) instead

Used internally.

Parameters:

objectType - object type of this objectName

setDbObjectType

public void setDbObjectType(EDbVendor dbVendor,
 EDbObjectType dbObjectType)

setDbObjectTypeDirectly

public void setDbObjectTypeDirectly(EDbObjectType dbObjectType)

setDbObjectType

public void setDbObjectType(EDbObjectType dbObjectType)

Set object type of this objectName

Parameters:

dbObjectType - database object type

getDbObjectType

public EDbObjectType getDbObjectType()

The database object type of this objectName such as table, view, column for example. If object type is EDbObjectType.column, getPartToken() represents the column name, for all other object type, the name of this database object is stored in getObjectToken()

Returns:

database object type

getObjectType

public int getObjectType()

Deprecated.

use getDbObjectType() instead.

Returns:

the type of database object or variable this objectName represents for.

setAtsign

public void setAtsign(TSourceToken atsign)

setDblink

public void setDblink(TObjectName dblink)

setDblink

public void setDblink(TObjectName dblink,
 boolean linkToDB)

setServerToken

public void setServerToken(TSourceToken serverToken)

setDatabaseToken

public void setDatabaseToken(TSourceToken databaseToken,
 boolean implicit)

setDatabaseToken

public void setDatabaseToken(TSourceToken databaseToken)

setObjectToken

public void setObjectToken(TSourceToken objectToken)

setPartToken

public void setPartToken(TSourceToken partToken)

setMethodToken

public void setMethodToken(TSourceToken methodToken)

setSchemaToken

public void setSchemaToken(TSourceToken schemaToken,
 boolean implicit)

setSchemaToken

public void setSchemaToken(TSourceToken schemaToken)

setPackageToken

public void setPackageToken(TSourceToken packageToken)

getPackageToken

public TSourceToken getPackageToken()

Oracle package name

Returns:

the source token of Oracle package name.

getObjectToken

public TSourceToken getObjectToken()

The object part of this objectName such as table name, view name.

Returns:

object part of this objectName

getPartToken

public TSourceToken getPartToken()

The column name of this objectName if getDbObjectType() is EDbObjectType.column. getColumnToken() returns the same value.

Returns:

the column name

getSchemaToken

public TSourceToken getSchemaToken()

The schema name of this objectName.

Returns:

schema name

getPackageString

public String getPackageString()

String text of the package name.

Returns:

string of the package name,return null if empty.

getServerString

public String getServerString()

String text of the server name

Returns:

string of the server name,return null if empty.

getDatabaseString

public String getDatabaseString()

String text of the database name

Returns:

string of the database name,return null if empty.

getSchemaString

public String getSchemaString()

String text of schema name in a qualified name of a schema object.

Returns:

string of schema name, return null if empty.

setSqlEnv

public void setSqlEnv(TSQLEnv sqlEnv)

getImplictSchemaString

public String getImplictSchemaString()

This is the schema fetched from the SQLEnv. Not the direct qualified schema name of this object search this table in the current default database and schema. If this is a qualified schema object, then return getSchemaString() This method is only valid when the dbObjectType is a schema object.

Returns:

schema name fetched from the SQLEnv

setImplictDatabaseName

public void setImplictDatabaseName(String implictDatabaseName)

setImplictSchemaName

public void setImplictSchemaName(String implictSchemaName)

getImplictDatabaseString

public String getImplictDatabaseString()

searchImplicitSchema

protected TSQLSchema searchImplicitSchema()

getTableToken

public TSourceToken getTableToken()

The table name of this objectName, it's the same value as getObjectToken() if getDbObjectType() is EDbObjectType.table

Returns:

table name

getTableString

public String getTableString()

String text of the table name

Returns:

string of the table name, return null if empty.

getObjectString

public String getObjectString()

String text of the object name

Returns:

string of the object name, return null if empty.

getPartString

public String getPartString()

String text of the part name

Returns:

string of the part name, return null if empty.

getNormalizedDatabaseString

public String getNormalizedDatabaseString()

Get normalized database string with caching (Phase 5 optimization).

This method caches the normalized database name to avoid repeated normalize() calls. The cache is invalidated automatically when the IdentifierProfile changes (e.g., vendor switch).

Returns:

normalized database name, or empty string if not available

getNormalizedSchemaString

public String getNormalizedSchemaString()

Get normalized schema string with caching (Phase 5 optimization).

This method caches the normalized schema name to avoid repeated normalize() calls. The cache is invalidated automatically when the IdentifierProfile changes.

Returns:

normalized schema name, or empty string if not available

getNormalizedTableString

public String getNormalizedTableString()

Get normalized table string with caching (Phase 5 optimization).

This method caches the normalized table name to avoid repeated normalize() calls. The cache is invalidated automatically when the IdentifierProfile changes.

Returns:

normalized table name, or empty string if not available

getNormalizedColumnString

public String getNormalizedColumnString()

Get normalized column string with caching (Phase 5 optimization).

This method caches the normalized column name (from partToken) to avoid repeated normalize() calls. The cache is invalidated automatically when the IdentifierProfile changes.

Returns:

normalized column name, or empty string if not available

getNormalizedServerString

public String getNormalizedServerString()

Get normalized server string with caching (Phase 5 optimization).

This method caches the normalized server name to avoid repeated normalize() calls. The cache is invalidated automatically when the IdentifierProfile changes.

Returns:

normalized server name, or empty string if not available

setExclamationmark

public void setExclamationmark(TSourceToken exclamationmark)

getAnsiSchemaName

public String getAnsiSchemaName()

In this SQL: select * from part1.part2, In Hive, MySQL and Teradata, part1 will be treated as a database name, returned in getDatabaseString(), while getSchemaString() return empty string. However, TObjectName.getAnsiSchemaName() will return part1, which means it's a schema name. If a table name is not qualified with a schema name, but GSP detect the schema for this table in the metadata then, this method will return this detected schema name.

Returns:

schema name

getAnsiCatalogName

public String getAnsiCatalogName()

If a table name is not qualified with a database name, but GSP detect the database for this table in the metadata then, this method will return this detected database name.

Returns:

getNumberOfPart

public int getNumberOfPart()

List the number of parts made up this objectName

Returns:

the number of parts that made up this objectName

createObjectName

public static TObjectName createObjectName(EDbVendor dbVendor,
 EDbObjectType dbObjectType)

createObjectName

public static TObjectName createObjectName(EDbVendor dbVendor,
 EDbObjectType dbObjectType,
 TSourceToken token1)

createObjectName

public static TObjectName createObjectName(EDbVendor dbVendor,
 EDbObjectType dbObjectType,
 String str)

createObjectName

public static TObjectName createObjectName(EDbVendor dbVendor,
 EDbObjectType dbObjectType,
 TSourceToken token1,
 TSourceToken token2)

createObjectName

public static TObjectName createObjectName(EDbVendor dbVendor,
 EDbObjectType dbObjectType,
 TSourceToken token1,
 TSourceToken token2,
 TSourceToken token3)

createObjectName

public static TObjectName createObjectName(EDbVendor dbVendor,
 EDbObjectType dbObjectType,
 TSourceToken token1,
 TSourceToken token2,
 TSourceToken token3,
 TSourceToken token4)

splitNameInQuotedIdentifier

public void splitNameInQuotedIdentifier()

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(EDbObjectType dbObjectType,
 Object arg1,
 Object arg2,
 Object arg3)

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

init

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

Overrides:

init in class TParseTreeNode

init

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

Overrides:

init in class TParseTreeNode

getColumnNo

public long getColumnNo()

The column position of this objectName in the SQL

Overrides:

getColumnNo in class TParseTreeNode

Returns:

column position

getLineNo

public long getLineNo()

The line number of this objectName in SQL

Overrides:

getLineNo in class TParseTreeNode

Returns:

the line number

getReferencedObjects

public TObjectNameList getReferencedObjects()

getColumnNameOnly

public String getColumnNameOnly()

Returns only the column name if it's prefixed with a table name

Returns:

only the column name if it's prefixed with a table name

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

getColumnToken

public TSourceToken getColumnToken()

It's the same as getPartToken() if getDbObjectType() is EDbObjectType.column

Returns:

source token that represents column, return null if this objectName is not type of column

isAttributeNameInObjectName

public boolean isAttributeNameInObjectName(TSourceToken leftparen,
 TSourceToken rightparen)

mergeObjectName

public void mergeObjectName(TObjectName objectName)

Used internally in hive .y file to merge two objectNames

mergeObjectName

public void mergeObjectName(TObjectName objectName,
 TObjectName objectName2)

columnToProperty

public void columnToProperty()

appendObjectName

public void appendObjectName(TObjectName objectName)

setCommentString

public void setCommentString(TSourceToken commentString)

getCommentString

public TSourceToken getCommentString()

coordinate

public String coordinate()

The X and Y position of this objectName in the SQL

Returns:

coordinate in string text