SourceUnit (General SQL Parser Java Library Core 4.2.19 API)

Object
- gudusoft.gsqlparser.lineage.v2.model.SqllrObject
- - gudusoft.gsqlparser.lineage.v2.model.SourceUnit

```
public final class SourceUnit
extends SqllrObject
```
A unit of input text (Sections 7.8 and 12). A unit whose analysis failed is still recorded, as a placeholder with analysisCompleteness FAILED (Section 6.5). Generated from the schema definition SourceUnit 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 SourceUnit.Builder
Collects the members of a new SourceUnit.
- Nested classes/interfaces inherited from class gudusoft.gsqlparser.lineage.v2.model.SqllrObject
  SqllrObject.Reader<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`SourceUnit.Builder` Collects the members of a new `SourceUnit`.

Field Summary

Fields
Modifier and Type	Field and Description
`static List<String>`	`MEMBERS` The members the schema defines, in schema order.
`static SqllrObject.Reader<SourceUnit>`	`READER` Reads a JSON object as a `SourceUnit`.
`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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SourceUnit.Builder`	`builder()`
`static SourceUnit`	`fromJson(Object json)` A `SourceUnit` with the members of a JSON object, all kept.
`String`	`getAnalysisCompleteness()` The member `analysisCompleteness`.
`String`	`getAnalysisContextId()` The member `analysisContextId`.
`Long`	`getAnalysisContextRef()` The member `analysisContextRef`.
`Digest`	`getContentDigest()` The member `contentDigest`.
`String`	`getContextDomain()` The member `contextDomain`.
`Decoding`	`getDecoding()` The member `decoding`.
`String`	`getDerivedTextStatus()` The member `derivedTextStatus`.
`List<Long>`	`getDiagnosticRefs()` The member `diagnosticRefs`.
`List<Digest>`	`getDigests()` The member `digests`.
`Map<String,Extension>`	`getExtensions()` The member `extensions`.
`List<FeatureCompleteness>`	`getFeatureCompleteness()` The member `featureCompleteness`.
`String`	`getIdentityKind()` The member `identityKind`.
`String`	`getLogicalName()` The member `logicalName`.
`String`	`getNamespace()` The member `namespace`.
`String`	`getOriginKind()` The member `originKind`.
`List<Map<String,Object>>`	`getOriginMap()` The member `originMap`.
`String`	`getOriginMapping()` The member `originMapping`.
`Long`	`getParentUnitRef()` The member `parentUnitRef`.
`Long`	`getRef()` The member `ref`.
`List<Digest>`	`getResolutionInputDigests()` The member `resolutionInputDigests`.
`Long`	`getSiteOrdinal()` The member `siteOrdinal`.
`String`	`getSitePath()` The member `sitePath`.
`Span`	`getSiteSpan()` The member `siteSpan`.
`Long`	`getSiteStatementRef()` The member `siteStatementRef`.
`String`	`getText()` The member `text`.
`String`	`getUnitId()` The member `unitId`.
`String`	`getUri()` The member `uri`.
`Long`	`getVariantOrdinal()` The member `variantOrdinal`.
`SourceUnit.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<SourceUnit> READER
```
    Reads a JSON object as a SourceUnit.
- Method Detail
  - fromJson
```
public static SourceUnit fromJson(Object json)
```
    A SourceUnit with the members of a JSON object, all kept.
  - builder
```
public static SourceUnit.Builder builder()
```
  - toBuilder
