gudusoft.gsqlparser.lineage.v2.model

Class NameSegment

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.NameSegment

public final class NameSegment
extends SqllrObject

One segment of an endpoint name (Sections 6.3 and 9.1). A NAMED segment carries text; a PRODUCER_DEFAULT segment is exactly {role, kind} and never equals a real name. Generated from the schema definition NameSegment by scripts/sqllr/gen_type_model.py; do not edit.

Since:

4.2.17

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NameSegment.Builder Collects the members of a new NameSegment.

Nested classes/interfaces inherited from class gudusoft.gsqlparser.lineage.v2.model.SqllrObject

SqllrObject.Reader<T>

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	MEMBERS The members the schema defines, in schema order.
static SqllrObject.Reader<NameSegment>	READER Reads a JSON object as a NameSegment.
static List<String>	REQUIRED The members the schema requires.

Fields inherited from class gudusoft.gsqlparser.lineage.v2.model.SqllrObject

ANY, BOOLEAN, INTEGER, JSON_NULL, OBJECT, STRING

Method Summary

Modifier and Type	Method and Description
static NameSegment.Builder	builder()
static NameSegment	fromJson(Object json) A NameSegment with the members of a JSON object, all kept.
String	getCanonicalKey() The member canonicalKey.
String	getInputForm() The member inputForm.
String	getKeyUnavailable() The member keyUnavailable.
String	getKind() The member kind.
String	getProvenance() The member provenance.
String	getQuoteState() The member quoteState.
String	getRole() The member role.
String	getText() The member text.
NameSegment.Builder	toBuilder() A builder holding every member of this object.

Methods inherited from class gudusoft.gsqlparser.lineage.v2.model.SqllrObject

anyMember, bool, equals, get, has, hashCode, integer, list, listOf, map, mapOf, members, object, string, toJson, toString, typed

Methods inherited from class Object

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

Field Detail

MEMBERS

public static final List<String> MEMBERS

The members the schema defines, in schema order.

REQUIRED

public static final List<String> REQUIRED

The members the schema requires.

READER

public static final SqllrObject.Reader<NameSegment> READER

Reads a JSON object as a NameSegment.

Method Detail

fromJson

public static NameSegment fromJson(Object json)

A NameSegment with the members of a JSON object, all kept.

builder

public static NameSegment.Builder builder()

toBuilder

public NameSegment.Builder toBuilder()

A builder holding every member of this object.

getRole

public String getRole()

The member role. The role of a name segment. Registry group 'segmentRoles' (Sections 6.3 and 9.1). Null when absent; throws IllegalStateException when the member holds another JSON type.

getKind

public String getKind()

The member kind. The kind of a name segment. Registry group 'nameSegmentKinds' (Section 9.1). Null when absent; throws IllegalStateException when the member holds another JSON type.

getText

public String getText()

The member text. The segment text: as written (SQL_LEXICAL, without delimiters), as stored (CATALOG_STORED), or byte-for-byte for AUTHORITY and LOCATION. Null when absent; throws IllegalStateException when the member holds another JSON type.

getInputForm

public String getInputForm()

The member inputForm. The input form of a name segment. Registry group 'nameSegmentInputForms' (Section 6.3). Null when absent; throws IllegalStateException when the member holds another JSON type.

getQuoteState

public String getQuoteState()

The member quoteState. The quote state of a SQL_LEXICAL name segment. Registry group 'quoteStates' (Section 6.3). Null when absent; throws IllegalStateException when the member holds another JSON type.

getProvenance

public String getProvenance()

The member provenance. Where the text of a NAMED segment came from. Registry group 'segmentProvenance' (Sections 6.3 and 9.1). Null when absent; throws IllegalStateException when the member holds another JSON type.

getCanonicalKey

public String getCanonicalKey()

The member canonicalKey. The canonical segment key minted by CanonicalSegmentKeyV1 (identifier-rules/FORMAT.md, Section 9) from the dialect rule set of the dependency snapshot, the object type of registry/qualification-profiles.json (segmentObjectTypes), text, inputForm and quoteState. EndpointIdV1 frames it; recomputed at the identity stage. Absent for AUTHORITY and LOCATION segments, whose text is used byte for byte. Null when absent; throws IllegalStateException when the member holds another JSON type.

getKeyUnavailable

public String getKeyUnavailable()

The member keyUnavailable. Why no canonical key can be minted; excludes canonicalKey. Why a canonical segment key cannot be minted. Registry group 'keyUnavailableReasons' (Sections 6.3 and 10.6). Null when absent; throws IllegalStateException when the member holds another JSON type.