Algorithm.java

/**
 * Copyright 2014-2016 by Metanome Project
 *
 * 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.
 */
package de.metanome.backend.results_db;

import com.fasterxml.jackson.annotation.JsonIgnore;
import de.metanome.algorithm_integration.algorithm_types.*;
import org.hibernate.annotations.OnDelete;
import org.hibernate.annotations.OnDeleteAction;

import javax.persistence.*;
import javax.xml.bind.annotation.XmlTransient;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

/**
 * Represents an algorithm in the database.
 *
 * @author Jakob Zwiener
 */
@NamedQueries(
  @NamedQuery(
    name = "get all",
    query = "from Algorithm"
  )
)
@Entity
public class Algorithm implements Serializable, Comparable<Algorithm> {

  private static final long serialVersionUID = -8836911135785214586L;

  protected long id;
  protected String fileName;
  protected String name;
  protected String author;
  protected String description;
  //Todo: Introduce types Hashset instead of booleans - after finding way around Hibernate problems
  protected boolean ind;
  protected boolean fd;
  protected boolean ucc;
  protected boolean cucc;
  protected boolean od;
  protected boolean mvd;
  protected boolean relationalInput;
  protected boolean databaseConnection;
  protected boolean tableInput;
  protected boolean fileInput;
  protected boolean basicStat;
  protected List<Execution> executions = new ArrayList<>();

  /**
   * Exists for hibernate serialization
   */
  protected Algorithm() {

  }

  /**
   * @param fileName the file name of the algorithm jar
   */
  public Algorithm(String fileName) {
    this.fileName = fileName;
  }

  /**
   * The algorithm should have the appropriate algorithm types set, based on the implemented
   * interfaces.
   *
   * @param fileName            the file name of the algorithm jar
   * @param algorithmInterfaces the implemented interfaces
   */
  public Algorithm(String fileName, Set<Class<?>> algorithmInterfaces) {
    this(fileName);

    this.ind = algorithmInterfaces.contains(InclusionDependencyAlgorithm.class);
    this.fd = algorithmInterfaces.contains(FunctionalDependencyAlgorithm.class);
    this.ucc = algorithmInterfaces.contains(UniqueColumnCombinationsAlgorithm.class);
    this.cucc = algorithmInterfaces.contains(ConditionalUniqueColumnCombinationAlgorithm.class);
    this.od = algorithmInterfaces.contains(OrderDependencyAlgorithm.class);
    this.mvd = algorithmInterfaces.contains(MultivaluedDependencyAlgorithm.class);
    this.basicStat = algorithmInterfaces.contains(BasicStatisticsAlgorithm.class);
    this.fileInput = algorithmInterfaces.contains(FileInputParameterAlgorithm.class);
    this.tableInput = algorithmInterfaces.contains(TableInputParameterAlgorithm.class);
    this.relationalInput = algorithmInterfaces.contains(RelationalInputParameterAlgorithm.class);
    this.databaseConnection =
      algorithmInterfaces.contains(DatabaseConnectionParameterAlgorithm.class);
  }

  /**
   * This constructor sets all attributes as given, and sets the algorithm types based on the given
   * interfaces. If no name is specified, fileName is used for this purpose.
   *
   * @param fileName            the file name of the algorithm jar
   * @param name                the name of the implemented algorithm
   * @param author              name(s) of the author(s)
   * @param description         any additional information on the algorithm
   * @param algorithmInterfaces the implemented interfaces
   */
  public Algorithm(String fileName, String name, String author, String description,
                   Set<Class<?>> algorithmInterfaces) {
    this(fileName, algorithmInterfaces);

    if (name != null) {
      this.name = name;
    } else {
      this.name = fileName;
    }

    this.author = author;
    this.description = description;
  }

  @Id
  @GeneratedValue
  public long getId() {
    return id;
  }

  public void setId(long id) {
    this.id = id;
  }

  @Column(name = "fileName", unique = true)
  public String getFileName() {
    return fileName;
  }

  public Algorithm setFileName(String fileName) {
    this.fileName = fileName;
    return this;
  }

