SubscribedItem.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SubscribedItem.java
 * Description: Class representing item of subscripted or unsubscripted sources list
 */

/**
 * @file SubscribedItem.java
 *
 * @brief Class representing item of subscripted or unsubscripted sources list
 */

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

import cz.vutbr.fit.knot.annotations.entity.AnnotType;
import cz.vutbr.fit.knot.annotations.entity.User;
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.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.OneToOne;
import javax.persistence.Table;


/**
 * This class represent item of subscripted or unsubscripted sources list and is 
 * used for StoryscopeInterfaceModule needs.
 *
 * @brief Class representing item of subscripted or unsubscripted sources list.
 * @author Martin Petr (xpetrm05)
 */
@Entity
@Table(name = "subscribedItem")
@NamedQueries({
  @NamedQuery(name = "SubscribedItem.findAll", query = "SELECT s FROM SubscribedItem s"),
  @NamedQuery(name = "SubscribedItem.findById", query = "SELECT s FROM SubscribedItem s WHERE s.id = :id"),
  @NamedQuery(name = "SubscribedItem.findSubscriptions", query = "SELECT s FROM SubscribedItem s WHERE s.storyScope = :storyScope"),
  @NamedQuery(name = "SubscribedItem.findSubscribed", query = "SELECT s FROM SubscribedItem s WHERE s.polarity = 0 AND s.storyScope = :storyScope"),
  @NamedQuery(name = "SubscribedItem.findUnsubscribed", query = "SELECT s FROM SubscribedItem s WHERE s.polarity = 1 AND s.storyScope = :storyScope")})
public class SubscribedItem implements Serializable {
  /** ID of subscribed item */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  
  /** ID of story space that item belongs */
  @Basic(optional = false)
  @Column(name = "storyScope")
  private Integer storyScope;
  
  /** Type of annotation that story space wants (or don't wants) recive */
  @OneToOne(optional = true)
  @JoinColumn(name = "annotType", referencedColumnName = "id")
  private AnnotType annotationType;
  
  /** User which story space wants subscribe or unsubscribe */
  @OneToOne(optional = true)
  @JoinColumn(name = "user", referencedColumnName = "id")
  private User user;
  
  /** Source which story space wants subscribe or unsubscribe */
  @Basic(optional = true)
  @Column(name = "source")
  private String source;
  
  /** Type of subscription (0 = unsubscribed, 1 = subscribed) */
  @Basic(optional = false)
  @Column(name = "polarity")
  private int polarity;
  
  /** Indicator of subscribed type */
  public static final int SUBSCRIBED = 0;
  /** Indicator of unsubscribed type */
  public static final int UNSUBSCRIBED = 1;
  
  
  /**
   * Gets id of subscription
   *
   * @return Returns id of user
   */
  public Integer getId() {
    return id;
  }
  
  /**
   * Sets id of subscription
   * 
   * @param id id of subscription
   */
  public void setId(Integer id) {
    this.id = id;
  }
  
  /**
   * Gets id of Story Space that sunscription belongs
   *
   * @return Returns id of story space
   */
  public Integer getStoryScopeId() {
    return storyScope;
  }

  /**
   * Sets id of Story Space that sunscription belongs
   * 
   * @param id id of Story Space that sunscription belongs
   */
  public void setStoryScopeId(Integer id) {
    this.storyScope = id;
  }
  
  /**
   * Gets annotation type that is subscribed (or unsubscribed)
   *
   * @return Returns instance of class AnnotType with type of annotation or null if isn't fill
   */
  public AnnotType getAnnotationType() {
    return annotationType;
  }

  /**
   * Sets annotation type that is subscribed (or unsubscribed)
   * 
   * @param type annotation type that is subscribed (or unsubscribed)
   */
  public void setAnnotationType(AnnotType type) {
    this.annotationType = type;
  }
  
  /**
   * Gets user which is subscribed (or unsubscribed)
   *
   * @return Returns instance of class User with user or null if user isn't fill
   */
  public User getUser() {
    return user;
  }

  /**
   * Sets user which is subscribed (or unsubscribed)
   * 
   * @param user user which is subscribed (or unsubscribed)
   */
  public void setUser(User user) {
    this.user = user;
  }
  
  /**
   * Gets source that is subscribed (or unsubscribed)
   *
   * @return Returns instance of class String with URL of source or null if isn't fill
   */
  public String getSource(){
    return source;
  }
  
  /**
   * Sets source that is subscribed (or unsubscribed)
   * 
   * @param source source that is subscribed (or unsubscribed)
   */
  public void setSource(String source){
    this.source = source;
  }
  
  /**
   * Gets type of subscription
   *
   * @return Returns 0 if is unsubscribed or 1 if is subscribed
   */
  public int getType(){
    return polarity;
  }
  
  /**
   * Sets type of subscription
   * 
   * @param type type of subscription
   */
  public void setType(int type){
    this.polarity = type;
  }
  
  @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 SubscribedItem)) {
      return false;
    }
    SubscribedItem tested = (SubscribedItem) object;
    if ((this.id == null && tested.id != null) || (this.id != null && !this.id.equals(tested.id))) {
      return false;
    }
    return true;
  }
  
  @Override
  public String toString() {
    return "cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.SubscribedItem[id=" + id + "]";
  }
  
} // class SubscribedItem