gudusoft.gsqlparser.lineage.v2.model

Class Scope

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.Scope

public final class Scope
extends SqllrObject

A name-resolution and lifetime scope. A binding names the scope in which its reference was resolved; a local endpoint names the scope that bounds its lifetime (Sections 4.2 and 9.1). Generated from the schema definition Scope 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	Scope.Builder Collects the members of a new Scope.

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<Scope>	READER Reads a JSON object as a Scope.
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 Scope.Builder	builder()
static Scope	fromJson(Object json) A Scope with the members of a JSON object, all kept.
Map<String,Extension>	getExtensions() The member extensions.
String	getKind() The member kind.
Long	getParentRef() The member parentRef.
String	getPath() The member path.
Long	getRef() The member ref.
Long	getSourceUnitRef() The member sourceUnitRef.
Long	getStatementRef() The member statementRef.
Scope.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<Scope> READER

Reads a JSON object as a Scope.

Method Detail

fromJson

public static Scope fromJson(Object json)

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

builder

public static Scope.Builder builder()

toBuilder

public Scope.Builder toBuilder()

A builder holding every member of this object.

getRef

public Long getRef()

The member ref. A document-local reference: an integer that is unique across the whole document (one reference space for every object that carries a ref). Local references are assigned after merging and have no meaning outside the document (Sections 6.1 and 13). Null when absent; throws IllegalStateException when the member holds another JSON type.

getKind

public String getKind()

The member kind. The kind of a scope. Registry group 'scopeKinds' (Sections 4.2 and 9.1). Null when absent; throws IllegalStateException when the member holds another JSON type.

getParentRef

public Long getParentRef()

The member parentRef. The enclosing scope. A document-local reference: an integer that is unique across the whole document (one reference space for every object that carries a ref). Local references are assigned after merging and have no meaning outside the document (Sections 6.1 and 13). Null when absent; throws IllegalStateException when the member holds another JSON type.

getStatementRef

public Long getStatementRef()

The member statementRef. A document-local reference: an integer that is unique across the whole document (one reference space for every object that carries a ref). Local references are assigned after merging and have no meaning outside the document (Sections 6.1 and 13). Null when absent; throws IllegalStateException when the member holds another JSON type.

getSourceUnitRef

public Long getSourceUnitRef()

The member sourceUnitRef. A document-local reference: an integer that is unique across the whole document (one reference space for every object that carries a ref). Local references are assigned after merging and have no meaning outside the document (Sections 6.1 and 13). Null when absent; throws IllegalStateException when the member holds another JSON type.

getPath

public String getPath()

The member path. The semantic path of the query block within its statement. A semantic path. Under the path profile sqllr-path-1 it is a '/'-joined list of steps CODE[index] (registry group pathStepCodes) that follows algorithms/path-v1.md (semantic stage: SEMANTIC_PATH_PROFILE_VIOLATION); under another declared profile it is opaque and comparable only within (producer, path profile). Null when absent; throws IllegalStateException when the member holds another JSON type.

getExtensions

public Map<String,Extension> getExtensions()

The member extensions. Extension data keyed by namespace. Every core object may carry it; it never takes part in a core identity. Null when absent; throws IllegalStateException when the member holds another JSON type.