SpotCheckMismatch.java

package gov.nysenate.openleg.model.spotcheck;

import gov.nysenate.openleg.util.StringDiffer;

import java.util.*;

/**
 * Encapsulates basic information about a mismatch between the reference and target content.
 */
public class SpotCheckMismatch
{

    /** An integer id that uniquely identifies this mismatch */
    protected int mismatchId;

    /** The type of mismatch that occurred. */
    protected SpotCheckMismatchType mismatchType;

    /** The status of the mismatch (new, existing, etc.) */
    protected SpotCheckMismatchStatus status = SpotCheckMismatchStatus.NEW;

    /** String representation of the reference data. (e.g. lbdc daybreak content) */
    protected String referenceData;

    /** String representation of the observed data (typically openleg processed content) */
    protected String observedData;

    /** Any details about this mismatch. (Optional) */
    protected String notes;

    /** The ignore status of this mismatch. (Optional) */
    protected SpotCheckMismatchIgnore ignoreStatus;

    /** A list of related issue tracker ids */
    protected LinkedHashSet<String> issueIds = new LinkedHashSet<>();

    /** --- Constructor --- */

    public SpotCheckMismatch(SpotCheckMismatchType mismatchType, Object observedData, Object referenceData) {
        this(mismatchType, String.valueOf(observedData), String.valueOf(referenceData));
    }

    public SpotCheckMismatch(SpotCheckMismatchType mismatchType, String observedData, String referenceData) {
        this(mismatchType, observedData, referenceData, "");
    }

    public SpotCheckMismatch(SpotCheckMismatchType mismatchType, String observedData, String referenceData, String notes) {
        this.mismatchType = mismatchType;
        this.referenceData = referenceData == null ? "" : referenceData;
        this.observedData = observedData == null ? "" : observedData;
        this.notes = notes;
    }

    /** --- Methods --- */

    /**
     * Computes the difference between the reference and target data.
     *
     * @param simple boolean - Set to true to make the results of the diff less granular.
     * @return LinkedList<StringDiffer.Diff>
     */
    public LinkedList<StringDiffer.Diff> getDiff(boolean simple) {
        StringDiffer stringDiffer = new StringDiffer();
        LinkedList<StringDiffer.Diff> diffs = stringDiffer.diff_main(referenceData, observedData);
        if (simple) {
            stringDiffer.diff_cleanupSemantic(diffs);
        }
        return diffs;
    }

    /** --- Functional Getters / Setters --- */

    public boolean isIgnored() {
        return ignoreStatus != null;
    }

    public SpotCheckMismatchTracked getTracked() {
        return SpotCheckMismatchTracked.getFromBoolean(!issueIds.isEmpty());
    }

    public void addIssueId(String issueId) {
        issueIds.add(issueId);
    }

    public List<String> getIssueIds() {
        return new ArrayList<>(issueIds);
    }

    public void setIssueIds(Collection<String> issueIds) {
        this.issueIds = new LinkedHashSet<>(issueIds);
    }

    /** --- Implemented Methods --- */

    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null || getClass() != obj.getClass()) return false;
        final SpotCheckMismatch other = (SpotCheckMismatch) obj;
        return Objects.equals(this.mismatchType, other.mismatchType) &&
               Objects.equals(this.status, other.status) &&
               Objects.equals(this.referenceData, other.referenceData) &&
               Objects.equals(this.observedData, other.observedData) &&
               Objects.equals(this.notes, other.notes);
    }

    @Override
    public int hashCode() {
        return Objects.hash(mismatchType, status, referenceData, observedData, notes);
    }

    /** --- Basic Getters / Setters --- */

    public SpotCheckMismatchType getMismatchType() {
        return mismatchType;
    }

    public SpotCheckMismatchStatus getStatus() {
        return status;
    }

    public void setStatus(SpotCheckMismatchStatus status) {
        this.status = status;
    }

    public String getReferenceData() {
        return referenceData;
    }

    public String getObservedData() {
        return observedData;
    }

    public String getNotes() {
        return notes;
    }

    public SpotCheckMismatchIgnore getIgnoreStatus() {
        return ignoreStatus;
    }

    public void setIgnoreStatus(SpotCheckMismatchIgnore ignoreStatus) {
        this.ignoreStatus = ignoreStatus;
    }

    public int getMismatchId() {
        return mismatchId;
    }

    public void setMismatchId(int mismatchId) {
        this.mismatchId = mismatchId;
    }
}