package gudusoft.gsqlparser.lineage.v2.model;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;

/**
 * A node of the ExplainGraph: an intermediate result set, its ROW_SET and column nodes, a function,
 * CASE or expression node, or a TERMINAL input (Section 7.7; algorithms/fold-v1.md, Section 3).
 * Never an endpoint identity. Generated from the schema definition ExplainNode by
 * scripts/sqllr/gen_type_model.py; do not edit.
 *
 * @since 4.2.17
 */
public final class ExplainNode extends SqllrObject {

    /** The members the schema defines, in schema order. */
    public static final List<String> MEMBERS = Collections.unmodifiableList(Arrays.asList("ref", "kind", "role", "statementRef", "parentRef", "ownerRef", "path", "ordinal", "span", "cteName", "alias", "inputKind", "disclosure", "literal", "token", "parameterText", "parameterOrdinal", "upstreamCompleteness", "diagnosticRefs", "key", "recordId", "extensions"));

    /** The members the schema requires. */
    public static final List<String> REQUIRED = Collections.unmodifiableList(Arrays.<String>asList("ref", "kind", "statementRef", "path", "ordinal", "span"));

    /** Reads a JSON object as a {@code ExplainNode}. */
    public static final Reader<ExplainNode> READER = new Reader<ExplainNode>() {
        @Override
        public ExplainNode read(Object json) {
            return fromJson(json);
        }
    };

    private ExplainNode(Map<String, Object> members) {
        super(members);
    }

    /** A {@code ExplainNode} with the members of a JSON object, all kept. */
    public static ExplainNode fromJson(Object json) {
        return new ExplainNode(members(json, "ExplainNode"));
    }

    public static Builder builder() {
        return new Builder(null);
    }

    /** A builder holding every member of this object. */
    public Builder toBuilder() {
        return new Builder(toJson());
    }

    /**
     * The member {@code 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.
     */
    public Long getRef() {
        return integer("ref");
    }

    /**
     * The member {@code kind}. The kind of an ExplainGraph node. Registry group 'explainNodeKinds'
     * (Section 7.7, item 2). Null when absent; throws IllegalStateException when the member holds
     * another JSON type.
     */
    public String getKind() {
        return string("kind");
    }

    /**
     * The member {@code role}. The role of an ExplainGraph node. Registry group 'explainNodeRoles'
     * (Section 7.7, item 2). Null when absent; throws IllegalStateException when the member holds
     * another JSON type.
     */
    public String getRole() {
        return string("role");
    }

    /**
     * The member {@code 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.
     */
    public Long getStatementRef() {
        return integer("statementRef");
    }

    /**
     * The member {@code parentRef}. The enclosing node: the query block in which a subquery is
     * nested, the result set whose CTE body this is (Section 7.7, item 1). 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.
     */
    public Long getParentRef() {
        return integer("parentRef");
    }

    /**
     * The member {@code ownerRef}. FIELD and ROW_SET nodes: the result-set node they belong to. 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.
     */
    public Long getOwnerRef() {
        return integer("ownerRef");
    }

    /**
     * The member {@code path}. The semantic path of the query block that owns the node; for a FIELD
     * or ROW_SET node, the path of its result set (algorithms/identity-v1.md, Section 5.7). 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.
     */
    public String getPath() {
        return string("path");
    }

    /**
     * The member {@code ordinal}. For a FIELD node, the column ordinal (select-list position;
     * positional pairing for set operations), 0..n-1 within its result set. Otherwise the rank
     * among nodes of the same kind on the same path, by span start, the outer node first
     * (algorithms/identity-v1.md, Section 5.7). A 0-based ordinal. Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public Long getOrdinal() {
        return integer("ordinal");
    }

    /**
     * The member {@code span}. The fragment of the original SQL (Section 7.7, item 5); for a
     * ROW_SET node, the fragment of the query block stage it stands for. Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public Span getSpan() {
        return typed("span", Span.READER);
    }

    /**
     * The member {@code cteName}. Label only: the CTE name as written. Never an identity or a path
     * step. Null when absent; throws IllegalStateException when the member holds another JSON type.
     */
    public String getCteName() {
        return string("cteName");
    }

    /**
     * The member {@code alias}. Label only: the alias as written. Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public String getAlias() {
        return string("alias");
    }

    /**
     * The member {@code inputKind}. TERMINAL nodes: the kind of input (never FIELD_REF). 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.
     */
    public String getInputKind() {
        return string("inputKind");
    }

    /**
     * The member {@code disclosure}. TERMINAL CONSTANT nodes: how the literal is carried. 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.
     */
    public String getDisclosure() {
        return string("disclosure");
    }

    /**
     * The member {@code literal}. TERMINAL CONSTANT with disclosure PRESENT: the literal as
     * written, after redaction. Null when absent; throws IllegalStateException when the member
     * holds another JSON type.
     */
    public String getLiteral() {
        return string("literal");
    }

    /**
     * The member {@code token}. TERMINAL CONSTANT with disclosure HASHED. Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public KeyedToken getToken() {
        return typed("token", KeyedToken.READER);
    }

    /**
     * The member {@code parameterText}. TERMINAL PARAMETER: the parameter marker or name as written
     * (a bind, positional or host parameter the input does not declare); it becomes the
     * parameterText of the write input (algorithms/fold-v1.md, Section 7.5). Null when absent;
     * throws IllegalStateException when the member holds another JSON type.
     */
    public String getParameterText() {
        return string("parameterText");
    }

