TObjectName (gudusoft.gsqlparser 2.0.1.0 API)

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

All Implemented Interfaces:

Visitable
```
public class TObjectName
extends TParseTreeNode
```
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 and Description
`int`	`searchLevel` Internal use only
`static int`	`ttobjAliasName` Deprecated. replaced by `EDbObjectType`. alias name in `objectToken`
`static int`	`ttobjAttribute` Deprecated. replaced by `EDbObjectType`. attribute name is in `partToken`
`static int`	`ttobjColumn` Deprecated. replaced by `EDbObjectType`. column in table, objectToken is table if specified, and partToken is column name.
`static int`	`ttobjColumnAlias` Deprecated. replaced by `EDbObjectType`. column alias in objectToken.
`static int`	`ttobjColumnMethod` Deprecated. replaced by `EDbObjectType`. column method like SetXY below, column method in `methodToken`, and colomn name in `partToken`. UPDATE Cities SET Location.SetXY(23.5, 23.5)
`static int`	`ttobjConstraintName` Deprecated. replaced by `EDbObjectType`. constraint name in `objectToken`
`static int`	`ttobjCursorName` Deprecated. replaced by `EDbObjectType`. cursor name in `objectToken`
`static int`	`ttobjDatabaseName` Deprecated. replaced by `EDbObjectType`. Database name in `objectToken`
`static 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.
`static int`	`ttobjFieldName` Deprecated. replaced by `EDbObjectType`. check `TExpression.getFieldName()` for more
`static int`	`ttobjFunctionName` Deprecated. replaced by `EDbObjectType`. function name in `objectToken`
`static int`	`ttobjIndexName` Deprecated. replaced by `EDbObjectType`. index name in `objectToken`
`static int`	`ttobjIndexType` Deprecated. replaced by `EDbObjectType`.
`static int`	`ttobjLabelName` Deprecated. replaced by `EDbObjectType`. label name in `objectToken`
`static int`	`ttObjLibrary`
`static int`	`ttobjMaterializedView` Deprecated. replaced by `EDbObjectType`.
`static int`	`ttobjMaterializedViewName` Deprecated. replaced by `EDbObjectType`. materialized view name in `objectToken`
`static int`	`ttobjMiningModel` Deprecated. replaced by `EDbObjectType`.
`static int`	`ttobjMixed` Deprecated. replaced by `EDbObjectType`. this type is used in TObjectNameList, when objects in TObjectNameList includes more than one type, objtype of that TObjectNameList was set to ttobjMixed.
`static int`	`ttobjNotAObject` Deprecated. replaced by `EDbObjectType`. this is not an object, like sysdate function in oracle database
`static int`	`ttobjOperator` Deprecated. replaced by `EDbObjectType`.
`static int`	`ttObjOracleHint`
`static int`	`ttobjPackage` Deprecated. replaced by `EDbObjectType`. package name in `objectToken`
`static int`	`ttobjParameter` Deprecated. replaced by `EDbObjectType`. parameter name in objectToken.
`static 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`
`static int`	`ttobjProcedureName` Deprecated. replaced by `EDbObjectType`. procedure name in `objectToken`
`static int`	`ttobjPropertyName` Deprecated. replaced by `EDbObjectType`. property name in `propertyToken`
`static int`	`ttobjSchemaName` Deprecated. replaced by `EDbObjectType`. schema name in `schemaToken`
`static int`	`ttobjSequence` Deprecated. replaced by `EDbObjectType`. Sequence name in `objectToken`
`static int`	`ttobjServerName` Deprecated. replaced by `EDbObjectType`. server name in `serverToken`
`static int`	`ttobjStringConstant` Deprecated. replaced by `EDbObjectType`. string constant in `objectToken`
`static int`	`ttobjTable` Deprecated. replaced by `EDbObjectType`. table name in objectToken.
`static int`	`ttObjTableAlias` Deprecated. replaced by `EDbObjectType`. table alias in objectToken
`static int`	`ttobjTableCTE` Deprecated. replaced by `EDbObjectType`. table name in objectToken.
`static int`	`ttobjTablePivot` Deprecated. replaced by `EDbObjectType`.
`static int`	`ttobjTableTemp` Deprecated. replaced by `EDbObjectType`. table name in objectToken.
`static int`	`ttobjTableVar` Deprecated. replaced by `EDbObjectType`. table variable in objectToken.
`static int`	`ttobjTransactionName` Deprecated. replaced by `EDbObjectType`. Transaction name in `objectToken`
`static int`	`ttobjTrigger` Deprecated. replaced by `EDbObjectType`. Trigger name in `objectToken`
`static int`	`ttobjTypeName` Deprecated. replaced by `EDbObjectType`. type name in `objectToken`
`static int`	`ttobjUnknown` Deprecated. replaced by `EDbObjectType`. object type can't be determined.
`static int`	`ttobjVariable` Deprecated. replaced by `EDbObjectType`. variable name in objectToken.
`static int`	`ttobjViewName` Deprecated. replaced by `EDbObjectType`. view name in `objectToken`

Constructor Summary

Constructors
Constructor and Description
`TObjectName()`
`TObjectName(TSourceToken token, EDbObjectType dbObjectType)` Class constructor specifying object name and object type.
`TObjectName(TSourceToken pObjectToken, TSourceToken pPartToken, EDbObjectType dbObjectType)` Class constructor specifying object, part name and object type.

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
`void`	`appendObjectName(TObjectName objectName)`
`void`	`attributesToPropertyToken(TObjectNameList attributes)` used in Oracle and teradata SQL syntax
`String`	`coordinate()` The X and Y position of this objectName in the SQL
`TSourceToken`	`getAtsign()`
`TObjectNameList`	`getAttributes()` 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
`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.
`TSourceToken`	`getExclamationmark()`
`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.
`ESqlClause`	`getLocation()` SQL clause that include this objectName such as select list, from clause, set clause
`TSourceToken`	`getMethodToken()`
`TObjectName`	`getNamespace()` The Couchbase namespace before keyspace
`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.
`String`	`getPackageString()` String text of the package name.
`TSourceToken`	`getPackageToken()` Oracle package name
`String`	`getPartString()` String text of the part name
`TSourceToken`	`getPartToken()` The column name of this objectName if `getDbObjectType()` is `EDbObjectType.column`.
`TSourceToken`	`getPropertyToken()`
`EQuoteType`	`getQuoteType()` Tell whether this is a quoted objectName.
`TObjectNameList`	`getReferencedObjects()`
`String`	`getSchemaString()` String text of schema name
`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
`TSourceToken`	`getSortType()` When this object is column in primary key(column,...), unique key(column,...) in sql server there maybe sort information like column asc, column desc this token represents for ASC, DESC if specified.
`TResultColumn`	`getSourceColumn()` The result column which include this column
`TTable`	`getSourceTable()` The table this columns belongs to.
`String`	`getStringValue()` This method is not used.
`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`
`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`	`isAttributeNameInObjectName(TSourceToken leftparen, TSourceToken rightparen)`
`boolean`	`isPrefixed()` Check whether a column is prefixed by a table like this: `table.column`
`boolean`	`isPrefixedThisTable(TTable pTable)` This column must be in this syntax: table.column, otherwise, this method always return false.
`boolean`	`isReservedKeyword()`
`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)`
`void`	`setAtsign(TSourceToken atsign)`
`void`	`setAttributes(TObjectNameList attributes)`
`void`	`setCommentString(TSourceToken commentString)`
`void`	`setDatabaseToken(TSourceToken databaseToken)`
`void`	`setDblink(TObjectName dblink)`
`void`	`setDbObjectType(EDbObjectType dbObjectType)` Set object type of this objectName
`void`	`setExclamationmark(TSourceToken exclamationmark)`
`void`	`setIndirection(TIndirection indirection)`
`void`	`setLinkedColumnDef(TColumnDefinition linkedColumnDef)`
`void`	`setLocation(ESqlClause location)`
`void`	`setMethodToken(TSourceToken methodToken)`
`void`	`setNamespace(TObjectName namespace)`
`void`	`setObjectToken(TSourceToken objectToken)`
`void`	`setObjectType(int objectType)` Deprecated. use `setDbObjectType(gudusoft.gsqlparser.EDbObjectType)` instead
`void`	`setPackageToken(TSourceToken packageToken)`
`void`	`setPartToken(TSourceToken partToken)`
`void`	`setPropertyToken(TSourceToken propertyToken)`
`void`	`setQuoteType(EQuoteType quoteType)`
`void`	`setSchemaToken(TSourceToken schemaToken)`
`void`	`setServerToken(TSourceToken serverToken)`
`void`	`setSortType(TSourceToken sortType)`
`void`	`setSourceColumn(TResultColumn sourceColumn)` Set the result column which include this column name.
`void`	`setSourceTable(TTable sourceTable)` Set the table this column belongs to.
`void`	`setStringValue(String stringValue)` This method is not used.
`void`	`setTableDetermined(boolean tableDetermined)`
`void`	`TObjectName()`
`String`	`toString()` String representation of this parse tree node.

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
addAllMyTokensToTokenList, appendString, doParse, fastSetString, getDummyTag, getEndToken, getGsqlparser, getNodeType, getStartToken, removeAllMyTokensFromTokenList, setDummyTag, setEndToken, setEndToken, setEndToken, setEndToken, setGsqlparser, setIncludingComment, setNodeType, setStartToken, setStartToken, setStartToken, setStartToken, setString, toScript

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

- Field Detail
  - 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
  - ttObjTableAlias
```
public static final int ttObjTableAlias
```
    Deprecated. replaced by EDbObjectType. table alias in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjTableCTE
```
public static final int ttobjTableCTE
```
    Deprecated. replaced by EDbObjectType. table name in objectToken.
    
    See Also:
    
    Constant Field Values
  - ttobjTableTemp
```
public static final int ttobjTableTemp
```
    Deprecated. replaced by EDbObjectType. table name in objectToken.
    
    See Also:
    
    Constant Field Values
  - ttobjTablePivot
```
public static final int ttobjTablePivot
```
    Deprecated. replaced by EDbObjectType.
    
    See Also:
    
    Constant Field Values
  - ttobjTableVar
```
public static final int ttobjTableVar
```
    Deprecated. replaced by EDbObjectType. table variable 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. 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
  - ttobjProcedureName
```
public static final int ttobjProcedureName
```
    Deprecated. replaced by EDbObjectType. procedure name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjFunctionName
```
public static final int ttobjFunctionName
```
    Deprecated. replaced by EDbObjectType. function name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjLabelName
```
public static final int ttobjLabelName
```
    Deprecated. replaced by EDbObjectType. label name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjIndexName
```
public static final int ttobjIndexName
```
    Deprecated. replaced by EDbObjectType. index name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjMaterializedViewName
```
public static final int ttobjMaterializedViewName
```
    Deprecated. replaced by EDbObjectType. materialized view name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjCursorName
```
public static final int ttobjCursorName
```
    Deprecated. replaced by EDbObjectType. cursor name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjViewName
```
public static final int ttobjViewName
```
    Deprecated. replaced by EDbObjectType. view name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjConstraintName
```
public static final int ttobjConstraintName
```
    Deprecated. replaced by EDbObjectType. constraint name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjPropertyName
```
public static final int ttobjPropertyName
```
    Deprecated. replaced by EDbObjectType. property name in propertyToken
    
    See Also:
    
    Constant Field Values
  - ttobjTransactionName
```
public static final int ttobjTransactionName
```
    Deprecated. replaced by EDbObjectType. Transaction name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjDatabaseName
```
public static final int ttobjDatabaseName
```
    Deprecated. replaced by EDbObjectType. Database 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
  - ttobjTrigger
```
public static final int ttobjTrigger
```
    Deprecated. replaced by EDbObjectType. Trigger name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjAliasName
```
public static final int ttobjAliasName
```
    Deprecated. replaced by EDbObjectType. alias name 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
  - ttobjTypeName
```
public static final int ttobjTypeName
```
    Deprecated. replaced by EDbObjectType. type name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjPackage
```
public static final int ttobjPackage
```
    Deprecated. replaced by EDbObjectType. package name in objectToken
    
    See Also:
    
    Constant Field Values
  - ttobjSequence
```
public static final int ttobjSequence
```
    Deprecated. replaced by EDbObjectType. Sequence name in objectToken
    
    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
  - ttobjServerName
```
public static final int ttobjServerName
```
    Deprecated. replaced by EDbObjectType. server name in serverToken
    
    See Also:
    
    Constant Field Values
  - ttobjOperator
```
public static final int ttobjOperator
```
    Deprecated. replaced by EDbObjectType.
    
    See Also:
    
    Constant Field Values
  - ttobjIndexType
```
public static final int ttobjIndexType
```
    Deprecated. replaced by EDbObjectType.
    
    See Also:
    
    Constant Field Values
  - ttobjMaterializedView
```
public static final int ttobjMaterializedView
```
    Deprecated. replaced by EDbObjectType.
    
    See Also:
    
    Constant Field Values
  - ttobjMiningModel
```
public static final int ttobjMiningModel
```
    Deprecated. replaced by EDbObjectType.
    
    See Also:
    
    Constant Field Values
  - ttobjFieldName
```
public static final int ttobjFieldName
```
    Deprecated. replaced by EDbObjectType. check TExpression.getFieldName() for more
    
    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
  - ttObjOracleHint
```
public static final int ttObjOracleHint
```
    See Also:
    
    Constant Field Values
  - ttObjLibrary
```
public static final int ttObjLibrary
```
    See Also:
    
    Constant Field Values
  - ttobjMixed
```
public static final int ttobjMixed
```
    Deprecated. replaced by EDbObjectType. this type is used in TObjectNameList, when objects in TObjectNameList includes more than one type, objtype of that TObjectNameList was set to ttobjMixed.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TObjectName
```
public TObjectName()
```
  - TObjectName
```
public TObjectName(TSourceToken token,
                   EDbObjectType dbObjectType)
