Document (General SQL Parser Java Library Core 4.2.19 API)

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

```
public final class Document
extends SqllrObject
```
A SQL-LR lineage document (specification Section 6). Generated from the schema root 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 Document.Builder
Collects the members of a new Document.
- 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`	`Document.Builder` Collects the members of a new `Document`.

Field Summary

Fields
Modifier and Type	Field and Description
`static List<String>`	`MEMBERS` The members the schema defines, in schema order.
`static SqllrObject.Reader<Document>`	`READER` Reads a JSON object as a `Document`.
`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 Document.Builder`	`builder()`
`static Document`	`fromJson(Object json)` A `Document` with the members of a JSON object, all kept.
`String`	`getAnalysisCompleteness()` The member `analysisCompleteness`.
`List<AnalysisContext>`	`getAnalysisContexts()` The member `analysisContexts`.
`List<CandidateSet>`	`getCandidateSets()` The member `candidateSets`.
`String`	`getDeclaredLevel()` The member `declaredLevel`.
`List<Diagnostic>`	`getDiagnostics()` The member `diagnostics`.
`List<Map<String,Object>>`	`getDynamicSqlSites()` The member `dynamicSqlSites`.
`List<Endpoint>`	`getEndpoints()` The member `endpoints`.
`List<Map<String,Object>>`	`getEvidence()` The member `evidence`.
`ExplainGraph`	`getExplainGraph()` The member `explainGraph`.
`List<Map<String,Object>>`	`getExpressionSpans()` The member `expressionSpans`.
`Map<String,Extension>`	`getExtensions()` The member `extensions`.
`List<FactCandidate>`	`getFactCandidates()` The member `factCandidates`.
`List<Fact>`	`getFacts()` The member `facts`.
`List<FeatureCompleteness>`	`getFeatureCompleteness()` The member `featureCompleteness`.
`Header`	`getHeader()` The member `header`.
`Map<String,Object>`	`getMerge()` The member `merge`.
`List<String>`	`getModules()` The member `modules`.
`List<Map<String,Object>>`	`getNaryFacts()` The member `naryFacts`.
`List<Occurrence>`	`getOccurrences()` The member `occurrences`.
`List<Map<String,Object>>`	`getRefinements()` The member `refinements`.
`Map<String,Object>`	`getReproducibilityManifest()` The member `reproducibilityManifest`.
`List<Map<String,Object>>`	`getRoutineCalls()` The member `routineCalls`.
`List<Scope>`	`getScopes()` The member `scopes`.
`ServingCompleteness`	`getServingCompleteness()` The member `servingCompleteness`.
`List<SourceUnit>`	`getSourceUnits()` The member `sourceUnits`.
`String`	`getSpecUri()` The member `specUri`.
`String`	`getSpecVersion()` The member `specVersion`.
`List<Statement>`	`getStatements()` The member `statements`.
`List<Map<String,Object>>`	`getStructuralSignatures()` The member `structuralSignatures`.
`List<TargetFieldOccurrence>`	`getTargetFieldOccurrences()` The member `targetFieldOccurrences`.
`List<Map<String,Object>>`	`getTypedSteps()` The member `typedSteps`.
`List<Map<String,Object>>`	`getWildcardSelections()` The member `wildcardSelections`.
`static Document`	`parse(byte[] data)` Reads a document with the strict reader of canonical-json-v1 (Section 3); does not validate.
`Document.Builder`	`toBuilder()` A builder holding every member of this object.
`byte[]`	`toBytes()` The canonical bytes of the document: RFC 8785, every array in its registered order.

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<Document> READER
```
    Reads a JSON object as a Document.
- Method Detail
  - fromJson
```
public static Document fromJson(Object json)
```
    A Document with the members of a JSON object, all kept.
  - builder
```
public static Document.Builder builder()
```
  - toBuilder
```
public Document.Builder toBuilder()
```
    A builder holding every member of this object.
  - getSpecUri
```
public String getSpecUri()
```
    The member specUri. The permanent URI of the specification, assigned at release. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getSpecVersion
```
public String getSpecVersion()
```
    The member specVersion. The specification version. This schema accepts 0.1.x. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getDeclaredLevel
```
public String getDeclaredLevel()
```
    The member declaredLevel. A producer conformance level. Registry group 'levels' (Section 5.1). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getModules
```
public List<String> getModules()
```
    The member modules. The optional modules the document carries. A consumer never treats a module that is not listed as an empty collection. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getHeader
```
public Header getHeader()
```
    The member header. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getAnalysisContexts
```
public List<AnalysisContext> getAnalysisContexts()
```
    The member analysisContexts. The analysis contexts of the document (Sections 6.2 and 9.2). Every source unit names one. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getSourceUnits
```
public List<SourceUnit> getSourceUnits()
```
    The member sourceUnits. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getStatements
```
public List<Statement> getStatements()
```
    The member statements. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getScopes
```
public List<Scope> getScopes()
```
    The member scopes. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getEndpoints
```
public List<Endpoint> getEndpoints()
```
    The member endpoints. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getFacts
```
public List<Fact> getFacts()
```
    The member facts. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getFactCandidates
