package gudusoft.gsqlparser.lineage.v2.model;

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

/**
 * A quarantined proposition whose endpoint binding is not sufficient to publish a Fact (Section
 * 3.2, rule 2). It is not a lower-confidence Fact and is never merged with a Fact. Either end may
 * be a candidate set; outcomes records which sources and targets go together when the ends alone do
 * not (algorithms/fold-v1.md, Section 7.1). Generated from the schema definition FactCandidate by
 * scripts/sqllr/gen_type_model.py; do not edit.
 *
 * @since 4.2.17
 */
public final class FactCandidate extends SqllrObject {

    /** The members the schema defines, in schema order. */
    public static final List<String> MEMBERS = Collections.unmodifiableList(Arrays.asList("ref", "kind", "role", "source", "target", "outcomes", "extensions"));

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

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

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

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

    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}. A Fact kind. Registry group 'factKinds' (Section 3.3). 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 a ROW Fact. Registry group 'rowRoles' (Section 3.3).
     * Null when absent; throws IllegalStateException when the member holds another JSON type.
     */
    public String getRole() {
        return string("role");
    }

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

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

    /**
     * The member {@code outcomes}. The outcomes of the candidate, present only when they are not
     * the implied ones (each pair of a source member and a target member on its own). Each outcome
     * is the set of (source, target) pairs that hold together under one choice of the ambiguous
     * references the candidate depends on; exactly one outcome holds when every candidate-set end
     * is COMPLETE, at most one otherwise (algorithms/fold-v1.md, Section 7.1). Null when absent;
     * throws IllegalStateException when the member holds another JSON type.
     */
    public List<CandidateOutcome> getOutcomes() {
        return typed("outcomes", listOf(CandidateOutcome.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 FactCandidate}. */
    public static final class Builder extends SqllrObject.Builder<FactCandidate, 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 source}; null removes it. */
        public Builder source(CandidateEnd value) {
            return set("source", value);
        }

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

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

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

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