gudusoft.gsqlparser.lineage.v2.model

Class ExplainGraph

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.ExplainGraph

public final class ExplainGraph
extends SqllrObject

The ExplainGraph of the document (Sections 3.4, 3.5 and 7.7). Module explain; folded into the Fact layer by FOLD-V1 (algorithms/fold-v1.md). Nodes, micro-edges, candidate sets and support paths share the document's reference space. A micro-edge end is an Endpoint of the document (a kept node), an ExplainGraph node (a folded or TERMINAL node), or, only as the source of an UNRESOLVED reference, a candidate set of this graph. Generated from the schema definition ExplainGraph 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	ExplainGraph.Builder Collects the members of a new ExplainGraph.

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<ExplainGraph>	READER Reads a JSON object as a ExplainGraph.
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 ExplainGraph.Builder	builder()
static ExplainGraph	fromJson(Object json) A ExplainGraph with the members of a JSON object, all kept.
List<CandidateSet>	getCandidateSets() The member candidateSets.
String	getCompleteness() The member completeness.
Map<String,Extension>	getExtensions() The member extensions.
List<MicroEdge>	getMicroEdges() The member microEdges.
List<ExplainNode>	getNodes() The member nodes.
List<ExplainStatementCompleteness>	getStatementCompleteness() The member statementCompleteness.
List<SupportPath>	getSupportPaths() The member supportPaths.
ExplainGraph.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<ExplainGraph> READER

Reads a JSON object as a ExplainGraph.

Method Detail

fromJson

public static ExplainGraph fromJson(Object json)

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

builder

public static ExplainGraph.Builder builder()

toBuilder

public ExplainGraph.Builder toBuilder()

A builder holding every member of this object.

getCompleteness

public String getCompleteness()

The member completeness. The completeness of the graph of every statement that statementCompleteness does not list. COMPLETE: folding yields every Fact Occurrence and FactCandidate of those statements. Completeness declared by an ExplainGraph. Registry group 'explainGraphCompleteness' (Section 3.5). Null when absent; throws IllegalStateException when the member holds another JSON type.

getStatementCompleteness

public List<ExplainStatementCompleteness> getStatementCompleteness()

The member statementCompleteness. Completeness of the graph of individual statements, where it differs from completeness. Null when absent; throws IllegalStateException when the member holds another JSON type.

getNodes

public List<ExplainNode> getNodes()

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

getMicroEdges

public List<MicroEdge> getMicroEdges()

The member microEdges. 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 and unresolved references of the graph (algorithms/fold-v1.md, Section 4.3). Null when absent; throws IllegalStateException when the member holds another JSON type.

getSupportPaths

public List<SupportPath> getSupportPaths()

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