gudusoft.gsqlparser.catalog.runtime

Class CatalogObjectKey

Object

gudusoft.gsqlparser.catalog.runtime.CatalogObjectKey

public final class CatalogObjectKey
extends Object

Identity of one named catalog object, built from EXPLICIT semantic roles (stage S0R of docs/refactor/identifier_identity_display_separation_plan.md).

What this replaces and why

The deleted QualifiedCanonKey inferred each component's role from how many components the name had. That is a guess, and it is wrong in both directions: it read BigQuery customer.name as table.column when the repository's own FieldPath and TestBigQueryNestedColumns say it is base column plus STRUCT field — and BigQuery folds table names case-sensitively while folding column names case-insensitively, so the guess changed the ANSWER, not merely the label. It also had no server level at all, so SQL Server's srv.db.dbo.t had its server compared as a catalog.

Here nothing is inferred. Each component carries its role; each OBJECT component carries its entity kind; the sequence is validated by CatalogNameGrammar at construction; and the comparison rules for each component come from the one mapping that owns them (IdentifierRolePolicy for role-decided components, CatalogIdentifierPolicy.comparisonTypeOfKind(gudusoft.gsqlparser.catalog.runtime.CatalogObjectKind) for objects).

Equality

Two keys are equal iff they have the same terminal kind, the same number of components, and component-wise equal role, kind and CanonKey — plus an equal database link. So a table named x never equals a view named x, and db.s.t never equals a name whose first component is a server.

In-process only

It contains CanonKeys, whose collation payloads are stable only within one JVM and collator configuration. Do NOT stringify it to produce a CatalogObjectId: that type promises cross-snapshot stability, which this cannot give. Use PersistentIdentifierKey for anything persisted, and never CanonKey.getCanonText() or this type's toString().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogObjectKey.Component One component: its role, its entity kind when it is an object, and its canonical key.

Method Summary

Modifier and Type	Method and Description
static CatalogObjectKey	atDatabaseLink(IdentifierService service, CatalogObjectKey completeLocalKey, String link, IdentifierInputForm form) The same identity, reached through a database link.
static CatalogObjectKey	catalog(IdentifierService service, CatalogHierarchy hierarchy, String server, String catalog, IdentifierInputForm form) A catalog, optionally under a server.
static CatalogObjectKey	childObject(IdentifierService service, CatalogObjectKey parent, CatalogObjectKind childKind, String localName, IdentifierInputForm form) An index, constraint or package member of an already-identified parent object.
static CatalogObjectKey	column(IdentifierService service, CatalogObjectKey parentRelation, String localName, IdentifierInputForm form) A column of an already-identified relation.
String	describeRuleDomain() A description of the rule domain this identity's components were canonicalized under, for diagnostics.
boolean	equals(Object o)
List<CatalogObjectKey.Component>	getComponents() The components, outermost first.
CanonKey	getDatabaseLink() The database link qualifying this name, or null.
CatalogHierarchy	getHierarchy() The namespace topology this identity was declared complete against.
CatalogObjectKey.Component	getLeaf() The innermost component — the object or column this key names.
CatalogObjectKind	getTerminalKind() What the name as a whole denotes.
int	hashCode()
static CatalogObjectKey	objectInCatalogOnly(IdentifierService service, CatalogObjectKey parentCatalog, CatalogObjectKind kind, String localName, IdentifierInputForm form) An object directly inside a catalog, for a schemaless topology such as MySQL's.
static CatalogObjectKey	objectInSchema(IdentifierService service, CatalogObjectKey parentSchema, CatalogObjectKind kind, String localName, IdentifierInputForm form) An object inside an already-identified schema.
static CatalogObjectKey	rootObject(IdentifierService service, CatalogHierarchy hierarchy, CatalogObjectKind kind, String localName, IdentifierInputForm form) An object at the root of a topology with no container levels at all.
static CatalogObjectKey	rootSchema(IdentifierService service, CatalogHierarchy hierarchy, String schema, IdentifierInputForm form) A schema under a topology that has no catalog level.
static CatalogObjectKey	schemaIn(IdentifierService service, CatalogObjectKey parentCatalog, String schema, IdentifierInputForm form) A schema inside an already-identified catalog.
int	size()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

