gudusoft.gsqlparser.sqlenv

Class SqlNameGenerator

Object

gudusoft.gsqlparser.sqlenv.SqlNameGenerator

public final class SqlNameGenerator
extends Object

Generates a SQL name from STORED name segments.

See docs/refactor/identifier/README.md, "Catalog inputs and name output". This capability lets existing getters such as procedure.getName() can keep their historical output while correct quoting, escaping and qualification live in one place that actually promises them.

Contract

• Input is stored names, never SQL text. Each segment is the name as the database catalog stores it: db name, not [db name]. A stored name whose real content includes delimiter characters ([db name] with the brackets being part of the name) is legal input and is escaped, not reinterpreted.
• Segments are structural. A stored name containing a dot (db.part) is ONE segment. This class never splits a segment and never joins pre-rendered text.
• No guessing. The caller states every segment. Nothing is added: no default schema, no dbo, no current database. A missing or empty segment is a failure, not a hint to fill in.
• A success is verified. Every quoted segment is decoded back and must reproduce the stored name exactly, and must be a valid spelling for the vendor. Anything that cannot be proven yields a failure with a reason instead of a plausible-looking name.

What is NOT promised

Validity is at the identifier level: delimiters, escaping, characters and segment structure. Whether the vendor accepts that many segments in a given statement position, length limits, and whether the object exists are outside this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SqlNameGenerator.Failure Why a name could not be generated.
static class	SqlNameGenerator.QuotePolicy How to choose between the bare and the delimited spelling of a segment.
static class	SqlNameGenerator.Result Outcome of a generation: either the SQL text, or the reason there is none.
static class	SqlNameGenerator.Segment One stored name segment together with its syntactic role.

Method Summary

Modifier and Type	Method and Description
static SqlNameGenerator.Result	generate(EDbVendor vendor, List<SqlNameGenerator.Segment> segments) Convenience for callers holding an immutable segment list.
static SqlNameGenerator.Result	generate(EDbVendor vendor, SqlNameGenerator.QuotePolicy policy, List<SqlNameGenerator.Segment> segments) Generate a SQL name.
static SqlNameGenerator.Result	generate(EDbVendor vendor, SqlNameGenerator.QuotePolicy policy, SqlNameGenerator.Segment... segments)
static SqlNameGenerator.Result	generate(EDbVendor vendor, SqlNameGenerator.Segment... segments) Generate with every segment delimited.
static SqlNameGenerator.Result	respell(EDbVendor vendor, SqlNameGenerator.QuotePolicy policy, ESQLDataObjectType role, String lexical) Re-spell ONE identifier that was read from SQL text, as valid SQL naming the same object.

Methods inherited from class Object

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

Method Detail

generate

public static SqlNameGenerator.Result generate(EDbVendor vendor,
                                               SqlNameGenerator.Segment... segments)

Generate with every segment delimited.

generate

public static SqlNameGenerator.Result generate(EDbVendor vendor,
                                               SqlNameGenerator.QuotePolicy policy,
                                               SqlNameGenerator.Segment... segments)

generate

public static SqlNameGenerator.Result generate(EDbVendor vendor,
                                               SqlNameGenerator.QuotePolicy policy,
                                               List<SqlNameGenerator.Segment> segments)

Generate a SQL name.

Parameters:

vendor - target dialect (non-null)

policy - bare-versus-delimited choice (non-null)

segments - stored name segments, outermost first

Returns:

the SQL name, or the reason none could be produced

respell

public static SqlNameGenerator.Result respell(EDbVendor vendor,
                                              SqlNameGenerator.QuotePolicy policy,
                                              ESQLDataObjectType role,
                                              String lexical)

Re-spell ONE identifier that was read from SQL text, as valid SQL naming the same object.

This is the entry point for a name that HAS a source spelling, as opposed to generate(gudusoft.gsqlparser.EDbVendor, gudusoft.gsqlparser.sqlenv.SqlNameGenerator.Segment...), which starts from a stored name. The difference matters for case:

• Written without delimiters. The script parsed, so the bare word is already proven to be valid SQL for this object, and re-emitting it bare cannot name anything else. It is returned as written. It is deliberately NOT case-folded: that would need the catalog's real stored case, and the name service's fold is a comparison key, not a storage rule (Teradata is modeled with PostgreSQL's lower-casing although it stores names as created). Folding here turned DB51_CAD into db51_cad.
• Written with delimiters. Decoding gives the exact stored text, and generate(gudusoft.gsqlparser.EDbVendor, gudusoft.gsqlparser.sqlenv.SqlNameGenerator.Segment...) decides whether the delimiters can be dropped.

So two references to one object may still re-spell differently (Sales and SALES on Oracle). Making a LISTING show one of them is the job of identity grouping plus a display-name policy, which can consult the catalog; it is not something a single spelling can decide.

generate

public static SqlNameGenerator.Result generate(EDbVendor vendor,
                                               List<SqlNameGenerator.Segment> segments)

Convenience for callers holding an immutable segment list.