```
    Class constructor specifying object name and object type.
    Use TGSqlParser.parseObjectName(java.lang.String) to create an objectName more than 2 parts.
    
    Parameters:
    
    token - name of this object
    
    dbObjectType - type of this object
  - TObjectName
```
public TObjectName(TSourceToken pObjectToken,
                   TSourceToken pPartToken,
                   EDbObjectType dbObjectType)
```
    Class constructor specifying object, part name and object type. Use this constructor to create a table.column objectName. Use TGSqlParser.parseObjectName(java.lang.String) to create an objectName more than 2 parts.
    
    Parameters:
    
    pObjectToken - name of this object, usually it's the table name
    
    pPartToken - name of the column
    
    dbObjectType - type of this object, usually it's EDbObjectType.column
- Method Detail
  - 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()
```
    Description copied from class: TParseTreeNode
    
    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 TParseTreeNode.toScript() to get string representation of this node.
    
    Overrides:
    
    toString in class TParseTreeNode
    
    Returns:
    
    string representation of this parse tree node
  - 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.
  - setStringValue
```
public void setStringValue(String stringValue)
```
    This method is not used.
    
    Parameters:
    
    stringValue - text value of this objectName
  - getStringValue
```
public String getStringValue()
```
    This method is not used. Use toString() or TParseTreeNode.toScript() instead.
    
    Returns:
    
    string text of this objectName
  - 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
  - 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
  - isPrefixedThisTable
