gudusoft.gsqlparser.lineage.v2.model

Class MicroEdge

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.MicroEdge

public final class MicroEdge
extends SqllrObject

An edge of the ExplainGraph (algorithms/fold-v1.md, Sections 4.1 and 4.3). Kind VALUE (shape E1) or ROW with a role (shapes E2 to E5). Both ends belong to statementRef. Generated from the schema definition MicroEdge 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	MicroEdge.Builder Collects the members of a new MicroEdge.

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<MicroEdge>	READER Reads a JSON object as a MicroEdge.
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 MicroEdge.Builder	builder()
static MicroEdge	fromJson(Object json) A MicroEdge with the members of a JSON object, all kept.
List<Long>	getDiagnosticRefs() The member diagnosticRefs.
String	getEffect() The member effect.
Map<String,Extension>	getExtensions() The member extensions.
String	getKind() The member kind.
String	getProofStatus() The member proofStatus.
Long	getRef() The member ref.
String	getReferencePath() The member referencePath.
Position	getReferenceStart() The member referenceStart.
String	getRole() The member role.
Binding	getSourceBinding() The member sourceBinding.
Long	getSourceRef() The member sourceRef.
Long	getStatementRef() The member statementRef.
Binding	getTargetBinding() The member targetBinding.
Long	getTargetRef() The member targetRef.
MicroEdge.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<MicroEdge> READER

Reads a JSON object as a MicroEdge.

Method Detail

fromJson

public static MicroEdge fromJson(Object json)

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

builder

public static MicroEdge.Builder builder()

toBuilder

public MicroEdge.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. VALUE or ROW (registry group factKinds); other kinds are not micro-edges. Null when absent; throws IllegalStateException when the member holds another JSON type.

getRole

public String getRole()

The member role. The role of a ROW Fact. Registry group 'rowRoles' (Section 3.3). 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.

getSourceRef

public Long getSourceRef()

The member sourceRef. An Endpoint, an ExplainGraph node, or the candidate set of an UNRESOLVED reference. 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.

getTargetRef

public Long getTargetRef()

The member targetRef. An Endpoint or an ExplainGraph node other than a TERMINAL node. 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.

getReferencePath

public String getReferencePath()

The member referencePath. The semantic path of the name reference the edge reads (when it has a sourceBinding), otherwise of the reference it writes. Gives the Occurrence path. 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.

getReferenceStart

public Position getReferenceStart()

The member referenceStart. The start of that reference in the statement's source unit. Orders Occurrences on one path; never part of a key. Null when absent; throws IllegalStateException when the member holds another JSON type.

getSourceBinding

public Binding getSourceBinding()

The member sourceBinding. The binding of the reference the edge reads; on a first edge, the binding of the kept source. Null when absent; throws IllegalStateException when the member holds another JSON type.

getTargetBinding

public Binding getTargetBinding()

The member targetBinding. The binding of the reference the edge writes; only on an edge into a kept target. Null when absent; throws IllegalStateException when the member holds another JSON type.

getProofStatus

public String getProofStatus()

The member proofStatus. ASSUMED when the producer could not prove the edge (for example an edge that a dynamic SQL hole may affect); absent means PROVEN. The proof status of an Occurrence. Registry group 'proofStatus' (Section 4.1). Null when absent; throws IllegalStateException when the member holds another JSON type.

getEffect

public String getEffect()

The member effect. Display and refinement only; the fold never reads it. An effect carried by a micro-edge or a refinement record. Registry group 'valueEffects' (Sections 7.1 and 18, item 8). 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.