StoredDocument.java

Go to the documentation of this file.

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

/**
 * @file StoredDocument.java
 *
 * @brief Class representing stored document
 */

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

import cz.vutbr.fit.knot.annotations.app.AppBean;
import java.io.Serializable;
import java.util.Date;
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.Lob;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.OneToOne;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;

/**
 * Class representing stored document
 *
 * @brief Class representing stored document
 * @author idytrych
 */
@Entity
@Table(name = "storedDocument")
@NamedQueries({
  @NamedQuery(name = "StoredDocument.findAll", query = "SELECT s FROM StoredDocument s"),
  @NamedQuery(name = "StoredDocument.findById", query = "SELECT s FROM StoredDocument s WHERE s.id = :id"),
  @NamedQuery(name = "StoredDocument.findByUri", query = "SELECT s FROM StoredDocument s WHERE s.uri = :uri"),
  @NamedQuery(name = "StoredDocument.findByAdded", query = "SELECT s FROM StoredDocument s WHERE s.added = :added"),
  @NamedQuery(name = "StoredDocument.findByOwnerId", query = "SELECT s FROM StoredDocument s WHERE s.ownerId = :ownerId"),
  @NamedQuery(name = "StoredDocument.findByGroupId", query = "SELECT s FROM StoredDocument s WHERE s.groupId = :groupId")})
public class StoredDocument implements Serializable {
  private static final long serialVersionUID = 1L;
  /** Document id */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  /** URI of document */
  @Basic(optional = false)
  @Column(name = "uri")
  private String uri;
  /** File name of document */
  @Basic(optional = false)
  @Column(name = "name")
  private String name;
  /** File type of document */
  @Basic(optional = false)
  @Column(name = "type")
  private String type;
  /** Date of document addition */
  @Basic(optional = false)
  @Column(name = "added")
  @Temporal(TemporalType.TIMESTAMP)
  private Date added;
  /** Id of document owner */
  @Basic(optional = false)
  @Column(name = "ownerId", insertable=false, updatable=false)
  private int ownerId;
  /** Id of user group to which this document belongs */
  @Basic(optional = false)
  @Column(name = "groupId", insertable=false, updatable=false)
  private int groupId;
  /** Document content */
  @Basic(optional = false)
  @Lob
  @Column(name = "content")
  private String content;

  /** Owner of document (user) */
  @OneToOne(optional = true)
  @JoinColumn(name = "ownerId", referencedColumnName = "id")
  private User owner;
  /** User group to which this document belongs */
  @OneToOne(optional = true)
  @JoinColumn(name = "groupId", referencedColumnName = "id")
  private UserGroup group;

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

  /**
   * Constructor
   * 
   * @param id document id
   */
  public StoredDocument(Integer id) {
    this.id = id;
  }

  /**
   * Constructor
   *
   * @param name File name
   * @param type File type of document
   * @param owner Document owner
   * @param group User group to which this document belongs
   * @param content Document content
   */
  public StoredDocument(String name, String type, User owner, UserGroup group, String content) {
    this.added = new Date();
    this.name = name;
    this.type = type;
    this.owner = owner;
    this.group = group;
    this.content = content;
  }

  /**
   * Gets id of document
   *
   * @return Returns id of document
   */
  public Integer getId() {
    return id;
  }

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

  /**
   * Gets URI of document
   *
   * @return Returns URI of document
   */
  public String getUri() {
    return uri;
  }

  /**
   * Generate URI of document
   * URI = base URI + document id
   *
   * @return Generated URI of document
   */
  public String getGeneratedUri() {
    return AppBean.getBaseDocumentUri() + id;
  }

  /**
   * Sets URI of document
   *
   * @param uri URI of document
   */
  public void setUri(String uri) {
    this.uri = uri;
  }

  /**
   * Gets date of document addition
   *
   * @return Returns date of document addition
   */
  public Date getAdded() {
    return added;
  }

  /**
   * Sets date of document addition
   *
   * @param added Date of document addition
   */
  public void setAdded(Date added) {
    this.added = added;
  }

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

  /**
   * Sets user group to which this document belongs
   *
   * @param group User group to which this document belongs
   */
  public void setGroup(UserGroup group) {
    this.group = group;
  }

  /**
   * Gets file name of document
   *
   * @return Returns file name of document
   */
  public String getName() {
    return name;
  }

  /**
   * Sets file name of document
   *
   * @param name File name of document
   */
  public void setName(String name) {
    this.name = name;
  }

  /**
   * Gets file type of document
   * 
   * @return Returns file type of document
   */
  public String getType() {
    return type;
  }

  /**
   * Sets file type of document
   *
   * @param type File type of document
   */
  public void setType(String type) {
    this.type = type;
  }

  /**
   * Gets document owner
   *
   * @return Returns document owner
   */
  public User getOwner() {
    return owner;
  }

  /**
   * Sets document owner
   *
   * @param owner Document owner
   */
  public void setOwner(User owner) {
    this.owner = owner;
  }

  /**
   * Gets textual content of document
   *
   * @return Returns textual content of document
   */
  public String getContent() {
    return content;
  }

  /**
   * Sets textual content of document
   *
   * @param content Textual content of document
   */
  public void setContent(String content) {
    this.content = content;
  }

  @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 StoredDocument)) {
      return false;
    }
    StoredDocument other = (StoredDocument) 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.StoredDocument[id=" + id + "]";
  }

}  // public class StoredDocument