gudusoft.gsqlparser.lineage.v2.model

Class Occurrence

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.Occurrence

public final class Occurrence
extends SqllrObject

One assertion of a Fact or FactCandidate by one statement in one analysis (Sections 3.1, 4.1, 4.2 and 9.2). Generated from the schema definition Occurrence 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	Occurrence.Builder Collects the members of a new Occurrence.

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<Occurrence>	READER Reads a JSON object as a Occurrence.
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 Occurrence.Builder	builder()
static Occurrence	fromJson(Object json) A Occurrence with the members of a JSON object, all kept.
List<Long>	getDiagnosticRefs() The member diagnosticRefs.
List<Long>	getEvidenceRefs() The member evidenceRefs.
Map<String,Extension>	getExtensions() The member extensions.
Long	getFactCandidateRef() The member factCandidateRef.
Long	getFactRef() The member factRef.
String	getKey() The member key.
Long	getOrdinal() The member ordinal.
String	getPath() The member path.
String	getProofStatus() The member proofStatus.
String	getRecordId() The member recordId.
Long	getRef() The member ref.
Binding	getSourceBinding() The member sourceBinding.
Long	getStatementRef() The member statementRef.
List<Long>	getSupportPathRefs() The member supportPathRefs.
Binding	getTargetBinding() The member targetBinding.
Occurrence.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<Occurrence> READER

Reads a JSON object as a Occurrence.

Method Detail

fromJson

public static Occurrence fromJson(Object json)

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

builder

public static Occurrence.Builder builder()

toBuilder

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

getFactRef

public Long getFactRef()

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

getFactCandidateRef

public Long getFactCandidateRef()

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

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.

getPath

public String getPath()

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

getOrdinal

public Long getOrdinal()

The member ordinal. The 0-based rank of this Occurrence among the Occurrences of the same statement with the same subject (Fact or FactCandidate) and the same path, by the start position of the reference it asserts (algorithms/identity-v1.md, Section 5.4). A 0-based ordinal. Null when absent; throws IllegalStateException when the member holds another JSON type.

getProofStatus

public String getProofStatus()

The member proofStatus. The proof status of an Occurrence. Registry group 'proofStatus' (Section 4.1). Null when absent; throws IllegalStateException when the member holds another JSON type.

getSourceBinding

public Binding getSourceBinding()

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

getTargetBinding

public Binding getTargetBinding()

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

getKey

public String getKey()

The member key. The logical Occurrence key (OccurrenceKeyV1); absent when the source unit has no unitId or the subject has no portable identity. An id computed by OccurrenceKeyV1: 'occk1-' 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.

getRecordId

public String getRecordId()

The member recordId. The assertion record id (OccurrenceRecordIdV1 over key and the source unit's analysisContextId); absent when key or analysisContextId is absent. An id computed by OccurrenceRecordIdV1, the assertion record id: 'occr1-' 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.

getSupportPathRefs

public List<Long> getSupportPathRefs()

The member supportPathRefs. The ExplainGraph support paths that together cover the support subgraph of this Occurrence (algorithms/fold-v1.md, Section 8.2). Module explain. A set of local references. Null when absent; throws IllegalStateException when the member holds another JSON type.

getEvidenceRefs

public List<Long> getEvidenceRefs()

The member evidenceRefs. Evidence objects. Module evidence. A set of local references. 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.