gudusoft.gsqlparser.resolver2.format

Enum DisplayNameMode

Object

Enum<DisplayNameMode>

gudusoft.gsqlparser.resolver2.format.DisplayNameMode

All Implemented Interfaces:

Serializable, Comparable<DisplayNameMode>

public enum DisplayNameMode
extends Enum<DisplayNameMode>

Controls how identifier names are rendered for display output.

This mode determines the "visual style" of the output - whether to show raw SQL form with quotes, clean display form without quotes, or canonical form.

Note: This is separate from DisplayNamePolicy which determines "which occurrence to use" when the same object appears multiple times with different spellings.

Example with SQL Server:

 SQL: SELECT [OrderID] FROM [dbo].[SalesOrder]

 DISPLAY:    dbo.SalesOrder, OrderID (quotes stripped, case preserved)
 SQL_RENDER: [dbo].[SalesOrder], [OrderID] (quotes preserved)
 CANONICAL:  dbo.SalesOrder, OrderID (SQL Server stores names as written,
             so its canonical form folds nothing and matches DISPLAY here)

 The same names under Oracle, where unquoted identifiers DO fold:

 SQL: SELECT OrderID, "Order Date" FROM SalesOrder

 DISPLAY:    SalesOrder, OrderID, Order Date
 CANONICAL:  SALESORDER, ORDERID, Order Date   ("Order Date" was quoted, so it keeps its case)
 

See Also:

DisplayNamePolicy, DisplayNameNormalizer

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANONICAL Canonical mode: apply vendor-specific case folding.
DISPLAY Display mode: strip delimiters, preserve original case.
SQL_RENDER SQL render mode: the name written as valid SQL for the vendor.

Method Summary

Modifier and Type	Method and Description
static DisplayNameMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DisplayNameMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISPLAY

public static final DisplayNameMode DISPLAY

Display mode: strip delimiters, preserve original case.

Recommended for debugging and test output. Produces clean, readable output that reflects what the user wrote (minus the quote noise).

Examples:

• [OrderID] → OrderID
• `kalyan-DB` → kalyan-DB
• "MyTable" → MyTable

SQL_RENDER

public static final DisplayNameMode SQL_RENDER

SQL render mode: the name written as valid SQL for the vendor.

"Valid SQL that names this object" is a constraint, not a value: dbo, [dbo] and "dbo" all satisfy it. The spelling is therefore GENERATED by rule rather than echoed from whichever reference was read, and SqlNameGenerator.QuotePolicy is the parameter that makes it unique:

• WHEN_NEEDED (default): delimit only where the bare word would be invalid, would denote another object, or is a keyword. [dbo].[Sales Order] → dbo.[Sales Order]; MySQL `t`.`date` → t.`date`
• ALWAYS: delimit every segment. dbo.T → [dbo].[T]

A name written without delimiters is returned as written: it is already valid SQL for that object, and folding its case would need the catalog's stored case, which SQL text does not reveal. One object written several ways still yields ONE listing row, chosen by DisplayNamePolicy.

CANONICAL

public static final DisplayNameMode CANONICAL

Canonical mode: apply vendor-specific case folding.

Produces output matching the database's internal canonical form. Useful for comparing against metadata or catalog information.

Examples (vendor-dependent):

• Oracle: MyTable → MYTABLE (unquoted folds to upper)
• PostgreSQL: MyTable → mytable (unquoted folds to lower)
• BigQuery: MyTable → MyTable (case-sensitive)

Method Detail

values

public static DisplayNameMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DisplayNameMode c : DisplayNameMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DisplayNameMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null