  @Column(name = "name", unique = true)
  public String getName() {
    return name;
  }

  public Algorithm setName(String name) {
    this.name = name;
    return this;
  }

  public String getAuthor() {
    return author;
  }

  public Algorithm setAuthor(String author) {
    this.author = author;
    return this;
  }

  public String getDescription() {
    return description;
  }

  public Algorithm setDescription(String description) {
    this.description = description;
    return this;
  }

  public boolean isInd() {
    return ind;
  }

  public Algorithm setInd(boolean isInd) {
    this.ind = isInd;
    return this;
  }

  public boolean isFd() {
    return fd;
  }

  public Algorithm setFd(boolean isFd) {
    this.fd = isFd;
    return this;
  }

  public boolean isUcc() {
    return ucc;
  }

  public Algorithm setUcc(boolean isUcc) {
    this.ucc = isUcc;
    return this;
  }

  public boolean isCucc() {
    return cucc;
  }

  public Algorithm setCucc(boolean isCucc) {
    this.cucc = isCucc;
    return this;
  }

  public boolean isOd() {
    return od;
  }

  public Algorithm setOd(boolean isOd) {
    this.od = isOd;
    return this;
  }
  
  public boolean isMvd() {
	return mvd;
  }

  public Algorithm setMvd(boolean isMvd) {
	this.mvd = isMvd;
	return this;
  }

  public boolean isRelationalInput() {
    return relationalInput;
  }

  public Algorithm setRelationalInput(boolean isRelationalInput) {
    this.relationalInput = isRelationalInput;
    return this;
  }

  public boolean isDatabaseConnection() {
    return databaseConnection;
  }

  public Algorithm setDatabaseConnection(boolean isDatabaseConnection) {
    this.databaseConnection = isDatabaseConnection;
    return this;
  }

  public boolean isTableInput() {
    return tableInput;
  }

  public Algorithm setTableInput(boolean isTableInput) {
    this.tableInput = isTableInput;
    return this;
  }

  public boolean isFileInput() {
    return fileInput;
  }

  public Algorithm setFileInput(boolean isFileInput) {
    this.fileInput = isFileInput;
    return this;
  }

  public boolean isBasicStat() {
    return basicStat;
  }

  public Algorithm setBasicStat(boolean isBasicStat) {
    this.basicStat = isBasicStat;
    return this;
  }

  @XmlTransient
  @JsonIgnore
  @OneToMany(
    fetch = FetchType.EAGER,
    mappedBy = "algorithm",
    cascade = CascadeType.ALL
  )
  @OnDelete(action = OnDeleteAction.CASCADE)
  public List<Execution> getExecutions() {
    return executions;
  }

  @XmlTransient
  @JsonIgnore
  public Algorithm setExecutions(List<Execution> executions) {
    this.executions = executions;
    return this;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;

    }
    if (!(o instanceof Algorithm)) {
      return false;
    }

    Algorithm algorithm = (Algorithm) o;

    if (fileName != null ? !fileName.equals(algorithm.fileName) : algorithm.fileName != null) {
      return false;
    }

    return true;
  }

  @Override
  public int hashCode() {
    return fileName != null ? fileName.hashCode() : 0;
  }

  /* (non-Javadoc)
   * @see java.lang.Comparable#compareTo(java.lang.Object)
   */
  @Override
  public int compareTo(Algorithm o) {
    return this.getName().compareTo(o.getName());
  }


  @Override
  public String toString() {
    return "Algorithm ["
      + "fileName=" + fileName
      + ", name=" + name
      + ", author=" + author
      + ", description=" + description
      + ", ind=" + ind
      + ", fd=" + fd
      + ", Ucc=" + ucc
      + ", cucc=" + cucc
      + ", od=" + od
      + ", mvd=" + mvd
      + ", relationalInput=" + relationalInput
      + ", databaseConnection=" + databaseConnection
      + ", tableInput=" + tableInput
      + ", fileInput=" + fileInput
      + ", basicStat=" + basicStat
      + "]";
  }

}