gudusoft.gsqlparser.lineage.v2.model

Class FactCandidate

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.FactCandidate

public final class FactCandidate
extends SqllrObject

A quarantined proposition whose endpoint binding is not sufficient to publish a Fact (Section 3.2, rule 2). It is not a lower-confidence Fact and is never merged with a Fact. Either end may be a candidate set; outcomes records which sources and targets go together when the ends alone do not (algorithms/fold-v1.md, Section 7.1). Generated from the schema definition FactCandidate 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	FactCandidate.Builder Collects the members of a new FactCandidate.

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<FactCandidate>	READER Reads a JSON object as a FactCandidate.
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 FactCandidate.Builder	builder()
static FactCandidate	fromJson(Object json) A FactCandidate with the members of a JSON object, all kept.
Map<String,Extension>	getExtensions() The member extensions.
String	getKind() The member kind.
List<CandidateOutcome>	getOutcomes() The member outcomes.
Long	getRef() The member ref.
String	getRole() The member role.
CandidateEnd	getSource() The member source.
CandidateEnd	getTarget() The member target.
FactCandidate.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<FactCandidate> READER

Reads a JSON object as a FactCandidate.

Method Detail

fromJson

public static FactCandidate fromJson(Object json)

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

builder

public static FactCandidate.Builder builder()

toBuilder

public FactCandidate.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. A Fact kind. Registry group 'factKinds' (Section 3.3). 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.

getSource

public CandidateEnd getSource()

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

getTarget

public CandidateEnd getTarget()

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

getOutcomes

public List<CandidateOutcome> getOutcomes()

The member outcomes. The outcomes of the candidate, present only when they are not the implied ones (each pair of a source member and a target member on its own). Each outcome is the set of (source, target) pairs that hold together under one choice of the ambiguous references the candidate depends on; exactly one outcome holds when every candidate-set end is COMPLETE, at most one otherwise (algorithms/fold-v1.md, Section 7.1). 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.