/**
 * This file is part of Eclipse Steady.
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * SPDX-FileCopyrightText: Copyright (c) 2018-2020 SAP SE or an SAP affiliate company and Eclipse Steady contributors
 */
package org.eclipse.steady.backend.model;

import java.util.List;

import javax.persistence.CollectionTable;
import javax.persistence.Column;
import javax.persistence.ElementCollection;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OrderColumn;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;

import org.eclipse.steady.shared.enums.PathSource;

import com.fasterxml.jackson.annotation.JsonBackReference;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * <p>Path class.</p>
 */
@JsonInclude(JsonInclude.Include.ALWAYS)
@JsonIgnoreProperties(
    ignoreUnknown = true,
    value = {"length", "startConstructId", "endConstructId", "lib"},
    allowGetters = true) // On allowGetters: https://github.com/FasterXML/jackson-databind/issues/95
@Entity
@Table(
    name = "AppPath",
    uniqueConstraints =
        @UniqueConstraint(
            columnNames = {"app", "bug", "source", "lib", "startConstructId", "endConstructId"}))
public class Path {

  @Id
  @GeneratedValue(strategy = GenerationType.AUTO)
  @JsonIgnore
  private Long id;

  @ManyToOne(optional = false)
  @JoinColumn(name = "app", referencedColumnName = "id")
  @JsonBackReference // Required in order to omit the app property when de-serializing JSON
  private Application app;

  @ManyToOne(optional = false)
  @JoinColumn(name = "bug", referencedColumnName = "bugId")
  private Bug bug;

  @ManyToOne(optional = true)
  @JoinColumn(name = "lib", referencedColumnName = "digest")
  private Library lib;

  /**
   * ID of the TEST {@link GoalExecution} during which the path was constructed.
   * The member is of type {@link String} rather than {@link GoalExecution}, as the
   * latter will only be uploaded at the very end of the goal execution, hence, a foreign
   * key relationship could not be satisfied.
   */
  @Column private String executionId;

  @Column
  @Enumerated(EnumType.STRING)
  private PathSource source;

  @ElementCollection(fetch = FetchType.LAZY)
  @CollectionTable(name = "AppPathPath", joinColumns = @JoinColumn(name = "id"))
  @OrderColumn
  List<PathNode> path;

  @ManyToOne(
      optional = false,
      cascade = {},
      fetch = FetchType.EAGER)
  @JoinColumn(name = "startConstructId") // Required for the unique constraint
  private ConstructId startConstructId;

  @ManyToOne(
      optional = false,
      cascade = {},
      fetch = FetchType.EAGER)
  @JoinColumn(name = "endConstructId") // Required for the unique constraint
  private ConstructId endConstructId;

  /**
   * <p>Constructor for Path.</p>
   */
  public Path() {
    super();
  }

  /**
   * <p>Constructor for Path.</p>
   *
   * @param _app a {@link org.eclipse.steady.backend.model.Application} object.
   * @param _bug a {@link org.eclipse.steady.backend.model.Bug} object.
   * @param _source a {@link org.eclipse.steady.shared.enums.PathSource} object.
   */
  public Path(Application _app, Bug _bug, PathSource _source) {
    super();
    this.app = _app;
    this.bug = _bug;
    this.source = _source;
  }

  /**
   * <p>Getter for the field <code>id</code>.</p>
   *
   * @return a {@link java.lang.Long} object.
   */
  public Long getId() {
    return id;
  }
  /**
   * <p>Setter for the field <code>id</code>.</p>
   *
   * @param id a {@link java.lang.Long} object.
   */
  public void setId(Long id) {
    this.id = id;
  }

  /**
   * <p>Getter for the field <code>app</code>.</p>
   *
   * @return a {@link org.eclipse.steady.backend.model.Application} object.
   */
  public Application getApp() {
    return app;
  }
  /**
   * <p>Setter for the field <code>app</code>.</p>
   *
   * @param app a {@link org.eclipse.steady.backend.model.Application} object.
   */
  public void setApp(Application app) {
    this.app = app;
  }

  /**
   * <p>Getter for the field <code>bug</code>.</p>
   *
   * @return a {@link org.eclipse.steady.backend.model.Bug} object.
   */
  public Bug getBug() {
    return bug;
  }
  /**
   * <p>Setter for the field <code>bug</code>.</p>
   *
   * @param bug a {@link org.eclipse.steady.backend.model.Bug} object.
   */
  public void setBug(Bug bug) {
    this.bug = bug;
  }

  /**
   * <p>Getter for the field <code>executionId</code>.</p>
   *
   * @return a {@link java.lang.String} object.
   */
  public String getExecutionId() {
    return executionId;
  }
  /**
   * <p>Setter for the field <code>executionId</code>.</p>
   *
   * @param executionId a {@link java.lang.String} object.
   */
  public void setExecutionId(String executionId) {
    this.executionId = executionId;
  }

  /**
   * <p>Getter for the field <code>source</code>.</p>
   *
   * @return a {@link org.eclipse.steady.shared.enums.PathSource} object.
   */
  public PathSource getSource() {
    return source;
  }
  /**
   * <p>Setter for the field <code>source</code>.</p>
   *
   * @param source a {@link org.eclipse.steady.shared.enums.PathSource} object.
   */
  public void setSource(PathSource source) {
    this.source = source;
  }

