package gudusoft.gsqlparser.lineage.v2.model;

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

/**
 * A unit of input text (Sections 7.8 and 12). A unit whose analysis failed is still recorded, as a
 * placeholder with analysisCompleteness FAILED (Section 6.5). Generated from the schema definition
 * SourceUnit by scripts/sqllr/gen_type_model.py; do not edit.
 *
 * @since 4.2.17
 */
public final class SourceUnit extends SqllrObject {

    /** The members the schema defines, in schema order. */
    public static final List<String> MEMBERS = Collections.unmodifiableList(Arrays.asList("ref", "identityKind", "unitId", "analysisContextRef", "analysisContextId", "namespace", "logicalName", "contextDomain", "uri", "originKind", "parentUnitRef", "sitePath", "siteSpan", "originMapping", "derivedTextStatus", "digests", "resolutionInputDigests", "contentDigest", "siteStatementRef", "siteOrdinal", "variantOrdinal", "originMap", "decoding", "text", "analysisCompleteness", "featureCompleteness", "diagnosticRefs", "extensions"));

    /** The members the schema requires. */
    public static final List<String> REQUIRED = Collections.unmodifiableList(Arrays.<String>asList("ref", "identityKind", "analysisContextRef", "originKind", "analysisCompleteness"));

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

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

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

    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 identityKind}. The kind of a source unit identity. Registry group
     * 'sourceUnitIdentityKinds' (Section 7.8). Null when absent; throws IllegalStateException when
     * the member holds another JSON type.
     */
    public String getIdentityKind() {
        return string("identityKind");
    }

    /**
     * The member {@code unitId}. The portable source unit id; absent for LOCAL units (identity
     * stage: ID_MISSING when a NAMED or CONTENT_ADDRESSED unit omits it). An id computed by
     * SourceUnitIdV1: 'su1-' 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 getUnitId() {
        return string("unitId");
    }

    /**
     * The member {@code analysisContextRef}. The analysis context under which the document asserts
     * the content of this unit (an object of analysisContexts). A merged document holds one source
     * unit record per unit and context. 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 getAnalysisContextRef() {
        return integer("analysisContextRef");
    }

    /**
     * The member {@code analysisContextId}. AnalysisContextV1 of this unit: the manifest of its
     * analysis context, its decoding, its version digest selected by algorithms/identity-v1.md,
     * Section 5.5, and its resolution input digests. Present when the unit has a unitId and at
     * least one digest (identity stage: ID_MISSING / ID_UNEXPECTED). An id computed by
     * AnalysisContextV1: 'actx1-' followed by 64 lowercase hexadecimal characters of a SHA-256
     * digest (algorithms/identity-v1.md). The digest of the analysis context of one source unit.
     * Null when absent; throws IllegalStateException when the member holds another JSON type.
     */
    public String getAnalysisContextId() {
        return string("analysisContextId");
    }

    /**
     * The member {@code namespace}. The caller-provided namespace, such as a repository (NAMED
     * units). Null when absent; throws IllegalStateException when the member holds another JSON
     * type.
     */
    public String getNamespace() {
        return string("namespace");
    }

    /**
     * The member {@code logicalName}. The caller-provided name within the namespace, such as a path
     * relative to the repository (NAMED units). Never an absolute local path. Null when absent;
     * throws IllegalStateException when the member holds another JSON type.
     */
    public String getLogicalName() {
        return string("logicalName");
    }

    /**
     * The member {@code contextDomain}. The caller-declared context domain of a CONTENT_ADDRESSED
     * unit: the domain within which, by the caller's declaration, equal content is one logical
     * source unit (Section 7.8). An unnamed file without that declaration is a LOCAL unit. Null
     * when absent; throws IllegalStateException when the member holds another JSON type.
     */
    public String getContextDomain() {
        return string("contextDomain");
    }

    /**
     * The member {@code uri}. A retrieval location after redaction. Not part of any identity. Null
     * when absent; throws IllegalStateException when the member holds another JSON type.
     */
    public String getUri() {
        return string("uri");
    }

    /**
     * The member {@code originKind}. The origin of a source unit. Registry group
     * 'sourceUnitOriginKinds' (Section 7.8). Null when absent; throws IllegalStateException when
     * the member holds another JSON type.
     */
    public String getOriginKind() {
        return string("originKind");
    }

    /**
     * The member {@code parentUnitRef}. The unit a derived unit was derived from. 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 getParentUnitRef() {
        return integer("parentUnitRef");
    }

    /**
     * The member {@code sitePath}. The semantic path of the execution or expansion site within the
     * parent unit's statement. 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 getSitePath() {
        return string("sitePath");
    }

    /**
     * The member {@code siteSpan}. The location of the execution or expansion site in the parent
     * unit (Section 12.2, rule 1). Null when absent; throws IllegalStateException when the member
     * holds another JSON type.
     */
    public Span getSiteSpan() {
        return typed("siteSpan", Span.READER);
    }

    /**
     * The member {@code originMapping}. Whether a derived source unit is mapped to its parent.
     * Registry group 'originMappingStatus' (Section 7.8). Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public String getOriginMapping() {
        return string("originMapping");
    }

    /**
     * The member {@code derivedTextStatus}. Whether the derived text is proven to be the text the
     * site executes (algorithms/fold-v1.md, Section 7.3). Required for a derived unit. Whether the
     * text of a derived source unit is proven. Registry group 'derivedTextStatus' (Sections 7.8 and
     * 11.4). Null when absent; throws IllegalStateException when the member holds another JSON
     * type.
     */
    public String getDerivedTextStatus() {
        return string("derivedTextStatus");
    }

    /**
     * The member {@code digests}. Version digests of the unit, at most one per domain. They
     * identify the version, not the unit; the first present in registry order (RAW_BYTES_SHA256,
     * DECODED_TEXT_SHA256, REDACTED_TEXT_SHA256, KEYED_TOKEN) enters the analysis context. Null
     * when absent; throws IllegalStateException when the member holds another JSON type.
     */
    public List<Digest> getDigests() {
        return typed("digests", listOf(Digest.READER));
    }

    /**
     * The member {@code resolutionInputDigests}. The version digest of every other source unit
     * whose content the analysis read to resolve the names of this unit (its DDL, views, routines,
     * session statements). A producer that cannot tell lists every input unit of the analysis. An
     * input of the analysis context (algorithms/identity-v1.md, Section 5.5). Null when absent;
     * throws IllegalStateException when the member holds another JSON type.
     */
    public List<Digest> getResolutionInputDigests() {
        return typed("resolutionInputDigests", listOf(Digest.READER));
    }

    /**
     * The member {@code contentDigest}. The content digest of a CONTENT_ADDRESSED unit, an input of
     * its identity. Null when absent; throws IllegalStateException when the member holds another
     * JSON type.
     */
    public Digest getContentDigest() {
        return typed("contentDigest", Digest.READER);
    }

    /**
     * The member {@code siteStatementRef}. The statement of the parent unit that contains the
     * execution or expansion site. 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 getSiteStatementRef() {
        return integer("siteStatementRef");
    }

    /**
     * The member {@code siteOrdinal}. The 0-based ordinal of the site on its semantic path. A
     * 0-based ordinal. Null when absent; throws IllegalStateException when the member holds another
     * JSON type.
     */
    public Long getSiteOrdinal() {
        return integer("siteOrdinal");
    }

    /**
     * The member {@code variantOrdinal}. The 0-based ordinal of this text among the texts derived
     * from one site. A 0-based ordinal. Null when absent; throws IllegalStateException when the
     * member holds another JSON type.
     */
    public Long getVariantOrdinal() {
        return integer("variantOrdinal");
    }

    /**
     * The member {@code originMap}. The origin map of a MAPPED derived unit, ordered by position in
     * the derived text. Module exact-spans, defined later. Null when absent; throws
     * IllegalStateException when the member holds another JSON type.
     */
    public List<Map<String, Object>> getOriginMap() {
        return typed("originMap", listOf(OBJECT));
    }

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

    /**
     * The member {@code text}. The embedded text (Section 12.3): the decoded text under FULL, the
     * redacted text under REDACTED; absent under NONE. Never part of any id. Null when absent;
     * throws IllegalStateException when the member holds another JSON type.
     */
    public String getText() {
        return string("text");
    }

    /**
     * The member {@code analysisCompleteness}. 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 diagnosticRefs}. 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 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 SourceUnit}. */
    public static final class Builder extends SqllrObject.Builder<SourceUnit, 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 identityKind}; null removes it. */
        public Builder identityKind(String value) {
            return set("identityKind", value);
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        /** Sets the member {@code text}; null removes it. */
        public Builder text(String value) {
            return set("text", 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 diagnosticRefs}; null removes it. */
        public Builder diagnosticRefs(List<Long> value) {
            return set("diagnosticRefs", value);
        }

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

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