UserGroup.java

Go to the documentation of this file.

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

/**
 * @file UserGroup.java
 *
 * @brief Class representing user group
 */

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.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.ManyToMany;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Table;

/**
 * Class representing user group
 *
 * @brief Class representing user group
 * @author idytrych
 */
@Entity
@Table(name = "userGroup")
@NamedQueries({
  @NamedQuery(name = "UserGroup.findAll", query = "SELECT u FROM UserGroup u"),
  @NamedQuery(name = "UserGroup.findById", query = "SELECT u FROM UserGroup u WHERE u.id = :id"),
  @NamedQuery(name = "UserGroup.findByName", query = "SELECT u FROM UserGroup u WHERE u.name = :name")})
public class UserGroup implements Serializable {
  private static final long serialVersionUID = 1L;
  /** Group id */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  /** Group name */
  @Basic(optional = false)
  @Column(name = "name")
  private String name;

  /** List of users in this group */
  @ManyToMany(cascade = CascadeType.ALL)
  @JoinTable(name = "userInGroup",
    joinColumns =
      @JoinColumn(name = "group_id", referencedColumnName = "id"),
    inverseJoinColumns =
      @JoinColumn(name = "user_id", referencedColumnName = "id"))
  public List<User> users;

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

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

  /**
   * Constructor
   *
   * @param id Id of group
   * @param name Name of group
   */
  public UserGroup(Integer id, String name) {
    this.id = id;
    this.name = name;
    this.users = new ArrayList<User>();
  }

  /**
   * Constructor
   * 
   * @param name Name of group
   */
  public UserGroup(String name) {
    this.name = name;
    this.users = new ArrayList<User>();
  }

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

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

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

  /**
   * Sets name of group
   *
   * @param name Name of group
   */
  public void setName(String name) {
    this.name = name;
  }

  /**
   * Gets users in this group
   *
   * @return Returns users in this group
   */
  public List<User> getUsers() {
    return users;
  }

  /**
   * Gets users in this group as ArrayList
   *
   * @return Returns users in this group as ArrayList
   */
  public ArrayList<User> getUsersAL() {
    return new ArrayList<User>(users);
  }

  /**
   * Sets users in this group
   *
   * @param users Users in this group
   */
  public void setUsers(List<User> users) {
    this.users = users;
  }

  /**
   * Sets users in this group (setting from ArrayList)
   *
   * @param users Users in this group
   */
  public void setUsers(ArrayList<User> users) {
    this.users = users;
  }

  /**
   * Adds user to the group
   *
   * @param user User to be added
   */
  public void addUser(User user) {
    this.users.add(user);
  }

  /**
   * Gets user group's URI (base URI + user group id)
   *
   * @return Returns user group's URI
   */
  public String getUri() {
    return AppBean.getBaseGroupUri() + id;
  }

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

  /**
   * Returns serialized informations about user group in XML
   *
   * @return Returns serialized informations about user group in XML
   */
  public String toXMLString() {
    return "<group uri=\"" + getUri() + "\" name=\"" + name + "\"/>";
  }

  /**
   * Returns serialized informations about user group in XML with list of users
   *
   * @return Returns serialized informations about user group in XML with list of users
   */
  public String toXMLStringWP() {
    String retStr;
    retStr = "<group uri=\"" + getUri() + "\" name=\"" + name + "\">";
    retStr = retStr + "<persons>";
    Iterator<User> uIt = users.iterator();
    while (uIt.hasNext()) {
      User u = uIt.next();
      retStr = retStr + u.toXMLString();
    }
    retStr = retStr + "</persons>";
    retStr = retStr + "</group>";
    return retStr;
  }
  
}  // class UserGroup