```
public List<FactCandidate> getFactCandidates()
```
    The member factCandidates. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getCandidateSets
```
public List<CandidateSet> getCandidateSets()
```
    The member candidateSets. The candidate sets of the ambiguous references at which a Fact keeps an Occurrence (Section 4.3, rule 1): a Fact that holds whichever candidate the reference denotes keeps the reference's CANDIDATE or UNRESOLVED binding, whose candidateSetRef names a set of this array. Its candidates are Endpoints; a candidate that is an ExplainGraph node is not listed, and the set is then INCOMPLETE. It also holds the deciding sets that the decidedBy of FactCandidate ends names (algorithms/fold-v1.md, Section 7.1, item 5): for a call that several routines fit, the ROUTINE endpoints of those routines. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getOccurrences
```
public List<Occurrence> getOccurrences()
```
    The member occurrences. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getTargetFieldOccurrences
```
public List<TargetFieldOccurrence> getTargetFieldOccurrences()
```
    The member targetFieldOccurrences. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getAnalysisCompleteness
```
public String getAnalysisCompleteness()
```
    The member analysisCompleteness. Document-scope analysis completeness. 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.
  - getServingCompleteness
```
public ServingCompleteness getServingCompleteness()
```
    The member servingCompleteness. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getDiagnostics
```
public List<Diagnostic> getDiagnostics()
```
    The member diagnostics. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getMerge
```
public Map<String,Object> getMerge()
```
    The member merge. Merge provenance of a merged document: input digests and the conflict ledger (Sections 9.5 and 15.2). The analysis context of each input, with its dependency snapshot and redaction context, is in analysisContexts. Defined later. Module content, defined later. Open: members are not yet constrained; arrays inside it are SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). 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.
  - getExplainGraph
```
public ExplainGraph getExplainGraph()
```
    The member explainGraph. The ExplainGraph (Sections 3.4 and 7.7). Module explain. Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getEvidence
```
public List<Map<String,Object>> getEvidence()
```
    The member evidence. Evidence objects. Module evidence, defined later. A collection of module content, defined later. Registered as a SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getDynamicSqlSites
```
public List<Map<String,Object>> getDynamicSqlSites()
```
    The member dynamicSqlSites. Dynamic SQL sites, holes and proofs. Module dynamic-sql, defined later. A collection of module content, defined later. Registered as a SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getExpressionSpans
```
public List<Map<String,Object>> getExpressionSpans()
```
    The member expressionSpans. Expression-level spans. Module exact-spans, defined later. A collection of module content, defined later. Registered as a SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getReproducibilityManifest
```
public Map<String,Object> getReproducibilityManifest()
```
    The member reproducibilityManifest. All effective analysis options and the metadata digest. Module reproducibility, defined later. Module content, defined later. Open: members are not yet constrained; arrays inside it are SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getTypedSteps
```
public List<Map<String,Object>> getTypedSteps()
```
    The member typedSteps. Typed steps and operand groups (Section 7.6). Module typed-steps, defined later. A collection of module content, defined later. Registered as a SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getRoutineCalls
```
public List<Map<String,Object>> getRoutineCalls()
```
    The member routineCalls. Call sites and argument-to-parameter bindings (Section 7.3). Module routines, defined later. A collection of module content, defined later. Registered as a SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getWildcardSelections
```
public List<Map<String,Object>> getWildcardSelections()
```
    The member wildcardSelections. WildcardSelection objects (Section 7.5). Module wildcards, defined later. A collection of module content, defined later. Registered as a SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getStructuralSignatures
```
public List<Map<String,Object>> getStructuralSignatures()
```
    The member structuralSignatures. Structural signatures of ExplainGraph nodes. Module structural-signature, defined later. A collection of module content, defined later. Registered as a SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getRefinements
```
public List<Map<String,Object>> getRefinements()
```
    The member refinements. Refinement records (Sections 3.2, rule 4, and 7.1). Module join-semantics, defined later. A collection of module content, defined later. Registered as a SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - getNaryFacts
```
public List<Map<String,Object>> getNaryFacts()
```
    The member naryFacts. N-ary Facts (Section 3.2, rule 3). Module nary-facts, defined later. A collection of module content, defined later. Registered as a SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws IllegalStateException when the member holds another JSON type.
  - parse
```
public static Document parse(byte[] data)
```
    Reads a document with the strict reader of canonical-json-v1 (Section 3); does not validate.
  - toBytes
```
public byte[] toBytes()
```
    The canonical bytes of the document: RFC 8785, every array in its registered order.

Class Document

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

getSpecUri

getSpecVersion

getDeclaredLevel

getModules

getHeader

getAnalysisContexts

getSourceUnits

getStatements

getScopes

getEndpoints

getFacts

getFactCandidates

getCandidateSets

getOccurrences

getTargetFieldOccurrences

getAnalysisCompleteness

getFeatureCompleteness

getServingCompleteness

getDiagnostics

getMerge

getExtensions

getExplainGraph

getEvidence

getDynamicSqlSites

getExpressionSpans

getReproducibilityManifest

getTypedSteps

getRoutineCalls

getWildcardSelections

getStructuralSignatures

getRefinements

getNaryFacts

parse

toBytes