  /**
   * <p>Getter for the field <code>path</code>.</p>
   *
   * @return a {@link java.util.List} object.
   */
  public List<PathNode> getPath() {
    return path;
  }
  /**
   * <p>Setter for the field <code>path</code>.</p>
   *
   * @param path a {@link java.util.List} object.
   */
  public void setPath(List<PathNode> path) {
    this.path = path;
  }

  /**
   * <p>Getter for the field <code>startConstructId</code>.</p>
   *
   * @return a {@link org.eclipse.steady.backend.model.ConstructId} object.
   */
  public ConstructId getStartConstructId() {
    return startConstructId;
  }
  /**
   * <p>Setter for the field <code>startConstructId</code>.</p>
   *
   * @param startNode a {@link org.eclipse.steady.backend.model.ConstructId} object.
   */
  public void setStartConstructId(ConstructId startNode) {
    this.startConstructId = startNode;
  }

  /**
   * <p>Getter for the field <code>endConstructId</code>.</p>
   *
   * @return a {@link org.eclipse.steady.backend.model.ConstructId} object.
   */
  public ConstructId getEndConstructId() {
    return endConstructId;
  }
  /**
   * <p>Setter for the field <code>endConstructId</code>.</p>
   *
   * @param endNode a {@link org.eclipse.steady.backend.model.ConstructId} object.
   */
  public void setEndConstructId(ConstructId endNode) {
    this.endConstructId = endNode;
  }

  /**
   * <p>Getter for the field <code>lib</code>.</p>
   *
   * @return a {@link org.eclipse.steady.backend.model.Library} object.
   */
  public Library getLib() {
    return lib;
  }
  /**
   * <p>Setter for the field <code>lib</code>.</p>
   *
   * @param lib a {@link org.eclipse.steady.backend.model.Library} object.
   */
  public void setLib(Library lib) {
    this.lib = lib;
  }

  /**
   * <p>countConstructs.</p>
   *
   * @return a int.
   */
  @JsonProperty(value = "length")
  public int countConstructs() {
    return (this.getPath() == null ? -1 : this.getPath().size());
  }

  /** {@inheritDoc} */
  @Override
  public final String toString() {
    return this.toString(false);
  }

  /**
   * <p>toString.</p>
   *
   * @param _deep a boolean.
   * @return a {@link java.lang.String} object.
   */
  public final String toString(boolean _deep) {
    final StringBuilder builder = new StringBuilder();
    if (_deep) {
      builder
          .append("Path ")
          .append(this.toString(false))
          .append(System.getProperty("line.separator"));
      builder
          .append("    App ")
          .append(this.getApp())
          .append(", Bug ")
          .append(this.getBug())
          .append(System.getProperty("line.separator"));
      builder
          .append("    From ")
          .append(this.getPath().get(0).getConstructId())
          .append(" to ")
          .append(this.getPath().get(this.getPath().size() - 1).getConstructId())
          .append(System.getProperty("line.separator"));
    } else {
      builder.append("[").append(this.getId()).append(":").append(this.getSource()).append("]");
    }
    return builder.toString();
  }

  /**
   * <p>inferStartConstructId.</p>
   */
  public void inferStartConstructId() {
    if (this.getStartConstructId() == null) {
      this.setStartConstructId(this.getPath().get(0).getConstructId());
    }
  }

  /**
   * <p>inferEndConstructId.</p>
   */
  public void inferEndConstructId() {
    if (this.getEndConstructId() == null) {
      this.setEndConstructId(this.getPath().get(this.getPath().size() - 1).getConstructId());
    }
  }

  /**
   * <p>inferLibrary.</p>
   */
  public void inferLibrary() {
    if (this.getSource() == PathSource.A2C
        || this.getSource() == PathSource.T2C
        || this.getSource() == PathSource.X2C) {
      this.setLib(this.getPath().get(this.getPath().size() - 1).getLib());
    } else if (this.getSource() == PathSource.C2A) {
      this.setLib(this.getPath().get(0).getLib());
    }
  }

  /** {@inheritDoc} */
  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + ((app == null) ? 0 : app.hashCode());
    result = prime * result + ((bug == null) ? 0 : bug.hashCode());
    result = prime * result + ((endConstructId == null) ? 0 : endConstructId.hashCode());
    result = prime * result + ((source == null) ? 0 : source.hashCode());
    result = prime * result + ((startConstructId == null) ? 0 : startConstructId.hashCode());
    return result;
  }

  /** {@inheritDoc} */
  @Override
  public boolean equals(Object obj) {
    if (this == obj) return true;
    if (obj == null) return false;
    if (getClass() != obj.getClass()) return false;
    Path other = (Path) obj;
    if (app == null) {
      if (other.app != null) return false;
    } else if (!app.equals(other.app)) return false;
    if (bug == null) {
      if (other.bug != null) return false;
    } else if (!bug.equals(other.bug)) return false;
    if (endConstructId == null) {
      if (other.endConstructId != null) return false;
    } else if (!endConstructId.equals(other.endConstructId)) return false;
    if (source != other.source) return false;
    if (startConstructId == null) {
      if (other.startConstructId != null) return false;
    } else if (!startConstructId.equals(other.startConstructId)) return false;
    return true;
  }
}
