Subscription.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: Subscription.java
 * Description: Class representing subscription.
 */

/**
 * @file Subscription.java
 *
 * @brief Class representing subscription.
 */

package cz.vutbr.fit.knot.annotations.entity;

import cz.vutbr.fit.knot.annotations.app.AppBean;
import cz.vutbr.fit.knot.annotations.comet.SubscribedSource;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import javax.persistence.Basic;
import javax.persistence.CascadeType;
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.OneToMany;
import javax.persistence.OneToOne;
import javax.persistence.Table;
import javax.persistence.Transient;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

/**
 * Class representing subscription.
 *
 * @brief Class representing subscription
 * @author Martin Petr (xpetrm05)
 */
@Entity
@Table(name = "subscription")
@NamedQueries({
  @NamedQuery(name = "Subscription.findAll", query = "SELECT s FROM Subscription s"),
  @NamedQuery(name = "Subscription.findById", query = "SELECT s FROM Subscription s WHERE s.id = :id"),
  @NamedQuery(name = "Subscription.findByName", query = "SELECT s FROM Subscription s WHERE s.name = :name"),
  @NamedQuery(name = "Subscription.findByUserId", query = "SELECT s FROM Subscription s WHERE s.userId = :userId"),
  @NamedQuery(name = "Subscription.findByGroupId", query = "SELECT s FROM Subscription s WHERE s.groupId = :groupId"),
  @NamedQuery(name = "Subscription.findByIdAndUserId", query = "SELECT s FROM Subscription s WHERE s.id = :id AND s.userId = :userId"),
})
public class Subscription implements Serializable {
  /** Id of subscription */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  
  /** Name of subscription */
  @Basic(optional = false)
  @NotNull
  @Size(min = 1, max = 255)
  @Column(name = "name")
  private String name;
  
  /** Id of author of subscription */
  @Basic(optional = false)
  @NotNull
  @Column(name = "userId", insertable=false, updatable=false)
  private int userId;
  
  /** Id of group of subscription */
  @Basic(optional = false)
  @NotNull
  @Column(name = "groupId", insertable=false, updatable=false)
  private int groupId;

  /** List of subscriptions */
  @OneToMany(mappedBy = "refSubscription", cascade = CascadeType.ALL,
  targetEntity = Source.class)
  private List<Source> subscriptions;
  
  /** Author of subscription (user) */
  @OneToOne(optional = false)
  @JoinColumn(name = "userId", referencedColumnName = "id")
  private User user;
  
  /** Group of subscription */
  @OneToOne(optional = false)
  @JoinColumn(name = "groupId", referencedColumnName = "id")
  private UserGroup group;
  
  @Transient
  /* Temporary id of subscription */
  private Integer tmpId;

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

  /**
   * Constructor
   * 
   * @param id id of subscription
   */
  public Subscription(Integer id) {
    this.id = id;
  }

  /**
   * Constructor
   * 
   * @param id id of subscription
   * @param name name of subscription
   * @param userId id of author of subscription
   */
  public Subscription(Integer id, String name, int userId) {
    this.id = id;
    this.name = name;
    this.userId = userId;
  }

  /**
   * Gets id of subscription.
   * 
   * @return id of subscription
   */
  public Integer getId() {
    return id;
  }

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

  /**
   * Gets name of subscription.
   * 
   * @return name of subscription
   */
  public String getName() {
    return name;
  }

  /**
   * Sets name of subscription.
   * 
   * @param name name of subscription
   */
  public void setName(String name) {
    this.name = name;
  }
  
  /**
   * Gets id of author of subscription.
   * 
   * @return id of author of subscription
   */
  public int getUserId() {
    return userId;
  }

  /**
   * Sets id of author of subscription.
   * 
   * @param userId id of author of subscription
   */
  public void setUserId(int userId) {
    this.userId = userId;
  }

  /**
   * Gets list of subscriptions.
   * 
   * @return list of subscriptions
   */
  public List<Source> getSubscriptions() {
    return subscriptions;
  }
  
  /**
   * Add source of subscription.
   * 
   * @param subscription source of subscription
   */
  public void addSubscription(Source subscription) {
    if(this.subscriptions == null){
      this.subscriptions = new ArrayList<Source>();
    }
    
    this.subscriptions.add(subscription);
  }

  /**
   * Sets list of subscriptions.
   * 
   * @param subscriptions list of subscriptions
   */
  public void setSubscriptions(List<Source> subscriptions) {
    this.subscriptions = subscriptions;
  }

  /**
   * Gets author of subscription.
   * 
   * @return author of subscription
   */
  public User getUser() {
    return user;
  }

  /**
   * Sets author of subscription.
   * 
   * @param user author of subscription
   */
  public void setUser(User user) {
    this.user = user;
  }
  
