gudusoft.gsqlparser.lineage.v2.model

Class Input

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.Input

public final class Input
extends SqllrObject

One input of a TargetFieldOccurrence (Section 4.4). Generated from the schema definition Input 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	Input.Builder Collects the members of a new Input.

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<Input>	READER Reads a JSON object as a Input.
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 Input.Builder	builder()
static Input	fromJson(Object json) A Input with the members of a JSON object, all kept.
String	getDisclosure() The member disclosure.
Map<String,Extension>	getExtensions() The member extensions.
Long	getFactCandidateRef() The member factCandidateRef.
Long	getFactRef() The member factRef.
String	getKind() The member kind.
String	getLiteral() The member literal.
Long	getParameterOrdinal() The member parameterOrdinal.
Long	getParameterRef() The member parameterRef.
String	getParameterText() The member parameterText.
Long	getSequenceRef() The member sequenceRef.
KeyedToken	getToken() The member token.
Input.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<Input> READER

Reads a JSON object as a Input.

Method Detail

fromJson

public static Input fromJson(Object json)

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

builder

public static Input.Builder builder()

toBuilder

public Input.Builder toBuilder()

A builder holding every member of this object.

getKind

public String getKind()

The member kind. The kind of an input of a TargetFieldOccurrence. Registry group 'inputKinds' (Section 4.4). Null when absent; throws IllegalStateException when the member holds another JSON type.

getFactRef

public Long getFactRef()

The member factRef. FIELD_REF: the Fact (of any kind) through which the field flows. 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. FIELD_REF: the FactCandidate whose target end is or contains the written field; the write is then at most PARTIAL (algorithms/fold-v1.md, Section 7.4). 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.

getDisclosure

public String getDisclosure()

The member disclosure. How the value of a CONSTANT input is carried. Registry group 'constantValueDisclosure' (Section 4.4). Null when absent; throws IllegalStateException when the member holds another JSON type.

getLiteral

public String getLiteral()

The member literal. CONSTANT with disclosure PRESENT: the literal as written, after redaction. Null when absent; throws IllegalStateException when the member holds another JSON type.

getToken

public KeyedToken getToken()

The member token. CONSTANT with disclosure HASHED. Null when absent; throws IllegalStateException when the member holds another JSON type.

getParameterRef

public Long getParameterRef()

The member parameterRef. PARAMETER: the PARAMETER or VARIABLE endpoint. 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.

getParameterText

public String getParameterText()

The member parameterText. PARAMETER: the parameter marker or name as written, when it is not modelled as an endpoint. Null when absent; throws IllegalStateException when the member holds another JSON type.

getParameterOrdinal

public Long getParameterOrdinal()

The member parameterOrdinal. PARAMETER with parameterText "?": the position of the anonymous marker among the statement's anonymous markers, 0-based in text order; two anonymous markers are two parameters (algorithms/fold-v1.md, Section 7.5). A 0-based ordinal. Null when absent; throws IllegalStateException when the member holds another JSON type.

getSequenceRef

public Long getSequenceRef()

The member sequenceRef. SEQUENCE_VALUE: the SEQUENCE endpoint, when known. 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.

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.