gudusoft.gsqlparser.lineage.v2.model

Class AnalysisContext

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.AnalysisContext

public final class AnalysisContext
extends SqllrObject

One analysis context (Sections 6.2 and 9.2): the producer, dialect, dependency snapshot, options, metadata, redaction and capabilities under which an analysis asserted the content of the source units that name it. A document one analysis produced has one; a merged document keeps the context of every input unchanged. Generated from the schema definition AnalysisContext 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	AnalysisContext.Builder Collects the members of a new AnalysisContext.

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<AnalysisContext>	READER Reads a JSON object as a AnalysisContext.
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 AnalysisContext.Builder	builder()
static AnalysisContext	fromJson(Object json) A AnalysisContext with the members of a JSON object, all kept.
Map<String,Object>	getCapabilities() The member capabilities.
String	getDependencySnapshotId() The member dependencySnapshotId.
Dialect	getDialect() The member dialect.
String	getEffectiveOptionsDigest() The member effectiveOptionsDigest.
Map<String,Extension>	getExtensions() The member extensions.
IdentifierPolicy	getIdentifierPolicy() The member identifierPolicy.
Metadata	getMetadata() The member metadata.
String	getPathProfile() The member pathProfile.
Producer	getProducer() The member producer.
Redaction	getRedaction() The member redaction.
Long	getRef() The member ref.
AnalysisContext.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<AnalysisContext> READER

Reads a JSON object as a AnalysisContext.

Method Detail

fromJson

public static AnalysisContext fromJson(Object json)

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

builder

public static AnalysisContext.Builder builder()

toBuilder

public AnalysisContext.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.

getProducer

public Producer getProducer()

The member producer. The producer that ran the analysis. Null when absent; throws IllegalStateException when the member holds another JSON type.

getDialect

public Dialect getDialect()

The member dialect. Null when absent; throws IllegalStateException when the member holds another JSON type.

getIdentifierPolicy

public IdentifierPolicy getIdentifierPolicy()

The member identifierPolicy. Null when absent; throws IllegalStateException when the member holds another JSON type.

getDependencySnapshotId

public String getDependencySnapshotId()

The member dependencySnapshotId. The immutable dependency snapshot used: identifier rules, Unicode version, rule switches, collations, identity algorithms, registry and profiles (Section 14.3, item 3). An id computed by DependencySnapshotIdV1: 'snap1-' followed by 64 lowercase hexadecimal characters of a SHA-256 digest (algorithms/identity-v1.md, Section 5.9; snapshots/FORMAT.md). Null when absent; throws IllegalStateException when the member holds another JSON type.

getPathProfile

public String getPathProfile()

The member pathProfile. The semantic path profile of every path the analysis wrote; 'sqllr-path-1' for the profile of this specification, otherwise a producer-declared id. Null when absent; throws IllegalStateException when the member holds another JSON type.

getEffectiveOptionsDigest

public String getEffectiveOptionsDigest()

The member effectiveOptionsDigest. SHA-256 of the canonical JSON (JCS mode) of the effective analysis options object after resolution; the digest of an empty options object when there are none. The options themselves belong to the module reproducibility. A SHA-256 digest: 64 lowercase hexadecimal characters. Null when absent; throws IllegalStateException when the member holds another JSON type.

getMetadata

public Metadata getMetadata()

The member metadata. Null when absent; throws IllegalStateException when the member holds another JSON type.

getCapabilities

public Map<String,Object> getCapabilities()

The member capabilities. The capability matrix: one value per feature. VALUE and ROW are always declared; a producer that does not support ROW declares UNSUPPORTED and never presents the absence of ROW Facts as COMPLETE (Section 5.3). Null when absent; throws IllegalStateException when the member holds another JSON type.

getRedaction

public Redaction getRedaction()

The member redaction. 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.