  /**
   * Gets temporary id of subscription.
   * 
   * @return temporary id of subscription
   */
  public Integer getTmpId() {
    return tmpId;
  }

  /**
   * Sets temporary id of subscription
   * 
   * @param tmpId temporary id of subscription
   */
  public void setTmpId(Integer tmpId) {
    this.tmpId = tmpId;
  }

  /**
   * Gets id of user group to which this subscription belongs
   * 
   * @return Returns id of user group to which this subscription belongs
   */
  public int getGroupId() {
    return groupId;
  }

  /**
   * Sets id of user group to which this subscription belongs
   * 
   * @param groupId Id of user group to which this subscription belongs
   */
  public void setGroupId(int groupId) {
    this.groupId = groupId;
  }

  /**
   * Gets user group to which this subscription belongs
   * 
   * @return Returns user group to which this subscription belongs
   */
  public UserGroup getGroup() {
    return group;
  }

  /**
   * Sets user group to which this subscription belongs
   * 
   * @param group User group to which this subscription belongs
   */
  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 Subscription)) {
      return false;
    }
    Subscription other = (Subscription) 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.entity.Subscription[ id=" + id + " ]";
  }
    
  /**
   * Returns serialized informations about subscription in XML for protocol
   * version 2.
   *
   * @return Returns serialized informations about subscription in XML
   */
  public String toXMLStringV2(){
    StringBuilder result = new StringBuilder("<subscription uri=\"");
    result.append(AppBean.getBaseSubscriptionUri());
    result.append(id.toString());
    result.append("\" name=\"");
    result.append(name);
    result.append("\" authorUri=\"");
    result.append(user.getURI());
    
    
    StringBuilder sources = new StringBuilder();
    
    if(subscriptions != null){
      Iterator<Source> subscrIt = subscriptions.iterator();
      while(subscrIt.hasNext()){
        Source actualSubs = subscrIt.next();
        sources.append(actualSubs.toXMLStringV2());
      }
    }
    
    if(sources.length() > 0){
      result.append("\">");
      result.append(sources.toString());
      result.append("</subscription>");
    }else{
      result.append("\"/>"); 
    }
    
    return result.toString();
  }
  
  /**
   * Returns serialized informations about subscription in XML for protocol
   * version 2 with specific tag name.
   *
   * @param tagName name of tag
   * 
   * @return Returns serialized informations about subscription in XML
   */
  public String toXMLStringV2(String tagName){
    StringBuilder result = new StringBuilder("<");
    result.append(tagName);
    result.append(" uri=\"");
    result.append(AppBean.getBaseSubscriptionUri());
    result.append(id.toString());
    result.append("\" name=\"");
    result.append(name);
    result.append("\" authorUri=\"");
    result.append(user.getURI());
    
    
    StringBuilder sources = new StringBuilder();
    
    if(subscriptions != null){
      Iterator<Source> subscrIt = subscriptions.iterator();
      while(subscrIt.hasNext()){
        Source actualSubs = subscrIt.next();
        sources.append(actualSubs.toXMLStringV2());
      }
    }
    
    if(sources.length() > 0){
      result.append("\">");
      result.append(sources.toString());
      result.append("</");
      result.append(tagName);
      result.append(">");
    }else{
      result.append("\"/>"); 
    }
    
    return result.toString();
  }
  
  /**
   * Gets negative subscription as list of SubscribedSources.
   * 
   * @return List of negative SubscribedSources
   */
  public ArrayList<SubscribedSource> getNegSourcesAsSubSource(){
    ArrayList<SubscribedSource> returnList = null;
    if(this.subscriptions != null){
      returnList = new ArrayList<SubscribedSource>(this.subscriptions.size());
      Iterator<Source> sourceIt = this.subscriptions.iterator();
      while(sourceIt.hasNext()){
        returnList.add(sourceIt.next().getSourceAsSubSource());
      }
    }
    
    return returnList;
  }
  
  /**
   * Gets positive subscription as list of SubscribedSources.
   * 
   * @return List of positive SubscribedSources
   */
  public ArrayList<SubscribedSource> getSourcesAsSubSource(boolean polarity){
    ArrayList<SubscribedSource> returnList = null;
    if(this.subscriptions != null){
      returnList = new ArrayList<SubscribedSource>(this.subscriptions.size());
      Iterator<Source> sourceIt = this.subscriptions.iterator();
      while(sourceIt.hasNext()){
        Source currentSource = sourceIt.next();
        if(currentSource.getPolarity() == polarity){
          returnList.add(currentSource.getSourceAsSubSource());
        }
      }
    }
    
    return returnList;
  }
}  // public class Subscription