package gudusoft.gsqlparser.lineage.v2.model;

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

/**
 * The ExplainGraph of the document (Sections 3.4, 3.5 and 7.7). Module explain; folded into the
 * Fact layer by FOLD-V1 (algorithms/fold-v1.md). Nodes, micro-edges, candidate sets and support
 * paths share the document's reference space. A micro-edge end is an Endpoint of the document (a
 * kept node), an ExplainGraph node (a folded or TERMINAL node), or, only as the source of an
 * UNRESOLVED reference, a candidate set of this graph. Generated from the schema definition
 * ExplainGraph by scripts/sqllr/gen_type_model.py; do not edit.
 *
 * @since 4.2.17
 */
public final class ExplainGraph extends SqllrObject {

    /** The members the schema defines, in schema order. */
    public static final List<String> MEMBERS = Collections.unmodifiableList(Arrays.asList("completeness", "statementCompleteness", "nodes", "microEdges", "candidateSets", "supportPaths", "extensions"));

    /** The members the schema requires. */
    public static final List<String> REQUIRED = Collections.unmodifiableList(Arrays.<String>asList("completeness", "nodes", "microEdges", "supportPaths"));

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

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

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

    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 completeness}. The completeness of the graph of every statement that
     * statementCompleteness does not list. COMPLETE: folding yields every Fact Occurrence and
     * FactCandidate of those statements. Completeness declared by an ExplainGraph. Registry group
     * 'explainGraphCompleteness' (Section 3.5). Null when absent; throws IllegalStateException when
     * the member holds another JSON type.
     */
    public String getCompleteness() {
        return string("completeness");
    }

    /**
     * The member {@code statementCompleteness}. Completeness of the graph of individual statements,
     * where it differs from completeness. Null when absent; throws IllegalStateException when the
     * member holds another JSON type.
     */
    public List<ExplainStatementCompleteness> getStatementCompleteness() {
        return typed("statementCompleteness", listOf(ExplainStatementCompleteness.READER));
    }

    /**
     * The member {@code nodes}. Null when absent; throws IllegalStateException when the member
     * holds another JSON type.
     */
    public List<ExplainNode> getNodes() {
        return typed("nodes", listOf(ExplainNode.READER));
    }

    /**
     * The member {@code microEdges}. Null when absent; throws IllegalStateException when the member
     * holds another JSON type.
     */
    public List<MicroEdge> getMicroEdges() {
        return typed("microEdges", listOf(MicroEdge.READER));
    }

    /**
     * The member {@code candidateSets}. The candidate sets of the ambiguous and unresolved
     * references of the graph (algorithms/fold-v1.md, Section 4.3). Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public List<CandidateSet> getCandidateSets() {
        return typed("candidateSets", listOf(CandidateSet.READER));
    }

    /**
     * The member {@code supportPaths}. Null when absent; throws IllegalStateException when the
     * member holds another JSON type.
     */
    public List<SupportPath> getSupportPaths() {
        return typed("supportPaths", listOf(SupportPath.READER));
    }

    /**
     * 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 ExplainGraph}. */
    public static final class Builder extends SqllrObject.Builder<ExplainGraph, Builder> {
        private Builder(Map<String, Object> from) {
            super(from);
        }

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

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

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

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

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

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

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

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