gudusoft.gsqlparser.lineage.v2.model

Class CandidateSet

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.CandidateSet

public final class CandidateSet
extends SqllrObject

The possible bindings of one unresolved or ambiguous reference (Sections 3.2 and 4.3), or, at an end of a FactCandidate that the fold derives, the endpoints its outcomes reach (algorithms/fold-v1.md, Section 7.1). A producer never picks one of them. Membership COMPLETE: the reference denotes one of the members, and there are at least two. Membership INCOMPLETE: it may also denote something not listed; any number of members, none for an UNRESOLVED reference (semantic stage: SEMANTIC_CANDIDATE_SET_INVALID). Generated from the schema definition CandidateSet 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	CandidateSet.Builder Collects the members of a new CandidateSet.

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<CandidateSet>	READER Reads a JSON object as a CandidateSet.
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 CandidateSet.Builder	builder()
static CandidateSet	fromJson(Object json) A CandidateSet with the members of a JSON object, all kept.
List<Long>	getCandidateRefs() The member candidateRefs.
CandidateDecision	getDecidedBy() The member decidedBy.
Map<String,Object>	getDetails() The member details.
Map<String,Extension>	getExtensions() The member extensions.
String	getMembership() The member membership.
Long	getRef() The member ref.
String	getWrittenText() The member writtenText.
CandidateSet.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<CandidateSet> READER

Reads a JSON object as a CandidateSet.

Method Detail

fromJson

public static CandidateSet fromJson(Object json)

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

builder

public static CandidateSet.Builder builder()

toBuilder

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

getCandidateRefs

public List<Long> getCandidateRefs()

The member candidateRefs. Endpoints the reference may denote; empty for an UNRESOLVED reference. In explainGraph.candidateSets, the candidates of a reference to a column of an intermediate result are ExplainGraph nodes. Null when absent; throws IllegalStateException when the member holds another JSON type.

getMembership

public String getMembership()

The member membership. Whether a candidate set lists every possible binding. Registry group 'candidateSetCompleteness' (Sections 3.2 and 4.3). Null when absent; throws IllegalStateException when the member holds another JSON type.

getWrittenText

public String getWrittenText()

The member writtenText. The reference as written, after redaction. Null when absent; throws IllegalStateException when the member holds another JSON type.

getDecidedBy

public CandidateDecision getDecidedBy()

The member decidedBy. In explainGraph.candidateSets and at the ends of FactCandidates, never in the document's candidateSets: the reference is decided by another reference, and the set says how (algorithms/fold-v1.md, Sections 4.3 and 7.1). Null when absent; throws IllegalStateException when the member holds another JSON type.

getDetails

public Map<String,Object> getDetails()

The member details. Candidate set details. Module evidence, defined later; open. 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.