    /**
     * The member {@code parameterOrdinal}. TERMINAL PARAMETER with parameterText "?": the position
     * of the anonymous marker among the statement's anonymous markers, 0-based in text order; it
     * becomes the parameterOrdinal of the write input (algorithms/fold-v1.md, Section 7.5). A
     * 0-based ordinal. Null when absent; throws IllegalStateException when the member holds another
     * JSON type.
     */
    public Long getParameterOrdinal() {
        return integer("parameterOrdinal");
    }

    /**
     * The member {@code upstreamCompleteness}. Whether the inputs of this node are completely
     * known; absent means COMPLETE (algorithms/fold-v1.md, Section 7.4). Upstream completeness of
     * one write. Registry group 'upstreamCompleteness' (Section 4.4). Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public String getUpstreamCompleteness() {
        return string("upstreamCompleteness");
    }

    /**
     * The member {@code diagnosticRefs}. The diagnostics that lowered upstreamCompleteness. A set
     * of local references. Null when absent; throws IllegalStateException when the member holds
     * another JSON type.
     */
    public List<Long> getDiagnosticRefs() {
        return typed("diagnosticRefs", listOf(INTEGER));
    }

    /**
     * The member {@code key}. The logical node key; absent when the source unit has no unitId. An
     * id computed by ExplainNodeKeyV1: 'xnk1-' 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.
     */
    public String getKey() {
        return string("key");
    }

    /**
     * The member {@code recordId}. The node record id; absent when key or the unit's
     * analysisContextId is absent. An id computed by ExplainNodeRecordIdV1: 'xnr1-' 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.
     */
    public String getRecordId() {
        return string("recordId");
    }

    /**
     * The member {@code 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.
     */
    public Map<String, Extension> getExtensions() {
        return typed("extensions", mapOf(Extension.READER));
    }

    /** Collects the members of a new {@code ExplainNode}. */
    public static final class Builder extends SqllrObject.Builder<ExplainNode, Builder> {
        private Builder(Map<String, Object> from) {
            super(from);
        }

        /** Sets the member {@code ref}; null removes it. */
        public Builder ref(Long value) {
            return set("ref", value);
        }

        /** Sets the member {@code kind}; null removes it. */
        public Builder kind(String value) {
            return set("kind", value);
        }

        /** Sets the member {@code role}; null removes it. */
        public Builder role(String value) {
            return set("role", value);
        }

        /** Sets the member {@code statementRef}; null removes it. */
        public Builder statementRef(Long value) {
            return set("statementRef", value);
        }

        /** Sets the member {@code parentRef}; null removes it. */
        public Builder parentRef(Long value) {
            return set("parentRef", value);
        }

        /** Sets the member {@code ownerRef}; null removes it. */
        public Builder ownerRef(Long value) {
            return set("ownerRef", value);
        }

        /** Sets the member {@code path}; null removes it. */
        public Builder path(String value) {
            return set("path", value);
        }

        /** Sets the member {@code ordinal}; null removes it. */
        public Builder ordinal(Long value) {
            return set("ordinal", value);
        }

        /** Sets the member {@code span}; null removes it. */
        public Builder span(Span value) {
            return set("span", value);
        }

        /** Sets the member {@code cteName}; null removes it. */
        public Builder cteName(String value) {
            return set("cteName", value);
        }

        /** Sets the member {@code alias}; null removes it. */
        public Builder alias(String value) {
            return set("alias", value);
        }

        /** Sets the member {@code inputKind}; null removes it. */
        public Builder inputKind(String value) {
            return set("inputKind", value);
        }

        /** Sets the member {@code disclosure}; null removes it. */
        public Builder disclosure(String value) {
            return set("disclosure", value);
        }

        /** Sets the member {@code literal}; null removes it. */
        public Builder literal(String value) {
            return set("literal", value);
        }

        /** Sets the member {@code token}; null removes it. */
        public Builder token(KeyedToken value) {
            return set("token", value);
        }

        /** Sets the member {@code parameterText}; null removes it. */
        public Builder parameterText(String value) {
            return set("parameterText", value);
        }

        /** Sets the member {@code parameterOrdinal}; null removes it. */
        public Builder parameterOrdinal(Long value) {
            return set("parameterOrdinal", value);
        }

        /** Sets the member {@code upstreamCompleteness}; null removes it. */
        public Builder upstreamCompleteness(String value) {
            return set("upstreamCompleteness", value);
        }

        /** Sets the member {@code diagnosticRefs}; null removes it. */
        public Builder diagnosticRefs(List<Long> value) {
            return set("diagnosticRefs", value);
        }

        /** Sets the member {@code key}; null removes it. */
        public Builder key(String value) {
            return set("key", value);
        }

        /** Sets the member {@code recordId}; null removes it. */
        public Builder recordId(String value) {
            return set("recordId", value);
        }

        /** Sets the member {@code extensions}; null removes it. */
        public Builder extensions(Map<String, Extension> value) {
            return set("extensions", value);
        }

        @Override
        public ExplainNode build() {
            return new ExplainNode(frozenMembers());
        }
    }
}