```
public boolean isPrefixedThisTable(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
  - isPrefixed
```
public boolean isPrefixed()
```
    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
  - 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
  - setSourceTable
```
public void setSourceTable(TTable sourceTable)
```
    Set the table this column belongs to. Used by parser internally.
    
    Parameters:
    
    sourceTable - table contains this column
  - getSourceTable
```
public TTable getSourceTable()
```
    The table this columns belongs to. Only valid when this objectName represents a column.
    Please check getTableColumn demo shipped together with this library to find out more information such as column impact and data lineage of the table and column in the SQL script.
    
    Returns:
    
    table this column belongs to
  - 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 -
  - setAttributes
```
public void setAttributes(TObjectNameList attributes)
```
  - getAttributes
```
public TObjectNameList getAttributes()
```
    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.EDbObjectType) instead
    
    Used internally.
    
    Parameters:
    
    objectType - object type of this objectName
  - 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)
```
  - setServerToken
```
public void setServerToken(TSourceToken serverToken)
```
  - 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)
```
  - setPackageToken
```
public void setPackageToken(TSourceToken packageToken)
```
  - getPackageToken
```
public TSourceToken getPackageToken()
```
    Oracle package name
    
    Returns:
    
    the source token of Oracle package name.
  - 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
  - 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
    
    Returns:
    
    string of schema name, return null if empty.
  - 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.
  - setExclamationmark
```
public void setExclamationmark(TSourceToken exclamationmark)
```
  - getNumberOfPart
```
public int getNumberOfPart()
```
    List the number of parts made up this objectName
    
    Returns:
    
    the number of parts that made up this objectName
  - init
```
public void init(Object arg1)
```
    Description copied from class: TParseTreeNode
    
    Initialize a query tree node. Used internally
    
    Overrides:
    
    init in class TParseTreeNode
    
    Parameters:
    
    arg1 - first argument
  - init
```
public void init(Object arg1,
                 Object arg2)
```
    Overrides:
    
    init in class TParseTreeNode
  - init
```
public void init(Object arg1,
                 Object arg2,
                 Object arg3)
```
    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
  - setSortType
```
public void setSortType(TSourceToken sortType)
```
  - getSortType
```
public TSourceToken getSortType()
```
    When this object is column in primary key(column,...), unique key(column,...) in sql server there maybe sort information like column asc, column desc this token represents for ASC, DESC if specified.
    
    Returns:
    
    ASC, DESC or null
  - 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)
```
  - 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

Class TObjectName

Field Summary

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Methods inherited from class java.lang.Object

Field Detail

searchLevel

ttobjNotAObject

ttobjUnknown

ttobjColumn

ttobjColumnAlias

ttobjTable

ttObjTableAlias

ttobjTableCTE

ttobjTableTemp

ttobjTablePivot

ttobjTableVar

ttobjParameter

ttobjVariable

ttobjColumnMethod

ttobjProcedureName

ttobjFunctionName

ttobjLabelName

ttobjIndexName

ttobjMaterializedViewName

ttobjCursorName

ttobjViewName

ttobjConstraintName

ttobjPropertyName

ttobjTransactionName

ttobjDatabaseName

ttobjStringConstant

ttobjTrigger

ttobjAliasName

ttobjAttribute

ttobjTypeName

ttobjPackage

ttobjSequence

ttobjDatatype

ttobjSchemaName

ttobjServerName

ttobjOperator

ttobjIndexType

ttobjMaterializedView

ttobjMiningModel

ttobjFieldName

ttobjPositionalParameters

ttObjOracleHint

ttObjLibrary

ttobjMixed

Constructor Detail

TObjectName

TObjectName

TObjectName

Method Detail

isReservedKeyword

setLinkedColumnDef

getLinkedColumnDef

setNamespace

getNamespace

toString

setQuoteType

getQuoteType

setStringValue

getStringValue

setSourceColumn

getSourceColumn

isPrefixedThisTable

isPrefixed

isValidColumnName

setSourceTable

getSourceTable

TObjectName

isSubscripts

setIndirection

getIndirection

setPropertyToken

getAtsign

getMethodToken