catalog

public static CatalogObjectKey catalog(IdentifierService service,
                                       CatalogHierarchy hierarchy,
                                       String server,
                                       String catalog,
                                       IdentifierInputForm form)

A catalog, optionally under a server. Parts are passed SEPARATELY — a caller holding them apart must not join them, because joining and re-splitting is how boundary information is lost.

A catalog needs nothing above it: a name without a server means the local server, which is an absence rather than a missing level.

schemaIn

public static CatalogObjectKey schemaIn(IdentifierService service,
                                        CatalogObjectKey parentCatalog,
                                        String schema,
                                        IdentifierInputForm form)

A schema inside an already-identified catalog. The parent is REQUIRED on a topology that has a catalog level: a schema identity that does not name its catalog is not resolved, and keying it would collide with the same schema name in another catalog. Use rootSchema(gudusoft.gsqlparser.sqlenv.IdentifierService, gudusoft.gsqlparser.catalog.runtime.CatalogHierarchy, java.lang.String, gudusoft.gsqlparser.sqlenv.IdentifierInputForm) for a topology that genuinely has no catalog.

rootSchema

public static CatalogObjectKey rootSchema(IdentifierService service,
                                          CatalogHierarchy hierarchy,
                                          String schema,
                                          IdentifierInputForm form)

A schema under a topology that has no catalog level. The topology must say so — that is what proves the missing catalog is structural rather than unresolved.

objectInSchema

public static CatalogObjectKey objectInSchema(IdentifierService service,
                                              CatalogObjectKey parentSchema,
                                              CatalogObjectKind kind,
                                              String localName,
                                              IdentifierInputForm form)

An object inside an already-identified schema.

objectInCatalogOnly

public static CatalogObjectKey objectInCatalogOnly(IdentifierService service,
                                                   CatalogObjectKey parentCatalog,
                                                   CatalogObjectKind kind,
                                                   String localName,
                                                   IdentifierInputForm form)

An object directly inside a catalog, for a schemaless topology such as MySQL's. The topology must declare that it has no schema level; otherwise the missing schema is an omission and this is a lookup, not an identity.

rootObject

public static CatalogObjectKey rootObject(IdentifierService service,
                                          CatalogHierarchy hierarchy,
                                          CatalogObjectKind kind,
                                          String localName,
                                          IdentifierInputForm form)

An object at the root of a topology with no container levels at all. Rare and deliberately awkward to reach: on any dialect that HAS containers, a bare object name is a lookup.

column

public static CatalogObjectKey column(IdentifierService service,
                                      CatalogObjectKey parentRelation,
                                      String localName,
                                      IdentifierInputForm form)

A column of an already-identified relation.

childObject

public static CatalogObjectKey childObject(IdentifierService service,
                                           CatalogObjectKey parent,
                                           CatalogObjectKind childKind,
                                           String localName,
                                           IdentifierInputForm form)

An index, constraint or package member of an already-identified parent object.

atDatabaseLink

public static CatalogObjectKey atDatabaseLink(IdentifierService service,
                                              CatalogObjectKey completeLocalKey,
                                              String link,
                                              IdentifierInputForm form)

The same identity, reached through a database link. This is the only PUBLIC way to attach one, because the general builder is package-private — without it a caller could inherit a link but never declare one.

The local key must already be complete, and its terminal must be a shape a remote reference is known to take. Descendants composed onto the result inherit the link, which is correct: a column of a remote table is reachable as t@remote.c.

getComponents

public List<CatalogObjectKey.Component> getComponents()

The components, outermost first. Never empty.

getTerminalKind

public CatalogObjectKind getTerminalKind()

What the name as a whole denotes.

getHierarchy

public CatalogHierarchy getHierarchy()

The namespace topology this identity was declared complete against.

describeRuleDomain

public String describeRuleDomain()

A description of the rule domain this identity's components were canonicalized under, for diagnostics. It is NOT part of equality: equality is component-wise CanonKey equality, and two keys whose components are equal are the same identity regardless of which service object produced them.

getDatabaseLink

public CanonKey getDatabaseLink()

The database link qualifying this name, or null.

size

public int size()

getLeaf

public CatalogObjectKey.Component getLeaf()

The innermost component — the object or column this key names.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object