User.java

Go to the documentation of this file.

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

/**
 * @file User.java
 *
 * @brief Class representing user
 */

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

import cz.vutbr.fit.knot.annotations.app.AppBean;
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.ManyToMany;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Table;

/**
 * Class representing user
 * 
 * @brief Class representing user
 * @author idytrych
 */
@Entity
@Table(name = "user")
@NamedQueries({
  @NamedQuery(name = "User.findAll", query = "SELECT u FROM User u"),
  @NamedQuery(name = "User.findById", query = "SELECT u FROM User u WHERE u.id = :id"),
  @NamedQuery(name = "User.findByLogin", query = "SELECT u FROM User u WHERE u.login = :login"),
  @NamedQuery(name = "User.findByName", query = "SELECT u FROM User u WHERE u.name = :name"),
  @NamedQuery(name = "User.findByEmail", query = "SELECT u FROM User u WHERE u.email = :email"),
  @NamedQuery(name = "User.findByNameAndEmail", query = "SELECT u FROM User u WHERE u.name = :name AND u.email = :email"),
  @NamedQuery(name = "User.findByCredentials", query = "SELECT u FROM User u WHERE u.login = :login AND u.password = :password"),
  @NamedQuery(name = "User.findByLoginAndSystem", query = "SELECT u FROM User u WHERE u.login = :login AND u.comeFrom = :comeFrom"),  
  @NamedQuery(name = "User.findByEmailAndPassword", query = "SELECT u FROM User u WHERE u.email = :email AND u.password = :password")})
public class User implements Serializable {
  private static final long serialVersionUID = 1L;
  /** User id */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  /** Login of user */
  @Basic(optional = false)
  @Column(name = "login")
  private String login;
  /** Full name */
  @Basic(optional = true)
  @Column(name = "name")
  private String name;
  /** e-mail */
  @Basic(optional = false)
  @Column(name = "email")
  private String email;
  /** Password */
  @Basic(optional = false)
  @Column(name = "password")
  private String password;
  /** Address of system from which user come */
  @Basic(optional = true)
  @Column(name = "comeFrom")
  private String comeFrom;
  /** URI where is user image located */
  @Basic(optional = true)
  @Column(name = "imageURI")
  private String image;

  /** Groups to which user belongs  */
  @ManyToMany(mappedBy="users",  cascade = {CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH})
  public List<UserGroup> groups;

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

  /**
   * Constructor of reference objects for searching purposes - no initialization
   * needed
   *
   * @param id Id of user
   */
  public User(Integer id) {
    this.id = id;
  }

  /**
   * Constructor
   *
   * @param login User's login
   * @param name User's full name
   * @param email User's e-mail
   * @param password User's password
   */
  public User(String login, String name, String email, String password) {
    this.login = login;
    this.name = name;
    this.email = email;
    this.password = password;
  }

  /**
   * Constructor
   *
   * @param id User id
   * @param login User's login
   * @param name User's full name
   * @param email User's e-mail
   * @param password User's password
   */
  public User(Integer id, String login, String name, String email, String password) {
    this.id = id;
    this.login = login;
    this.name = name;
    this.email = email;
    this.password = password;
  }

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

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

  /**
   * Gets user groups to which user belongs
   *
   * @return Returns user groups to which user belongs
   */
  public List<UserGroup> getGroups() {
    return groups;
  }

  /**
   * Setting user groups to which user belongs
   *
   * @param groups User groups to which user belongs
   */
  public void setGroups(List<UserGroup> groups) {
    this.groups = groups;
  }

  /**
   * Gets user groups to which user belongs as ArrayList
   *
   * @return Returns user groups to which user belongs as ArrayList
   */
  public ArrayList<UserGroup> getGroupsAL() {
    return new ArrayList<UserGroup>(groups);
  }

  /**
   * Setting user groups to which user belongs
   *
   * @param groups User groups to which user belongs
   */
  public void setGroups(ArrayList<UserGroup> groups) {
    this.groups = groups;
  }

  /**
   * Join user to user group
   *
   * @param group User group to join
   */
  public void addGroup(UserGroup group) {
    this.groups.add(group);
  }

  /**
   * Gets login of user
   *
   * @return Returns login of user
   */
  public String getLogin() {
    return login;
  }

  /**
   * Sets login of user
   *
   * @param login Login of user
   */
  public void setLogin(String login) {
    this.login = login;
  }

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

  /**
   * Sets full name of user
   *
   * @param name Full name of user
   */
  public void setName(String name) {
    this.name = name;
  }

  /**
   * Gets e-mail of user
   *
   * @return Returns e-mail of user
   */
  public String getEmail() {
    return email;
  }

  /**
   * Sets e-mail of user
   *
   * @param email E-mail of user
   */
  public void setEmail(String email) {
    this.email = email;
  }

  /**
   * Gets password of user
   *
   * @return Returns password of user
   */
  public String getPassword() {
    return password;
  }

  /**
   * Sets password of user
   *
   * @param password Password of user
   */
  public void setPassword(String password) {
    this.password = password;
  }

  /**
   * Gets address of system from which user come
   * 
   * @return Returns address of system from which user come
   */
  public String getComeFrom() {
    return comeFrom;
  }

  /**
   * Sets address of system from which user come
   * 
   * @param comeFrom Address of system from which user come
   */
  public void setComeFrom(String comeFrom) {
    this.comeFrom = comeFrom;
  }

  /**
   * Gets user's URI (base URI + user id)
   *
   * @return Returns user's URI
   */
  public String getURI() {
    return AppBean.getBaseAuthorUri() + id;
  }
  
  /**
   * Gets user's URI (base URI + user id)
   *
   * @return Returns user's URI
   */
  public String getURIV2() {
    return AppBean.getBaseUserUriV2() + id;
  }

  /**
   * Gets URI where is user image located
   *
   * @return URI where is user image located
   */
  public String getImage() {
    return image;
  }

  /**
   * Sets URI where is user image located
   *
   * @param image URI where is user image located
   */
  public void setImage(String image) {
    this.image = image;
  }
  
  @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 User)) {
      return false;
    }
    User other = (User) 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.User[id=" + id + "]";
  }

  /**
   * Returns serialized informations about user in XML
   *
   * @return Returns serialized informations about user in XML
   */
  public String toXMLString() {
    return "<person id=\"" + getURI() + "\" login=\"" + login + "\" name=\"" + name + "\" email=\"" + email + "\" photoURI=\"\"/>";
  }
  
  /**
   * Returns serialized informations about user in XML for protocol V2
   *
   * @return Returns serialized informations about user in XML for protocol V2
   */
  public String toXMLStringV2() {
    return "<user uri=\"" + getURIV2() + "\" login=\"" + login + "\" name=\"" + name + "\" email=\"" + email + "\" photoURI=\"\"/>";
  }

  /**
   * Returns serialized informations about user in XML with list of user groups
   *
   * @return Returns serialized informations about user in XML with list of user groups
   */
  public String toXMLStringWG() {
    String retStr;
    retStr = "<person id=\"" + getURI() + "\" login=\"" + login + "\" name=\"" + name + "\" email=\"" + email + "\" photoURI=\"\">";
    retStr = retStr + "<userGroups>";
    Iterator<UserGroup> grIt = groups.iterator();
    while (grIt.hasNext()) {
      UserGroup ug = grIt.next();
      retStr = retStr + ug.toXMLString();
    }
    retStr = retStr + "</userGroups>";
    retStr = retStr + "</person>";
    return retStr;
  }

}  // class User