SuggestionFeedback.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SuggestionFeedback.java
 * Description: Class represents database entitiy that holds information about 
 *              group suggestion feedback
 */

/**
 * @file SuggestionFeedback.java
 *
 * @brief Class represents database entitiy that holds information about 
 *        group suggestion feedback.
 */

package cz.vutbr.fit.knot.annotations.modules.suggestionManager;

import cz.vutbr.fit.knot.annotations.entity.Annotation;
import cz.vutbr.fit.knot.annotations.entity.UserGroup;
import java.io.Serializable;
import javax.persistence.Basic;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Table;
import javax.validation.constraints.NotNull;
import javax.xml.bind.annotation.XmlRootElement;

/**
 * Class represents database entitiy that holds information about group suggestion 
 * feedback.
 * 
 * @brief Represents database entitiy with suggestion feedback.
 * feedback.
 * @author Martin Petr (xpetrm05)
 */
@Entity
@Table(name = "suggestionFeedback")
@XmlRootElement
@NamedQueries({
  @NamedQuery(name = "SuggestionFeedback.findAll", query = "SELECT s FROM SuggestionFeedback s"),
  @NamedQuery(name = "SuggestionFeedback.findById", query = "SELECT s FROM SuggestionFeedback s WHERE s.id = :id"),
  @NamedQuery(name = "SuggestionFeedback.findByDoc", query = "SELECT s FROM SuggestionFeedback s WHERE s.groupId = :groupId AND s.suggestion.sourceDocumentId = :docId"),
  @NamedQuery(name = "SuggestionFeedback.findByDocPos", query = "SELECT s FROM SuggestionFeedback s WHERE s.groupId = :groupId AND s.suggestion.sourceDocumentId = :docId AND s.suggestionId IS NOT NULL"),
  @NamedQuery(name = "SuggestionFeedback.findByDocNeg", query = "SELECT s FROM SuggestionFeedback s WHERE s.groupId = :groupId AND s.suggestion.sourceDocumentId = :docId AND s.suggestionId IS NULL"),
  @NamedQuery(name = "SuggestionFeedback.findBySuggestionId", query = "SELECT s FROM SuggestionFeedback s WHERE s.suggestionId = :suggestionId"),
  @NamedQuery(name = "SuggestionFeedback.findByGroupId", query = "SELECT s FROM SuggestionFeedback s WHERE s.groupId = :groupId"),
  @NamedQuery(name = "SuggestionFeedback.findByAnnot", query = "SELECT s FROM SuggestionFeedback s WHERE s.annotationId = :annotationId"),
  @NamedQuery(name = "SuggestionFeedback.findByAnnotNotNull", query = "SELECT s FROM SuggestionFeedback s WHERE s.annotationId= :id AND s.suggestionId IS NOT NULL"),
  @NamedQuery(name = "SuggestionFeedback.findByAnnotationId", query = "SELECT s FROM SuggestionFeedback s WHERE s.annotationId = :annotationId AND s.groupId = :groupId")})
public class SuggestionFeedback implements Serializable {
  private static final long serialVersionUID = 1L;
  
  /** Id of suggestion feedback */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  
  /** Id of suggestion that feedback belongs */
  @Basic(optional = false)
  @NotNull
  @Column(name = "suggestionId", insertable=false, updatable=false)
  private Integer suggestionId;
  
  /** Id of user group of suggestion */
  @Basic(optional = false)
  @NotNull
  @Column(name = "groupId", insertable=false, updatable=false)
  private Integer groupId;
  
  /** Id of corresponding annotation from suggestion if is suggestion approved */
  @Column(name = "annotationId", insertable=false, updatable=false)
  private Integer annotationId;
  
  /** Suggestion that feedback belongs */
  @ManyToOne
  @JoinColumn(name = "suggestionId", referencedColumnName = "id")
  private Suggestion suggestion;
  
  /** User group of suggestion feedback */
  @ManyToOne
  @JoinColumn(name = "annotationId", referencedColumnName = "id")
  private Annotation annot;
  
  /** Corresponding annotation from suggestion if is suggestion approved */
  @ManyToOne
  @JoinColumn(name = "groupId", referencedColumnName = "id")
  private UserGroup group;

