package gudusoft.gsqlparser.lineage.v2.model;

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

/**
 * A SQL-LR lineage document (specification Section 6). Generated from the schema root by
 * scripts/sqllr/gen_type_model.py; do not edit.
 *
 * @since 4.2.17
 */
public final class Document extends SqllrObject {

    /** The members the schema defines, in schema order. */
    public static final List<String> MEMBERS = Collections.unmodifiableList(Arrays.asList("specUri", "specVersion", "declaredLevel", "modules", "header", "analysisContexts", "sourceUnits", "statements", "scopes", "endpoints", "facts", "factCandidates", "candidateSets", "occurrences", "targetFieldOccurrences", "analysisCompleteness", "featureCompleteness", "servingCompleteness", "diagnostics", "merge", "extensions", "explainGraph", "evidence", "dynamicSqlSites", "expressionSpans", "reproducibilityManifest", "typedSteps", "routineCalls", "wildcardSelections", "structuralSignatures", "refinements", "naryFacts"));

    /** The members the schema requires. */
    public static final List<String> REQUIRED = Collections.unmodifiableList(Arrays.<String>asList("specUri", "specVersion", "declaredLevel", "modules", "header", "analysisContexts", "sourceUnits", "statements", "scopes", "endpoints", "facts", "factCandidates", "occurrences", "targetFieldOccurrences", "analysisCompleteness", "servingCompleteness", "diagnostics"));

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

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

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

    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 specUri}. The permanent URI of the specification, assigned at release. Null
     * when absent; throws IllegalStateException when the member holds another JSON type.
     */
    public String getSpecUri() {
        return string("specUri");
    }

    /**
     * The member {@code specVersion}. The specification version. This schema accepts 0.1.x. Null
     * when absent; throws IllegalStateException when the member holds another JSON type.
     */
    public String getSpecVersion() {
        return string("specVersion");
    }

    /**
     * The member {@code declaredLevel}. A producer conformance level. Registry group 'levels'
     * (Section 5.1). Null when absent; throws IllegalStateException when the member holds another
     * JSON type.
     */
    public String getDeclaredLevel() {
        return string("declaredLevel");
    }

    /**
     * The member {@code modules}. The optional modules the document carries. A consumer never
     * treats a module that is not listed as an empty collection. Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public List<String> getModules() {
        return typed("modules", listOf(STRING));
    }

    /**
     * The member {@code header}. Null when absent; throws IllegalStateException when the member
     * holds another JSON type.
     */
    public Header getHeader() {
        return typed("header", Header.READER);
    }

    /**
     * The member {@code analysisContexts}. The analysis contexts of the document (Sections 6.2 and
     * 9.2). Every source unit names one. Null when absent; throws IllegalStateException when the
     * member holds another JSON type.
     */
    public List<AnalysisContext> getAnalysisContexts() {
        return typed("analysisContexts", listOf(AnalysisContext.READER));
    }

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

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

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

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

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

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

    /**
     * The member {@code candidateSets}. The candidate sets of the ambiguous references at which a
     * Fact keeps an Occurrence (Section 4.3, rule 1): a Fact that holds whichever candidate the
     * reference denotes keeps the reference's CANDIDATE or UNRESOLVED binding, whose
     * candidateSetRef names a set of this array. Its candidates are Endpoints; a candidate that is
     * an ExplainGraph node is not listed, and the set is then INCOMPLETE. It also holds the
     * deciding sets that the decidedBy of FactCandidate ends names (algorithms/fold-v1.md, Section
     * 7.1, item 5): for a call that several routines fit, the ROUTINE endpoints of those routines.
     * 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 occurrences}. Null when absent; throws IllegalStateException when the
     * member holds another JSON type.
     */
    public List<Occurrence> getOccurrences() {
        return typed("occurrences", listOf(Occurrence.READER));
    }

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

    /**
     * The member {@code analysisCompleteness}. Document-scope analysis completeness. Analysis
     * completeness of a scope. Registry group 'analysisCompleteness' (Section 4.4). Null when
     * absent; throws IllegalStateException when the member holds another JSON type.
     */
    public String getAnalysisCompleteness() {
        return string("analysisCompleteness");
    }

    /**
     * The member {@code featureCompleteness}. Feature-scope completeness; one entry per feature.
     * Null when absent; throws IllegalStateException when the member holds another JSON type.
     */
    public List<FeatureCompleteness> getFeatureCompleteness() {
        return typed("featureCompleteness", listOf(FeatureCompleteness.READER));
    }

    /**
     * The member {@code servingCompleteness}. Null when absent; throws IllegalStateException when
     * the member holds another JSON type.
     */
    public ServingCompleteness getServingCompleteness() {
        return typed("servingCompleteness", ServingCompleteness.READER);
    }

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

    /**
     * The member {@code merge}. Merge provenance of a merged document: input digests and the
     * conflict ledger (Sections 9.5 and 15.2). The analysis context of each input, with its
     * dependency snapshot and redaction context, is in analysisContexts. Defined later. Module
     * content, defined later. Open: members are not yet constrained; arrays inside it are SEQUENCE
     * until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when
     * absent; throws IllegalStateException when the member holds another JSON type.
     */
    public Map<String, Object> getMerge() {
        return object("merge");
    }

    /**
     * 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));
    }

    /**
     * The member {@code explainGraph}. The ExplainGraph (Sections 3.4 and 7.7). Module explain.
     * Null when absent; throws IllegalStateException when the member holds another JSON type.
     */
    public ExplainGraph getExplainGraph() {
        return typed("explainGraph", ExplainGraph.READER);
    }

    /**
     * The member {@code evidence}. Evidence objects. Module evidence, defined later. A collection
     * of module content, defined later. Registered as a SET sorted by the ref of its elements;
     * arrays inside its elements are SEQUENCE until the module defines them
     * (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public List<Map<String, Object>> getEvidence() {
        return typed("evidence", listOf(OBJECT));
    }

    /**
     * The member {@code dynamicSqlSites}. Dynamic SQL sites, holes and proofs. Module dynamic-sql,
     * defined later. A collection of module content, defined later. Registered as a SET sorted by
     * the ref of its elements; arrays inside its elements are SEQUENCE until the module defines
     * them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public List<Map<String, Object>> getDynamicSqlSites() {
        return typed("dynamicSqlSites", listOf(OBJECT));
    }

    /**
     * The member {@code expressionSpans}. Expression-level spans. Module exact-spans, defined
     * later. A collection of module content, defined later. Registered as a SET sorted by the ref
     * of its elements; arrays inside its elements are SEQUENCE until the module defines them
     * (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public List<Map<String, Object>> getExpressionSpans() {
        return typed("expressionSpans", listOf(OBJECT));
    }

    /**
     * The member {@code reproducibilityManifest}. All effective analysis options and the metadata
     * digest. Module reproducibility, defined later. Module content, defined later. Open: members
     * are not yet constrained; arrays inside it are SEQUENCE until the module defines them
     * (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public Map<String, Object> getReproducibilityManifest() {
        return object("reproducibilityManifest");
    }

    /**
     * The member {@code typedSteps}. Typed steps and operand groups (Section 7.6). Module
     * typed-steps, defined later. A collection of module content, defined later. Registered as a
     * SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the
     * module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent;
     * throws IllegalStateException when the member holds another JSON type.
     */
    public List<Map<String, Object>> getTypedSteps() {
        return typed("typedSteps", listOf(OBJECT));
    }

    /**
     * The member {@code routineCalls}. Call sites and argument-to-parameter bindings (Section 7.3).
     * Module routines, defined later. A collection of module content, defined later. Registered as
     * a SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the
     * module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent;
     * throws IllegalStateException when the member holds another JSON type.
     */
    public List<Map<String, Object>> getRoutineCalls() {
        return typed("routineCalls", listOf(OBJECT));
    }

    /**
     * The member {@code wildcardSelections}. WildcardSelection objects (Section 7.5). Module
     * wildcards, defined later. A collection of module content, defined later. Registered as a SET
     * sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the module
     * defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public List<Map<String, Object>> getWildcardSelections() {
        return typed("wildcardSelections", listOf(OBJECT));
    }

    /**
     * The member {@code structuralSignatures}. Structural signatures of ExplainGraph nodes. Module
     * structural-signature, defined later. A collection of module content, defined later.
     * Registered as a SET sorted by the ref of its elements; arrays inside its elements are
     * SEQUENCE until the module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5).
     * Null when absent; throws IllegalStateException when the member holds another JSON type.
     */
    public List<Map<String, Object>> getStructuralSignatures() {
        return typed("structuralSignatures", listOf(OBJECT));
    }

    /**
     * The member {@code refinements}. Refinement records (Sections 3.2, rule 4, and 7.1). Module
     * join-semantics, defined later. A collection of module content, defined later. Registered as a
     * SET sorted by the ref of its elements; arrays inside its elements are SEQUENCE until the
     * module defines them (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent;
     * throws IllegalStateException when the member holds another JSON type.
     */
    public List<Map<String, Object>> getRefinements() {
        return typed("refinements", listOf(OBJECT));
    }

    /**
     * The member {@code naryFacts}. N-ary Facts (Section 3.2, rule 3). Module nary-facts, defined
     * later. A collection of module content, defined later. Registered as a SET sorted by the ref
     * of its elements; arrays inside its elements are SEQUENCE until the module defines them
     * (algorithms/canonical-json-v1.md, Section 5, rule 5). Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public List<Map<String, Object>> getNaryFacts() {
        return typed("naryFacts", listOf(OBJECT));
    }

    /** Reads a document with the strict reader of canonical-json-v1 (Section 3); does not validate. */
    public static Document parse(byte[] data) {
        return fromJson(gudusoft.gsqlparser.lineage.v2.json.CanonicalJson.parse(data));
    }

    /** The canonical bytes of the document: RFC 8785, every array in its registered order. */
    public byte[] toBytes() {
        return gudusoft.gsqlparser.lineage.v2.json.CanonicalJson.documentBytes(toJson());
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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