AnnotDocument.java

Go to the documentation of this file.

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

/**
 * @file AnnotDocument.java
 *
 * @brief Class representing annotated copy of 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.Lob;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;

/**
 * Class representing annotated copy of document
 *
 * @brief Class representing annotated copy of document
 * @author idytrych
 */
@Entity
@Table(name = "annotDocument")
@NamedQueries({
  @NamedQuery(name = "AnnotDocument.findAll", query = "SELECT d FROM AnnotDocument d"),
  @NamedQuery(name = "AnnotDocument.findById", query = "SELECT d FROM AnnotDocument d WHERE d.id = :id"),
  @NamedQuery(name = "AnnotDocument.findByUri", query = "SELECT d FROM AnnotDocument d WHERE d.uri = :uri"),
  @NamedQuery(name = "AnnotDocument.findByAdded", query = "SELECT d FROM AnnotDocument d WHERE d.added = :added"),
  @NamedQuery(name = "AnnotDocument.findByModified", query = "SELECT d FROM AnnotDocument d WHERE d.modified = :modified")})
public class AnnotDocument implements Serializable {
  private static final long serialVersionUID = 1L;
  /** ID of annotated copy of document */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  /** URI of original document */
  @Basic(optional = false)
  @Column(name = "uri")
  private String uri;
  /** Date of document addition (creation of annotated copy) */
  @Basic(optional = false)
  @Column(name = "added")
  @Temporal(TemporalType.TIMESTAMP)
  private Date added;
  /** Date of document modification */
  @Column(name = "modified")
  @Temporal(TemporalType.TIMESTAMP)
  private Date modified;
  /** Document content */
  @Basic(optional = false)
  @Lob
  @Column(name = "content")
  private String content;

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

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

  /**
   * Constructor
   *
   * @param uri URI of original document
   * @param content Document content
   */
  public AnnotDocument(String uri, String content) {
    this.uri = uri;
    this.added = new Date();
    this.modified = new Date();
    this.content = content;
  }

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

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

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

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

  /**
   * Gets URI of annotated copy of document
   * URI = base uri + document id
   *
   * @return Returns URI of annotated copy of document
   */
  public String getUriForAnnot() {
    return AppBean.getBaseDocumentUri() + id;
  }

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

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

  /**
   * Gets date of last document modification
   *
   * @return Returns date of last document modification
   */
  public Date getModified() {
    return modified;
  }

  /**
   * Sets date of last document modification
   *
   * @param modified Date of last document modification
   */
  public void setModified(Date modified) {
    this.modified = modified;
  }

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

}  // class AnnotDocument