  /**
   * Constructor
   */
  public SuggestionFeedback() {
  }

  /**
   * Constructor
   * 
   * @param id Id of suggestion feedback
   */
  public SuggestionFeedback(Integer id) {
    this.id = id;
  }

  /**
   * Constructor
   * 
   * @param id Id of suggestion feedback
   * @param suggestionId Id of suggestion that feedback belongs
   * @param groupId Id of user group of suggestion
   */
  public SuggestionFeedback(Integer id, Integer suggestionId, Integer groupId) {
    this.id = id;
    this.suggestionId = suggestionId;
    this.groupId = groupId;
  }

  /**
   * Gets id of suggestion feedback
   * 
   * @return id of suggestion feedback
   */
  public Integer getId() {
    return id;
  }

  /**
   * Sets id of suggestion feedback
   * 
   * @param id id of suggestion feedback
   */
  public void setId(Integer id) {
    this.id = id;
  }

  /**
   * Gets id of suggestion that feedback belongs
   * 
   * @return id of suggestion that feedback belongs
   */
  public Integer getSuggestionId() {
    return suggestionId;
  }

  /**
   * Sets id of suggestion that feedback belongs
   * 
   * @param suggestionId id of suggestion that feedback belongs 
   */
  public void setSuggestionId(Integer suggestionId) {
    this.suggestionId = suggestionId;
  }

  /**
   * Gets id of user group of suggestion
   * 
   * @return id of user group of suggestion
   */
  public Integer getGroupId() {
    return groupId;
  }

  /**
   * Sets id of user group of suggestion
   * 
   * @param groupId id of user group of suggestion
   */
  public void setGroupId(Integer groupId) {
    this.groupId = groupId;
  }

  /**
   * Gets id of corresponding annotation from suggestion if is suggestion approved 
   * 
   * @return id of corresponding annotation
   */
  public Integer getAnnotationId() {
    return annotationId;
  }

  /**
   * Sets id of corresponding annotation from suggestion if is suggestion approved 
   * 
   * @param annotationId id of corresponding annotation
   */
  public void setAnnotationId(Integer annotationId) {
    this.annotationId = annotationId;
  }

  /**
   * Gets suggestion that feedback belongs
   * 
   * @return suggestion that feedback belongs
   */
  public Suggestion getSuggestion() {
    return suggestion;
  }

  /**
   * Sets suggestion that feedback belongs
   * 
   * @param suggestion suggestion that feedback belongs
   */
  public void setSuggestion(Suggestion suggestion) {
    this.suggestion = suggestion;
  }

  /**
   * Gets corresponding annotation of suggestion feedback
   * 
   * @return corresponding annotation of suggestion feedback
   */
  public Annotation getAnnot() {
    return annot;
  }

  /**
   * Sets corresponding annotation of suggestion feedback
   * 
   * @param annot corresponding annotation of suggestion feedback
   */
  public void setAnnot(Annotation annot) {
    this.annot = annot;
  }

  /**
   * Gets user group of suggestion feedback
   * 
   * @return user group of suggestion feedback
   */
  public UserGroup getGroup() {
    return group;
  }

  /**
   * Sets user group of suggestion feedback
   * 
   * @param group user group of suggestion feedback
   */
  public void setGroup(UserGroup group) {
    this.group = group;
  }

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

  /**
   * Compares this with other object and returns, whether objects are same type
   * and have same id.
   *
   * @param object Object to compare with
   * @return If object is same type and have same id, returns true, false otherwise
   */
  @Override
  public boolean equals(Object object) {
    if (!(object instanceof SuggestionFeedback)) {
      return false;
    }
    SuggestionFeedback other = (SuggestionFeedback) object;
    if ((this.id == null && other.id != null) || (this.id != null && !this.id.equals(other.id))) {
      return false;
    }
    return true;
  }

  @Override
  public String toString() {
    return "cz.vutbr.fit.knot.annotations.modules.suggestionManager.SuggestionFeedback[ id=" + id + " ]";
  }
  
}  // public class SuggestionFeedback