/*-
 * #%L
 * HAPI FHIR JPA Server
 * %%
 * Copyright (C) 2014 - 2023 Smile CDR, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package ca.uhn.fhir.jpa.entity;

import ca.uhn.fhir.jpa.model.dao.JpaPid;
import ca.uhn.fhir.jpa.model.entity.AuditableBasePartitionable;
import ca.uhn.fhir.jpa.model.entity.ResourceTable;
import ca.uhn.fhir.mdm.api.IMdmLink;
import ca.uhn.fhir.mdm.api.MdmLinkSourceEnum;
import ca.uhn.fhir.mdm.api.MdmMatchResultEnum;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.hibernate.envers.AuditTable;
import org.hibernate.envers.Audited;
import org.hibernate.envers.NotAudited;

import java.util.Date;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.FetchType;
import javax.persistence.ForeignKey;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Index;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.UniqueConstraint;

@Entity
@Table(
                name = "MPI_LINK",
                uniqueConstraints = {
                        // TODO GGG DROP this index, and instead use the below one
                        @UniqueConstraint(
                                        name = "IDX_EMPI_PERSON_TGT",
                                        columnNames = {"PERSON_PID", "TARGET_PID"}),
                        // TODO GGG Should i make individual indices for PERSON/TARGET?
                },
                indexes = {
                        @Index(name = "IDX_EMPI_MATCH_TGT_VER", columnList = "MATCH_RESULT, TARGET_PID, VERSION"),
                        // v---- this one
                        @Index(name = "IDX_EMPI_GR_TGT", columnList = "GOLDEN_RESOURCE_PID, TARGET_PID"),
                        @Index(name = "FK_EMPI_LINK_TARGET", columnList = "TARGET_PID")
                })
@Audited
// This is the table name generated by default by envers, but we set it explicitly for clarity
@AuditTable("MPI_LINK_AUD")
public class MdmLink extends AuditableBasePartitionable implements IMdmLink<JpaPid> {
        public static final int VERSION_LENGTH = 16;
        private static final int MATCH_RESULT_LENGTH = 16;
        private static final int LINK_SOURCE_LENGTH = 16;
        public static final int SOURCE_TYPE_LENGTH = 40;

        @SequenceGenerator(name = "SEQ_EMPI_LINK_ID", sequenceName = "SEQ_EMPI_LINK_ID")
        @GeneratedValue(strategy = GenerationType.AUTO, generator = "SEQ_EMPI_LINK_ID")
        @Id
        @Column(name = "PID")
        private Long myId;

        @ManyToOne(
                        optional = false,
                        fetch = FetchType.LAZY,
                        cascade = {})
        @JoinColumn(
                        name = "GOLDEN_RESOURCE_PID",
                        referencedColumnName = "RES_ID",
                        foreignKey = @ForeignKey(name = "FK_EMPI_LINK_GOLDEN_RESOURCE"),
                        insertable = false,
                        updatable = false,
                        nullable = false)
        @NotAudited
        private ResourceTable myGoldenResource;

        @Column(name = "GOLDEN_RESOURCE_PID", nullable = false)
        private Long myGoldenResourcePid;

        @Deprecated
        @ManyToOne(
                        optional = false,
                        fetch = FetchType.LAZY,
                        cascade = {})
        @JoinColumn(
                        name = "PERSON_PID",
                        referencedColumnName = "RES_ID",
                        foreignKey = @ForeignKey(name = "FK_EMPI_LINK_PERSON"),
                        insertable = false,
                        updatable = false,
                        nullable = false)
        @NotAudited
        private ResourceTable myPerson;

        @Deprecated
        @Column(name = "PERSON_PID", nullable = false)
        private Long myPersonPid;

        @ManyToOne(
                        optional = false,
                        fetch = FetchType.LAZY,
                        cascade = {})
        @JoinColumn(
                        name = "TARGET_PID",
                        referencedColumnName = "RES_ID",
                        foreignKey = @ForeignKey(name = "FK_EMPI_LINK_TARGET"),
                        insertable = false,
                        updatable = false,
                        nullable = false)
        @NotAudited
        private ResourceTable mySource;

        @Column(name = "TARGET_PID", updatable = false, nullable = false)
        private Long mySourcePid;

        @Column(name = "MATCH_RESULT", nullable = false)
        @Enumerated(EnumType.ORDINAL)
        private MdmMatchResultEnum myMatchResult;

        @Column(name = "LINK_SOURCE", nullable = false)
        @Enumerated(EnumType.ORDINAL)
        private MdmLinkSourceEnum myLinkSource;

        @Temporal(TemporalType.TIMESTAMP)
        @Column(name = "CREATED", nullable = false)
        private Date myCreated;

        @Temporal(TemporalType.TIMESTAMP)
        @Column(name = "UPDATED", nullable = false)
        private Date myUpdated;

        @Column(name = "VERSION", nullable = false, length = VERSION_LENGTH)
        private String myVersion;

        /** This link was created as a result of an eid match **/
        @Column(name = "EID_MATCH")
        private Boolean myEidMatch;

        /** This link created a new person **/
        @Column(name = "NEW_PERSON")
        private Boolean myHadToCreateNewGoldenResource;

        @Column(name = "VECTOR")
        private Long myVector;

        @Column(name = "SCORE")
        private Double myScore;

        // TODO GGG GL-1340
        @Column(name = "RULE_COUNT")
        private Long myRuleCount;

        public MdmLink() {}

        public MdmLink(String theVersion) {
                myVersion = theVersion;
        }

        @Column(name = "TARGET_TYPE", nullable = true, length = SOURCE_TYPE_LENGTH)
        private String myMdmSourceType;

        @Override
        public JpaPid getId() {
                return JpaPid.fromId(myId);
        }

        @Override
        public MdmLink setId(JpaPid theId) {
                myId = theId.getId();
                return this;
        }

        @Override
        public JpaPid getGoldenResourcePersistenceId() {
                return JpaPid.fromId(myGoldenResourcePid);
        }

        @Override
        public IMdmLink setGoldenResourcePersistenceId(JpaPid theGoldenResourcePid) {
                Long longPid = theGoldenResourcePid.getId();
                setPersonPid(longPid);

                myGoldenResourcePid = longPid;
                return this;
        }

        @Override
        public JpaPid getSourcePersistenceId() {
                return JpaPid.fromId(mySourcePid);
        }

        @Override
        public IMdmLink setSourcePersistenceId(JpaPid theSourcePid) {
                mySourcePid = theSourcePid.getId();
                return this;
        }

        public ResourceTable getGoldenResource() {
                return myGoldenResource;
        }

        public MdmLink setGoldenResource(ResourceTable theGoldenResource) {
                myGoldenResource = theGoldenResource;
                myGoldenResourcePid = theGoldenResource.getId();

                myPerson = theGoldenResource;
                myPersonPid = theGoldenResource.getId();

                return this;
        }

        @Deprecated
        public Long getGoldenResourcePid() {
                return myGoldenResourcePid;
        }

        /**
         * @deprecated  Use {@link #setGoldenResourcePid(Long)} instead
         */
        @Deprecated
        public MdmLink setPersonPid(Long thePersonPid) {
                myPersonPid = thePersonPid;
                return this;
        }

        /**
         * @deprecated  Use {@link #setGoldenResourcePersistenceId(JpaPid)} instead
         */
        @Deprecated
        public MdmLink setGoldenResourcePid(Long theGoldenResourcePid) {
                setPersonPid(theGoldenResourcePid);

                myGoldenResourcePid = theGoldenResourcePid;
                return this;
        }

        public ResourceTable getSource() {
                return mySource;
        }

        public MdmLink setSource(ResourceTable theSource) {
                mySource = theSource;
                mySourcePid = theSource.getId();
                return this;
        }

        @Deprecated
        public Long getSourcePid() {
                return mySourcePid;
        }

        /**
         * @deprecated  Use {@link #setSourcePersistenceId(JpaPid)} instead
         */
        @Deprecated
        public MdmLink setSourcePid(Long theSourcePid) {
                mySourcePid = theSourcePid;
                return this;
        }

        @Override
        public MdmMatchResultEnum getMatchResult() {
                return myMatchResult;
        }

        @Override
        public MdmLink setMatchResult(MdmMatchResultEnum theMatchResult) {
                myMatchResult = theMatchResult;
                return this;
        }

        @Override
        public MdmLinkSourceEnum getLinkSource() {
                return myLinkSource;
        }

        @Override
        public MdmLink setLinkSource(MdmLinkSourceEnum theLinkSource) {
                myLinkSource = theLinkSource;
                return this;
        }

        @Override
        public Date getCreated() {
                return myCreated;
        }

        @Override
        public MdmLink setCreated(Date theCreated) {
                myCreated = theCreated;
                return this;
        }

        @Override
        public Date getUpdated() {
                return myUpdated;
        }

        @Override
        public MdmLink setUpdated(Date theUpdated) {
                myUpdated = theUpdated;
                return this;
        }

        @Override
        public String getVersion() {
                return myVersion;
        }

        @Override
        public MdmLink setVersion(String theVersion) {
                myVersion = theVersion;
                return this;
        }

        @Override
        public Long getVector() {
                return myVector;
        }

        @Override
        public MdmLink setVector(Long theVector) {
                myVector = theVector;
                return this;
        }

        @Override
        public Double getScore() {
                return myScore;
        }

        @Override
        public MdmLink setScore(Double theScore) {
                myScore = theScore;
                return this;
        }

        public Boolean getEidMatch() {
                return myEidMatch;
        }

        /**
         * Note that this method can not be called <code>getEidMatch</code> or
         * <code>isEidMatch</code> because Hibernate Search complains about having
         * 2 accessors for this property
         */
        @Override
        public Boolean isEidMatchPresent() {
                return myEidMatch != null && myEidMatch;
        }

        @Override
        public MdmLink setEidMatch(Boolean theEidMatch) {
                myEidMatch = theEidMatch;
                return this;
        }

        @Override
        public Boolean getHadToCreateNewGoldenResource() {
                return myHadToCreateNewGoldenResource != null && myHadToCreateNewGoldenResource;
        }

        @Override
        public MdmLink setHadToCreateNewGoldenResource(Boolean theHadToCreateNewResource) {
                myHadToCreateNewGoldenResource = theHadToCreateNewResource;
                return this;
        }

        public MdmLink setMdmSourceType(String mdmSourceType) {
                myMdmSourceType = mdmSourceType;
                return this;
        }

        @Override
        public String toString() {
                return new ToStringBuilder(this)
                                .append("myId", myId)
                                .append("myGoldenResource", myGoldenResourcePid)
                                .append("mySourcePid", mySourcePid)
                                .append("myMdmSourceType", myMdmSourceType)
                                .append("myMatchResult", myMatchResult)
                                .append("myLinkSource", myLinkSource)
                                .append("myEidMatch", myEidMatch)
                                .append("myHadToCreateNewResource", myHadToCreateNewGoldenResource)
                                .append("myScore", myScore)
                                .append("myRuleCount", myRuleCount)
                                .append("myPartitionId", getPartitionId())
                                .toString();
        }

        public String getMdmSourceType() {
                return myMdmSourceType;
        }

        public Long getRuleCount() {
                return myRuleCount;
        }

        public MdmLink setRuleCount(Long theRuleCount) {
                myRuleCount = theRuleCount;
                return this;
        }
}