```
public SourceUnit.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.
  - getIdentityKind
```
public String getIdentityKind()
```
    The member identityKind. The kind of a source unit identity. Registry group 'sourceUnitIdentityKinds' (Section 7.8). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getUnitId
```
public String getUnitId()
```
    The member unitId. The portable source unit id; absent for LOCAL units (identity stage: ID_MISSING when a NAMED or CONTENT_ADDRESSED unit omits it). An id computed by SourceUnitIdV1: 'su1-' followed by 64 lowercase hexadecimal characters of a SHA-256 digest (algorithms/identity-v1.md). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getAnalysisContextRef
```
public Long getAnalysisContextRef()
```
    The member analysisContextRef. The analysis context under which the document asserts the content of this unit (an object of analysisContexts). A merged document holds one source unit record per unit and context. 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.
  - getAnalysisContextId
```
public String getAnalysisContextId()
```
    The member analysisContextId. AnalysisContextV1 of this unit: the manifest of its analysis context, its decoding, its version digest selected by algorithms/identity-v1.md, Section 5.5, and its resolution input digests. Present when the unit has a unitId and at least one digest (identity stage: ID_MISSING / ID_UNEXPECTED). An id computed by AnalysisContextV1: 'actx1-' followed by 64 lowercase hexadecimal characters of a SHA-256 digest (algorithms/identity-v1.md). The digest of the analysis context of one source unit. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getNamespace
```
public String getNamespace()
```
    The member namespace. The caller-provided namespace, such as a repository (NAMED units). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getLogicalName
```
public String getLogicalName()
```
    The member logicalName. The caller-provided name within the namespace, such as a path relative to the repository (NAMED units). Never an absolute local path. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getContextDomain
```
public String getContextDomain()
```
    The member contextDomain. The caller-declared context domain of a CONTENT_ADDRESSED unit: the domain within which, by the caller's declaration, equal content is one logical source unit (Section 7.8). An unnamed file without that declaration is a LOCAL unit. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getUri
```
public String getUri()
```
    The member uri. A retrieval location after redaction. Not part of any identity. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getOriginKind
```
public String getOriginKind()
```
    The member originKind. The origin of a source unit. Registry group 'sourceUnitOriginKinds' (Section 7.8). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getParentUnitRef
```
public Long getParentUnitRef()
```
    The member parentUnitRef. The unit a derived unit was derived from. 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.
  - getSitePath
```
public String getSitePath()
```
    The member sitePath. The semantic path of the execution or expansion site within the parent unit's 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.
  - getSiteSpan
```
public Span getSiteSpan()
```
    The member siteSpan. The location of the execution or expansion site in the parent unit (Section 12.2, rule 1). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getOriginMapping
```
public String getOriginMapping()
```
    The member originMapping. Whether a derived source unit is mapped to its parent. Registry group 'originMappingStatus' (Section 7.8). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getDerivedTextStatus
```
public String getDerivedTextStatus()
```
    The member derivedTextStatus. Whether the derived text is proven to be the text the site executes (algorithms/fold-v1.md, Section 7.3). Required for a derived unit. Whether the text of a derived source unit is proven. Registry group 'derivedTextStatus' (Sections 7.8 and 11.4). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getDigests
```
public List<Digest> getDigests()
```
    The member digests. Version digests of the unit, at most one per domain. They identify the version, not the unit; the first present in registry order (RAW_BYTES_SHA256, DECODED_TEXT_SHA256, REDACTED_TEXT_SHA256, KEYED_TOKEN) enters the analysis context. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getResolutionInputDigests
```
public List<Digest> getResolutionInputDigests()
```
    The member resolutionInputDigests. The version digest of every other source unit whose content the analysis read to resolve the names of this unit (its DDL, views, routines, session statements). A producer that cannot tell lists every input unit of the analysis. An input of the analysis context (algorithms/identity-v1.md, Section 5.5). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getContentDigest
```
public Digest getContentDigest()
```
    The member contentDigest. The content digest of a CONTENT_ADDRESSED unit, an input of its identity. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getSiteStatementRef
```
public Long getSiteStatementRef()
```
    The member siteStatementRef. The statement of the parent unit that contains the execution or expansion site. 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.
  - getSiteOrdinal
```
public Long getSiteOrdinal()
```
    The member siteOrdinal. The 0-based ordinal of the site on its semantic path. A 0-based ordinal. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getVariantOrdinal
```
public Long getVariantOrdinal()
```
    The member variantOrdinal. The 0-based ordinal of this text among the texts derived from one site. A 0-based ordinal. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getOriginMap
```
public List<Map<String,Object>> getOriginMap()
```
    The member originMap. The origin map of a MAPPED derived unit, ordered by position in the derived text. Module exact-spans, defined later. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getDecoding
```
public Decoding getDecoding()
```
    The member decoding. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getText
```
public String getText()
```
    The member text. The embedded text (Section 12.3): the decoded text under FULL, the redacted text under REDACTED; absent under NONE. Never part of any id. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getAnalysisCompleteness
```
public String getAnalysisCompleteness()
```
    The member analysisCompleteness. Analysis completeness of a scope. Registry group 'analysisCompleteness' (Section 4.4). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getFeatureCompleteness
```
public List<FeatureCompleteness> getFeatureCompleteness()
```
    The member featureCompleteness. Feature-scope completeness; one entry per feature. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getDiagnosticRefs
```
public List<Long> getDiagnosticRefs()
```
    The member diagnosticRefs. A set of local references. 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.

Class SourceUnit

Nested Class Summary

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

Field Summary

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

Method Summary

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

Methods inherited from class Object

Field Detail

MEMBERS

REQUIRED

READER

Method Detail

fromJson

builder

toBuilder

getRef

getIdentityKind

getUnitId

getAnalysisContextRef

getAnalysisContextId

getNamespace

getLogicalName

getContextDomain

getUri

getOriginKind

getParentUnitRef

getSitePath

getSiteSpan

getOriginMapping

getDerivedTextStatus

getDigests

getResolutionInputDigests

getContentDigest

getSiteStatementRef

getSiteOrdinal

getVariantOrdinal

getOriginMap

getDecoding

getText

getAnalysisCompleteness

getFeatureCompleteness

getDiagnosticRefs

getExtensions