gudusoft.gsqlparser.sqlenv

Class TSQLSynonyms

Object

gudusoft.gsqlparser.sqlenv.TSQLObject

gudusoft.gsqlparser.sqlenv.TSQLSchemaObject

gudusoft.gsqlparser.sqlenv.TSQLSynonyms

public class TSQLSynonyms
extends TSQLSchemaObject

SQL synonyms object.

A synonym is an alias for another schema object (its base target). Besides the synonym name, this class records the base object it points at as a tri-state (database/catalog, schema, object) triple. Any of the three may be null when "unknown": a null getSourceDatabase() / getSourceSchema() means "same database/schema as the synonym itself", resolved lazily by resolveBaseTable(). Cross-database base targets are allowed (a synonym can point at an object in another database).

Field Summary

Fields inherited from class gudusoft.gsqlparser.sqlenv.TSQLObject

dataObjectType, name, nameKeepCase, sqlEnv

Constructor Summary

Constructors

Constructor and Description
TSQLSynonyms(TSQLSchema sqlSchema, String synonymsName)

Method Summary

Modifier and Type	Method and Description
String	getBaseTableQualifiedName()
String	getQualifiedBaseName() the fully qualified name of the base object this synonym points at, in database.schema.object form, defaulting the database/schema to the synonym's own catalog/schema when the source parts are unknown.
String	getSourceDatabase() database/catalog of the base object this synonym points at.
String	getSourceName() name of the base object this synonym points at.
String	getSourceSchema() schema of the base object this synonym points at.
boolean	hasBaseTarget() whether this synonym carries a base target (a non-empty source object name).
TSQLTable	resolveBaseTable() Dereference this synonym to its base table/view by resolving the recorded base target against the owning SQL environment.
void	setBaseTarget(String sourceDatabase, String sourceSchema, String sourceName) Record the base target this synonym points at in one call.
void	setSourceDatabase(String sourceDatabase)
void	setSourceName(String sourceName)
void	setSourceSchema(String sourceSchema)

Methods inherited from class gudusoft.gsqlparser.sqlenv.TSQLSchemaObject

getPriority, getQualifiedName, getSchema, setPriority

Methods inherited from class gudusoft.gsqlparser.sqlenv.TSQLObject

compareTo, compareTo, compareTo, compareTo, getDataObjectType, getName, getNameKeepCase, getSqlEnv, isDelimitedIdentifier, isDelimitedIdentifier, normalizeIdentifier, setDataObjectType

Methods inherited from class Object

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

Constructor Detail

TSQLSynonyms

public TSQLSynonyms(TSQLSchema sqlSchema,
                    String synonymsName)

Method Detail

getSourceDatabase

public String getSourceDatabase()

database/catalog of the base object this synonym points at. null means "the same database as this synonym".

Returns:

base database name, or null when unknown

setSourceDatabase

public void setSourceDatabase(String sourceDatabase)

getSourceSchema

public String getSourceSchema()

schema of the base object this synonym points at. null means "the same schema as this synonym".

Returns:

base schema name, or null when unknown

setSourceSchema

public void setSourceSchema(String sourceSchema)

getSourceName

public String getSourceName()

name of the base object this synonym points at.

Returns:

base object name, or null when unknown

setSourceName

public void setSourceName(String sourceName)

setBaseTarget

public void setBaseTarget(String sourceDatabase,
                          String sourceSchema,
                          String sourceName)

Record the base target this synonym points at in one call.

Parameters:

sourceDatabase - base database/catalog, or null for the synonym's own database

sourceSchema - base schema, or null for the synonym's own schema

sourceName - base object name

hasBaseTarget

public boolean hasBaseTarget()

whether this synonym carries a base target (a non-empty source object name).

Returns:

true if the base object name is known

getQualifiedBaseName

public String getQualifiedBaseName()

the fully qualified name of the base object this synonym points at, in database.schema.object form, defaulting the database/schema to the synonym's own catalog/schema when the source parts are unknown.

Returns:

qualified base name, or null when there is no base target

resolveBaseTable

public TSQLTable resolveBaseTable()

Dereference this synonym to its base table/view by resolving the recorded base target against the owning SQL environment.

Returns:

the base TSQLTable (which may itself be a view), or null when there is no base target or it cannot be resolved

getBaseTableQualifiedName

public String getBaseTableQualifiedName()