gudusoft.gsqlparser.sqlenv

Class TSQLObject

Object

gudusoft.gsqlparser.sqlenv.TSQLObject

Direct Known Subclasses:

TFunctoinColumn, TSQLCatalog, TSQLColumn, TSQLParameter, TSQLSchema, TSQLSchemaObject

public abstract class TSQLObject
extends Object

base class of all the database object such as catalog, schema, table, column and etc

Field Summary

Fields

Modifier and Type	Field and Description
protected ESQLDataObjectType	dataObjectType
protected String	name
protected String	nameKeepCase
protected TSQLEnv	sqlEnv

Constructor Summary

Constructors

Constructor and Description
TSQLObject(TSQLEnv sqlEnv, String objectName, ESQLDataObjectType dataObjectType) create a new database object and add to the SQL environment.

Method Summary

Modifier and Type	Method and Description
static int	compareTo(EDbVendor dbVendor, ESQLDataObjectType sqlDataObjectType, String pTargetObjectName, String objectName) Deprecated. since version 2.2.3.2(2021-05-10), replaced by @TSQLEnv.compareIdentifier()
static int	compareTo(EDbVendor dbVendor, ESQLDataObjectType sqlDataObjectType, TSQLObject targetDataObject, String objectName)
int	compareTo(String objectName) compare the name of this object to objectname with carefully handle of the case [in]sensitive.
static int	compareTo(TSQLEnv sqlEnv, ESQLDataObjectType sqlDataObjectType, TSQLObject targetDataObject, String objectName) how to compare the name of database object is various from different databases due to the different implementation.
ESQLDataObjectType	getDataObjectType() Type of this database object
String	getName() name of this database object.
String	getNameKeepCase() name of this database object.
String	getQualifiedName() qualified name for database object such as: databaseName.schemaName.tableName
TSQLEnv	getSqlEnv() SQL environment where this database object belonged to.
boolean	isDelimitedIdentifier(String identifier) whether is this a delimited identifier.
static boolean	isDelimitedIdentifier(TSQLEnv sqlEnv, String identifier) check whether a database object name is a delimited identifier or not based on the database.
static String	normalizeIdentifier(EDbVendor dbVendor, ESQLDataObjectType sqlDataObjectType, String identifier)
String	normalizeIdentifier(String identifier) Change the case of the name of database object.
static String	normalizeIdentifier(TSQLEnv sqlEnv, ESQLDataObjectType sqlDataObjectType, String identifier) change the case of the name of the database object name, and remove the delimited char if it's a delimited identifier.
void	setDataObjectType(ESQLDataObjectType dataObjectType)

Methods inherited from class Object

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

Field Detail

name

protected String name

nameKeepCase

protected String nameKeepCase

sqlEnv

protected TSQLEnv sqlEnv

dataObjectType

protected ESQLDataObjectType dataObjectType

Constructor Detail

TSQLObject

public TSQLObject(TSQLEnv sqlEnv,
                  String objectName,
                  ESQLDataObjectType dataObjectType)

create a new database object and add to the SQL environment.

Parameters:

sqlEnv - SQL environment

objectName - object name

Method Detail

getSqlEnv

public TSQLEnv getSqlEnv()

SQL environment where this database object belonged to.

Returns:

SQL environment

getNameKeepCase

public String getNameKeepCase()

name of this database object. With the case unchanged.

Returns:

database object name

getName

public String getName()

name of this database object. case of the name was normalized according to the database vendor's implementation. If the name was picked up from a SQL script, it's case maybe changed and not the same as it appeared in the SQL script.

Returns:

name

setDataObjectType

public void setDataObjectType(ESQLDataObjectType dataObjectType)

getDataObjectType

public ESQLDataObjectType getDataObjectType()

Type of this database object

Returns:

database object type

getQualifiedName

public String getQualifiedName()

qualified name for database object such as: databaseName.schemaName.tableName

Returns:

qualified name

isDelimitedIdentifier

public boolean isDelimitedIdentifier(String identifier)

whether is this a delimited identifier.

Parameters:

identifier - name of a database object

Returns:

true if it's a delimited/quoted identifer.

normalizeIdentifier

public String normalizeIdentifier(String identifier)

Change the case of the name of database object.

Parameters:

identifier - database object name

Returns:

normalized database object name

compareTo

public int compareTo(String objectName)

compare the name of this object to objectname with carefully handle of the case [in]sensitive.

Parameters:

objectName - object name need to be compared

Returns:

a negative integer, zero, or a positive integer as the specified String is greater than, equal to, or less than this object name

isDelimitedIdentifier

public static boolean isDelimitedIdentifier(TSQLEnv sqlEnv,
                                            String identifier)

check whether a database object name is a delimited identifier or not based on the database.

Parameters:

sqlEnv - SQL environment

identifier - database object name

Returns:

true if it's delimited/quoted identifier

normalizeIdentifier

public static String normalizeIdentifier(TSQLEnv sqlEnv,
                                         ESQLDataObjectType sqlDataObjectType,
                                         String identifier)

change the case of the name of the database object name, and remove the delimited char if it's a delimited identifier.
the case of database object name was changed when it's saved in INFORMATION_SCHEMA. In oracle, db2, it's changed to uppercase and in the PostgreSQL, it's changed to lowercase. case of the delimited identifier is unchanged when saved to the INFORMATION_SCHEMA.
So, the implementation is vendor dependent, this method will change the case of database object name accordingly based on the implementation of different database vendor.

Parameters:

sqlEnv - SQL environment

sqlDataObjectType - database object type, such as procedure, table, column

identifier - name of the database object

Returns:

normalized name of the database object

normalizeIdentifier

public static String normalizeIdentifier(EDbVendor dbVendor,
                                         ESQLDataObjectType sqlDataObjectType,
                                         String identifier)

compareTo

public static int compareTo(TSQLEnv sqlEnv,
                            ESQLDataObjectType sqlDataObjectType,
                            TSQLObject targetDataObject,
                            String objectName)

how to compare the name of database object is various from different databases due to the different implementation. We need to consider the database vendor, the database object type when comparing the database object name.

Parameters:

sqlEnv - SQL environment

sqlDataObjectType - database object type

targetDataObject - instance of database object need to be compared

objectName - database object name

Returns:

compareTo

public static int compareTo(EDbVendor dbVendor,
                            ESQLDataObjectType sqlDataObjectType,
                            TSQLObject targetDataObject,
                            String objectName)

compareTo

public static int compareTo(EDbVendor dbVendor,
                            ESQLDataObjectType sqlDataObjectType,
                            String pTargetObjectName,
                            String objectName)

Deprecated. since version 2.2.3.2(2021-05-10), replaced by @TSQLEnv.compareIdentifier()

Parameters:

dbVendor -

sqlDataObjectType -

pTargetObjectName -

objectName -

Returns: