Settings.java

Go to the documentation of this file.

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

/**
 * @file Settings.java
 *
 * @brief Class representing parameter of user settings
 */

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

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.Lob;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.OneToOne;
import javax.persistence.Table;

/**
 * Class representing parameter of user settings
 *
 * @brief Class representing parameter of user settings
 * @author Martin Petr (xpetrm05)
 */
@Entity
@Table(name = "settings")
@NamedQueries({
  @NamedQuery(name = "Settings.findAll", query = "SELECT s FROM Settings s"),
  @NamedQuery(name = "Settings.findById", query = "SELECT s FROM Settings s WHERE s.id = :id"),
  @NamedQuery(name = "Settings.findByUser", query = "SELECT s FROM Settings s WHERE s.userId = :userId"),
  @NamedQuery(name = "Settings.findByName", query = "SELECT s FROM Settings s WHERE s.name = :name"),
  @NamedQuery(name = "Settings.findByUserAndName", query = "SELECT s FROM Settings s WHERE s.userId = :userId AND s.name = :name"),
  @NamedQuery(name = "Settings.findByValue", query = "SELECT s FROM Settings s WHERE s.value = :value")})
public class Settings implements Serializable {
  private static final long serialVersionUID = 1L;
  /** Id of parameter of user settings */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  /** Id of user to which this parameter belongs to */
  @Basic(optional = false)
  @Column(name = "userId", nullable=false, insertable=false, updatable=false)
  private int userId;
  /** Name of parameter of user settings */
  @Basic(optional = false)
  @Lob
  @Column(name = "name")
  private String name;
  /** Value of parameter of user settings */
  @Basic(optional = false)
  @Lob
  @Column(name = "paramValue")
  private String value;
  
  /** Description of parameter of user settings */
  @Basic(optional = true)
  @Lob
  @Column(name = "description")
  private String description;

  /** User to which this parameter belongs to */
  @OneToOne(optional = true)
  @JoinColumn(name = "userId", referencedColumnName = "id")
  private User user;

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

  /**
   * Constructor
   * 
   * @param id id of parameter of user settings
   */
  public Settings(Integer id) {
    this.id = id;
  }

  /**
   * Constructor
   *
   * @param user User to which this parameter belongs to
   * @param name Name of parameter
   * @param value Value of parameter
   */
  public Settings(User user, String name, String value) {
    this.user = user;
    this.userId = user.getId();
    this.name = name;
    this.value = value;
    this.description = "";
  }
  
  /**
   * Constructor
   *
   * @param user User to which this parameter belongs to
   * @param name Name of parameter
   * @param value Value of parameter
   * @param description Description of parameter
   */
  public Settings(User user, String name, String value, String description) {
    this.user = user;
    this.userId = user.getId();
    this.name = name;
    this.value = value;
    this.description = description;
  }

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

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

  /**
   * Gets id of user to which this parameter belongs to
   * 
   * @return id of user to which this parameter belongs to
   */
  public int getUserId() {
    return userId;
  }

  /**
   * Sets id of user to which this parameter belongs to
   * 
   * @param userId Id of user to which this parameter belongs to
   */
  public void setUserId(int userId) {
    this.userId = userId;
  }

  /**
   * Gets the user to which this parameter belongs to
   * 
   * @return Returns user to which this parameter belongs to
   */
  public User getUser() {
    return user;
  }

  /**
   * Sets the user to which this parameter belongs to
   *
   * @param user User to which this parameter belongs to
   */
  public void setUser(User user) {
    this.user = user;
  }

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

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

  /**
   * Gets value of parameter
   *
   * @return Returns value of parameter
   */
  public String getValue() {
    return value;
  }

  /**
   * Sets value of parameter
   *
   * @param value Value of parameter
   */
  public void setValue(String value) {
    this.value = value;
  }

  /**
   * Gets description of parameter
   * 
   * @return Returns description of parameter
   */
  public String getDescription() {
    return description;
  }

  /**
   * Sets description of parameter
   * 
   * @param description Description of parameter
   */
  public void setDescription(String description) {
    this.description = description;
  }
  
  /**
   * Method returns true wether value is string with annotation style
   * 
   * @return true if value is annotation style
   */
  public boolean isStyleSetting(){
    String[] result = name.split(":");
    if(result.length == 2) return true;
    else return false;
  }

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

  /**
   * Returns serialized informations about parameter of user settings in XML
   *
   * @return Returns serialized informations about parameter of user settings in XML
   */
  public String toXMLString() {
    String desc = "";
    if (description != null && !description.isEmpty()) {
      desc = " description=\"" + description + "\"";
    }
    return "<param name=\"" + name + "\" value=\"" + value + "\"" + desc + "/>";
  }

}  // class Settings