Source.java

Go to the documentation of this file.

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

/**
 * @file Source.java
 *
 * @brief Class representing source of subscription.
 */
package cz.vutbr.fit.knot.annotations.entity;

import cz.vutbr.fit.knot.annotations.comet.SubscribedSource;
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.validation.constraints.Size;

/**
 * Class representing source of subscription.
 *
 * @brief Class representing source of subscription
 * @author Martin Petr (xpetrm05)
 */
@Entity
@Table(name = "source")
@NamedQueries({
  @NamedQuery(name = "Source.findAll", query = "SELECT s FROM Source s"),
  @NamedQuery(name = "Source.findById", query = "SELECT s FROM Source s WHERE s.id = :id"),
  @NamedQuery(name = "Source.findByAnnotType", query = "SELECT s FROM Source s WHERE s.annotType = :annotType"),
  @NamedQuery(name = "Source.findByUser", query = "SELECT s FROM Source s WHERE s.userUri = :userUri"),
  @NamedQuery(name = "Source.findBySource", query = "SELECT s FROM Source s WHERE s.source = :source"),
  @NamedQuery(name = "Source.findByPolarity", query = "SELECT s FROM Source s WHERE s.polarity = :polarity"),
  @NamedQuery(name = "Source.findByPackageId", query = "SELECT s FROM Source s WHERE s.packageId = :packageId")})
public class Source implements Serializable {
  private static final long serialVersionUID = 1L;
  /** Id of source of subscription */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  
  /** Uri of annotation type as source */
  @Size(max = 255)
  @Column(name = "annotType")
  private String annotType;
  
  /** Uri of user as source */
  @Size(max = 255)
  @Column(name = "userUri")
  private String userUri;
  
  /** Uri of other sources */
  @Size(max = 255)
  @Column(name = "source")
  private String source;
  
  /** Indicates wether is positive or negative subscription */
  @Basic(optional = false)
  @NotNull
  @Column(name = "polarity")
  private boolean polarity;
  
  /** Id of subscription that this source belongs */
  @Basic(optional = false)
  @Column(name = "packageId", nullable = false, insertable = false, updatable = false)
  private Integer packageId;
  
  /** Subscription that this source belongs */
  @ManyToOne(optional = false)
  @JoinColumn(name = "packageId", referencedColumnName = "id")
  private Subscription refSubscription;
  
  /**
   * Constructor
   */
  public Source() {
  }

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

  /**
   * Constructor
   * 
   * @param id identificator of source of subscription
   * @param polarity set if subscription is positive or negative
   */
  public Source(Integer id, boolean polarity) {
    this.id = id;
    this.polarity = polarity;
  }

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

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

  /**
   * Gets uri of annotation type as source.
   * 
   * @return uri of annotation type as source
   */
  public String getAnnotType() {
    return annotType;
  }

  /**
   * Sets uri of annotation type as source.
   * 
   * @param annotType uri of annotation type as source
   */
  public void setAnnotType(String annotType) {
    this.annotType = annotType;
  }

  /**
   * Gets uri of user as source.
   * 
   * @return uri of user as source
   */
  public String getUser() {
    return userUri;
  }

  /**
   * Sets uri of user as source.
   * 
   * @param user uri of user as source
   */
  public void setUser(String user) {
    this.userUri = user;
  }

  /**
   * Gets uri of other sources.
   * 
   * @return uri of other sources
   */
  public String getSource() {
    return source;
  }

  /**
   * Sets uri of other sources.
   * 
   * @param source uri of other sources
   */
  public void setSource(String source) {
    this.source = source;
  }

  /**
   * Gets variable that indicates wether is positive or negative subscription.
   * 
   * @return variable that indicates wether is positive or negative subscription
   */
  public boolean getPolarity() {
    return polarity;
  }

  /**
   * Sets variable that indicates wether is positive or negative subscription.
   * 
   * @param polarity indicates wether is positive or negative subscription
   */
  public void setPolarity(boolean polarity) {
    this.polarity = polarity;
  }

  /**
   * Gets id of subscription that this source belongs.
   * 
   * @return id of subscription that this source belongs
   */
  public Integer getPackageId() {
    return packageId;
  }

  /**
   * Sets id of subscription that this source belongs.
   * 
   * @param packageId id of subscription that this source belongs
   */
  public void setPackageId(Integer packageId) {
    this.packageId = packageId;
  }

  /**
   * Gets subscription that this source belongs.
   * 
   * @return subscription that this source belongs
   */
  public Subscription getRefSubscription() {
    return refSubscription;
  }

  /**
   * Sets subscription that this source belongs.
   * 
   * @param refSubscription subscription that this source belongs
   */
  public void setRefSubscription(Subscription refSubscription) {
    this.refSubscription = refSubscription;
  }
  
  @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 Source)) {
      return false;
    }
    Source other = (Source) 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.Source[ id=" + id + " ]";
  }
  
  /**
   * Returns serialized informations about source of subscription in XML for protocol
   * version 2.
   *
   * @return Returns serialized informations about source of subscription in XML
   */
  public String toXMLStringV2(){
    StringBuilder result = new StringBuilder("<source ");

    result.append("subscribe=\"");
    result.append(polarity);
    result.append("\" ");
    
    if(annotType != null && !annotType.isEmpty()){
      result.append("typeUri=\"");
      result.append(annotType);
      result.append("\" ");
    }
    
    if(userUri != null && !userUri.isEmpty()){
      result.append("authorUri=\"");
      result.append(userUri);
      result.append("\" ");
    }
    
    if(source != null && !source.isEmpty()){
      result.append("groupUri=\"");
      result.append(source);
      result.append("\" ");
    }
    result.append("/>");
    
    return result.toString();
  }
  
  /**
   * Gets this source as SubscribedSource
   * 
   * @return Returns this source as SubscribedSource
   */
  public SubscribedSource getSourceAsSubSource(){
    SubscribedSource subscribed =  new SubscribedSource(annotType,userUri,source);
    return subscribed;
  }
}  // public class Source