SugEntityAdditionalAttribute.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SugEntityAdditionalAttribute.java
 * Description: Class representing additional attribute of entity in suggestion attribute
 */

/**
 * @file SugEntityAdditionalAttribute.java
 *
 * @brief Class representing additional attribute of entity in suggestion attribute
 * @author Martin Petr
 */

package cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes;

import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.comet.Util;
import java.io.Serializable;
import java.util.logging.Level;
import java.util.logging.Logger;
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.ManyToOne;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Table;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import javax.xml.bind.annotation.XmlRootElement;

/**
 * Additional attribute of entity in suggestion attribute
 * 
 * @brief Additional attribute of entity in suggestion attribute
 * @author Martin Petr
 */
@Entity
@Table(name = "sugEntityAdditionalAttribute")
@XmlRootElement
@NamedQueries({
  @NamedQuery(name = "SugEntityAdditionalAttribute.findAll", query = "SELECT s FROM SugEntityAdditionalAttribute s"),
  @NamedQuery(name = "SugEntityAdditionalAttribute.findById", query = "SELECT s FROM SugEntityAdditionalAttribute s WHERE s.id = :id"),
  @NamedQuery(name = "SugEntityAdditionalAttribute.findByName", query = "SELECT s FROM SugEntityAdditionalAttribute s WHERE s.name = :name"),
  @NamedQuery(name = "SugEntityAdditionalAttribute.findByStringValue", query = "SELECT s FROM SugEntityAdditionalAttribute s WHERE s.stringValue = :stringValue"),
  @NamedQuery(name = "SugEntityAdditionalAttribute.findByEntityId", query = "SELECT s FROM SugEntityAdditionalAttribute s WHERE s.entityId = :entityId")})
public class SugEntityAdditionalAttribute implements Serializable, Comparable<Object> {
  private static final long serialVersionUID = 1L;
  
  /** Id of attribute */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  
  /** Name of attribute */
  @Basic(optional = false)
  @NotNull
  @Size(min = 1, max = 255)
  @Column(name = "name")
  private String name;
  
  /** Type of attribute */
  @Basic(optional = false)
  @NotNull
  @Column(name = "type")
  private String type;
  
  /** Value of attribute */
  @Basic(optional = true)
  @Size(min = 0, max = 255)
  @Column(name = "stringValue")
  private String stringValue;
  
  /** Attribute priority (for order) */
  @Column(name = "priority")
  protected Integer priority;
  
  /** Id of entity attribute of suggestion to which this additional attribute belongs */
  @Basic(optional = false)
  @Column(name = "entityId", nullable = false, insertable = false, updatable = false)
  private int entityId;
  
  /** Entity attribute of suggestion to which this additional attribute belongs */
  @ManyToOne(optional = false)
  @JoinColumn(name = "entityId", referencedColumnName = "id")
  private SugEntityAttribute refEntityAttribute;

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

  /**
   * Constructor
   * 
   * @param id Id of attribute
   */
  public SugEntityAdditionalAttribute(Integer id) {
    this.id = id;
  }

  /**
   * Constructor
   * 
   * @param name Name of attribute
   * @param stringValue Value of attribute
   * @param refEntityAttribute Entity attribute of suggestion to which this additional attribute belongs
   */
  public SugEntityAdditionalAttribute(String name, String stringValue, SugEntityAttribute refEntityAttribute) {
    this.name = name;
    this.stringValue = stringValue;
    this.refEntityAttribute = refEntityAttribute;
  }
  
  /**
   * Constructor
   * 
   * @param id Id of attribute
   * @param name Name of attribute
   * @param stringValue Value of attribute
   * @param refEntityAttribute Entity attribute of suggestion to which this additional attribute belongs
   */
  public SugEntityAdditionalAttribute(Integer id, String name, String stringValue, SugEntityAttribute refEntityAttribute) {
    this.id = id;
    this.name = name;
    this.stringValue = stringValue;
    this.refEntityAttribute = refEntityAttribute;
  }

  /**
   * Constructor
   * 
   * @param name Name of attribute
   * @param type Type of attribute
   * @param stringValue Value of attribute
   * @param refEntityAttribute Entity attribute of suggestion to which this additional attribute belongs
   */
  public SugEntityAdditionalAttribute(String name, String type, String stringValue, SugEntityAttribute refEntityAttribute) {
    this.name = name;
    this.type = type;
    this.stringValue = stringValue;
    this.refEntityAttribute = refEntityAttribute;
  }
  
  /**
   * Gets id of attribute
   * 
   * @return Returns id of attribute
   */
  public Integer getId() {
    return id;
  }

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

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

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

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

  /**
   * Sets type of attribute
   * 
   * @param type New type of attribute
   */
  public void setType(String type) {
    this.type = type;
  }
  
  /**
   * Gets value of attribute
   * 
   * @return Returns value of attribute
   */
  public String getStringValue() {
    return stringValue;
  }

  /**
   * Sets value of attribute
   * 
   * @param stringValue Value of attribute
   */
  public void setStringValue(String stringValue) {
    this.stringValue = stringValue;
  }

  /**
   * Gets id of entity attribute of suggestion to which this additional attribute belongs
   * 
   * @return Returns id of entity attribute of suggestion to which this additional attribute belongs
   */
  public int getEntityId() {
    return entityId;
  }

  /**
   * Sets id of entity attribute of suggestion to which this additional attribute belongs
   * 
   * @param entityId Id of entity attribute of suggestion to which this additional attribute belongs
   */
  public void setEntityId(int entityId) {
    this.entityId = entityId;
  }

  /**
   * Gets entity attribute of suggestion to which this additional attribute belongs
   * 
   * @return Returns entity attribute of suggestion to which this additional attribute belongs
   */
  public SugEntityAttribute getRefEntityAttribute() {
    return refEntityAttribute;
  }

  /**
   * Sets entity attribute of suggestion to which this additional attribute belongs
   * 
   * @param refEntityAttribute Entity attribute of suggestion to which this additional attribute belongs
   */
  public void setRefEntityAttribute(SugEntityAttribute refEntityAttribute) {
    this.refEntityAttribute = refEntityAttribute;
  }

  /**
   * Gets attribute priority
   * 
   * @return Returns attribute priority
   */
  public Integer getPriority() {
    return priority;
  }

  /**
   * Sets attribute priority
   * 
   * @param priority Attribute priority
   */
  public void setPriority(Integer priority) {
    this.priority = priority;
  }
  
  @Override
  public int hashCode() {
    int hash = 0;
    hash += (id != null ? id.hashCode() : 0);
    return hash;
  }
  
  /**
   * Returns serialized informations about attribute in XML for protocol V2
   * (in Trix for suggestion)
   * 
   * @return Returns serialized informations about attribute in XML
   */
  public String toXmlStringV2(){
    String result;

    if (type != null) {
      int typeIndex = Constants.SIMPLE_TYPES_FOR_ENT_AD_AT.indexOf(type);
      if (typeIndex >= 0 && !type.equals(Constants.DEFAULT_SIMPLE_TYPE_FOR_ENT_AD_AT)) {
        // if type is allowed and it is not default one
        result = "<" + name + " type=\"" + Constants.SIMPLE_TYPES_URIS_FOR_ENT_AD_AT.get(typeIndex) 
                 + "\">" + Util.toHTMLString(stringValue) + "</" + name + ">";
      } else {
        result = "<" + name + ">" + Util.toHTMLString(stringValue) + "</" + name + ">";
      }
    } else {
      result = "<" + name + ">" + Util.toHTMLString(stringValue) + "</" + name + ">";
    }
    return result;
  }

  /**
   * Returns serialized informations about attribute in XML for protocol V2
   * (in element for getEntities)
   *
   * @return Returns serialized informations about attribute in XML for protocol V2
   */
  public String toXMLResponseStringV2() {
    int typeIndex = Constants.SIMPLE_TYPES_FOR_ENT_AD_AT.indexOf(type);
    if (typeIndex < 0) {
      typeIndex = Constants.SIMPLE_TYPES_FOR_ENT_AD_AT.indexOf("String");
      if (typeIndex < 0) {
        if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
          String msg = "URI for string was not found!";
          Logger.getLogger(SugEntityAdditionalAttribute.class.getName()).log(Level.SEVERE, msg);
        }
      }
    }
    String typeURI = "";
    if (typeIndex > 0) {
      typeURI = Constants.SIMPLE_TYPES_URIS_FOR_ENT_AD_AT.get(typeIndex);
    }
    StringBuilder result = new StringBuilder();
    result.append("<trix:triple><trix:uri>");
    result.append(Util.toHTMLString(this.refEntityAttribute.getUri()));
    result.append("</trix:uri><trix:name>");
    result.append(Util.toHTMLString(name));
    result.append("</trix:name><trix:typedLiteral datatype=\"").append(typeURI).append("\">");
    result.append(Util.toHTMLString(stringValue));
    result.append("</trix:typedLiteral></trix:triple>");
    return result.toString();
  }

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

  /**
   * Compares attributes according to priority
   * 
   * @param o Object to compare with
   * @return Returns a negative integer, zero, or a positive integer as this 
   *         object is less than, equal to, or greater than the specified object. 
   */
  @Override
  public int compareTo(Object o) {
    if (o == null) {
      return 1;
    }
    if (!(o instanceof SugEntityAdditionalAttribute)) {
      throw new UnsupportedOperationException("Not supported yet.");
    }
    SugEntityAdditionalAttribute other = (SugEntityAdditionalAttribute) o;
    if (this.priority == null && other.getPriority() == null) {
      return 0;
    }
    if (this.priority == null && other.getPriority() != null) {
      return -1;
    }
    if (this.priority != null && other.getPriority() == null) {
      return 1;
    }
    return this.priority.compareTo(other.getPriority());
  }
  
}  // public class SugEntityAdditionalAttribute