SugBaseAttribute.java

Go to the documentation of this file.

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

/**
 * @package cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes
 * 
 * @brief Classes for representing particular types of attributes of suggestions
 */
package cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes;

import cz.vutbr.fit.knot.annotations.app.AppBean;
import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.comet.Util;
import cz.vutbr.fit.knot.annotations.entity.AnnotType;
import cz.vutbr.fit.knot.annotations.entity.Annotation;
import cz.vutbr.fit.knot.annotations.entity.User;
import cz.vutbr.fit.knot.annotations.entity.attribute.BaseAttribute;
import cz.vutbr.fit.knot.annotations.entity.attribute.EntityAdditionalAttribute;
import cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.alternative.AltEntityAdditionalAttribute;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.alternative.AlternativeAttribute;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.alternative.SecAttribute;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.alternative.SecSuggestion;
import java.io.Serializable;
import java.math.BigDecimal;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.persistence.*;

/**
 * @file SugBaseAttribute.java
 *
 * @brief Class representing attribute of suggestion
 */

/**
 * Class representing attribute of suggestion
 *
 * @brief Class representing attribute of suggestion
 */
@Entity(name="SuggestionAttribute")
@Inheritance(strategy= InheritanceType.SINGLE_TABLE)
@Table(name = "suggestionAttribute")
@DiscriminatorColumn(name="simpleType",discriminatorType=DiscriminatorType.STRING)
@NamedQueries({
  @NamedQuery(name = "SuggestionAttribute.findAll", query = "SELECT a FROM SuggestionAttribute a"),
  @NamedQuery(name = "SuggestionAttribute.findById", query = "SELECT a FROM SuggestionAttribute a WHERE a.id = :id"),
  @NamedQuery(name = "SuggestionAttribute.findByName", query = "SELECT a FROM SuggestionAttribute a WHERE a.name = :name"),
  @NamedQuery(name = "SuggestionAttribute.findBySimpleType", query = "SELECT a FROM SuggestionAttribute a WHERE a.simpleType = :simpleType"),
  @NamedQuery(name = "SuggestionAttribute.findByType", query = "SELECT a FROM SuggestionAttribute a WHERE a.type = :type"),
  @NamedQuery(name = "SuggestionAttribute.findBySuggestion", query = "SELECT a FROM SuggestionAttribute a WHERE a.suggestion = :suggestion"),
})
public abstract class SugBaseAttribute implements Serializable, Comparable<Object>, SecAttribute {
  
   protected static final long serialVersionUID = 1L;


  /** Id of attribute of annotation */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  protected Integer id;


  /** Id of suggestion to which this attribute belongs */
  @Basic(optional = false)
  @Column(name = "suggestion", nullable = false, insertable = false, updatable = false)
  protected int suggestion;

  /** Name of attribute */
  @Basic(optional = false)
  @Column(name = "name")
  protected String name;

  /** Name of simple type of attribute (set in structured attributes too) */
  @Column(name = "simpleType")
  protected String simpleType;

  /** Id of structured type of attribute (type of annotation) */
  @Column(name = "type", insertable = false, updatable = false)
  protected Integer type;

  /** Value of attribute type URI or URI of linked annotation or Image */
  @Column(name = "uri")
  protected String uri;
  
  /** URI in ontology */
  @Basic(optional = true)
  @Column(name = "uriInOntology")
  private String uriInOntology;

  /** Id of nested suggestion (structured value) */
  @Column(name = "nestedSugg", insertable = false, updatable = false)
  protected String nestedSugg;
  
  /** Id of nested annotation (structured value) */
  @Column(name = "nestedAnnot", insertable = false, updatable = false)
  protected String nestedAnnot;

  /** Id of linked suggestion (can be null in case of foreign annotation) */
  @Column(name = "linkedSugg", insertable = false, updatable = false)
  protected Integer linkedSugg;
  
  /** Id of linked annotation (can be null in case of foreign annotation) */
  @Column(name = "linkedAnnot", insertable = false, updatable = false)
  protected Integer linkedAnnot;

  /** Attribute value of type String */
  @Column(name = "stringValue")
  protected String stringValue;

  /** Attribute value of type Text */
  @Lob
  @Column(name = "textValue")
  protected String textValue;

  /** Attribute value of type DateTime, Date or Time */
  @Column(name = "dateValue")
  @Temporal(TemporalType.TIMESTAMP)
  protected Date dateValue;

  /** Attribute value of type integer */
  @Column(name = "intValue")
  protected Integer intValue;

  /** Attribute value of type Decimal */
  @Column(name = "decValue")
  protected BigDecimal decValue;

  /** Attribute value of type Boolean */
  @Column(name = "boolVAlue")
  protected Boolean boolVAlue;

  /** Attribute value of type Binary */
  @Lob
  @Column(name = "binValue")
  protected byte[] binValue;

  /** Attribute value of type Person (id of user) */
  @Column(name = "userValue", insertable = false, updatable = false)
  protected Integer userValue;

  /** Attribute value of type GeoPoint - latitude */
  @Column(name = "geoLat")
  protected BigDecimal geoLat;
  /** Attribute value of type GeoPoint - longitude */
  @Column(name = "geoLong")
  protected BigDecimal geoLong;
  
  /** type of vocalbulary entity */
  @Column(name = "entityType")
  protected String entityType;
  
  /** uri of image that entity represents */
  @Column(name = "entityVisualURI")
  protected String entityVisualURI;

  /** Comment */
  @Basic(optional = true)
  @Lob
  @Column(name = "commentary")
  protected String comment;
  
  /** Attribute priority (for order) */
  @Column(name = "priority")
  protected Integer priority;

  /** Annotation to which this attribute belongs */
  @ManyToOne(optional = false)
  @JoinColumn(name = "suggestion", referencedColumnName = "id")
  protected Suggestion refSuggestion;

  /** Structured type of attribute (type of annotation) */
  @OneToOne(optional = true)
  @JoinColumn(name = "type", referencedColumnName = "id")
  protected AnnotType attributeType;

  /** Nested suggestion (structured value) */
  @OneToOne(optional = true, cascade = CascadeType.ALL)
  @JoinColumn(name = "nestedSugg", referencedColumnName = "id")
  protected Suggestion nestedSuggestion;
  
  /** Nested annotation (structured value) */
  @OneToOne(optional = true, cascade = CascadeType.ALL)
  @JoinColumn(name = "nestedAnnot", referencedColumnName = "id")
  protected Annotation nestedAnnotation;

  /** Linked suggestion (can be null in case of foreign annotation) */
  @OneToOne(optional = true)
  @JoinColumn(name = "linkedSugg", referencedColumnName = "id")
  protected Suggestion linkedSuggestion;
  
  /** Linked annotation (can be null in case of foreign annotation) */
  @OneToOne(optional = true)
  @JoinColumn(name = "linkedAnnot", referencedColumnName = "id")
  protected Annotation linkedAnnotation;

  /** Attribute value of type Person (user) */
  @OneToOne(optional = true)
  @JoinColumn(name = "userValue", referencedColumnName = "id")
  protected User user;
  
  /** List of entity additional attribute */
  @OneToMany(mappedBy = "refEntityAttribute", cascade = CascadeType.ALL,
  targetEntity = SugEntityAdditionalAttribute.class)
  protected List<SugEntityAdditionalAttribute> entityAdditionalAttributes;

  
  /**
   * Constructor for base attribute. Note: every extended class MUST HAVE
   * default constructor without parameters
   */
  public SugBaseAttribute() {
  }

  /**
   * Creates new attribute
   * @param id id of new attribute
   */
  public SugBaseAttribute(Integer id) {
    this.id = id;
  }


  /**
   * Just a helper function,which returns XML part for comments.
   *
   * @param proto11 If true, protocol version is greater then 1.0
   * @return XML part for comments
   */
  protected String getCommentXmlPart(boolean proto11) {
    String sCom = "/";
    if (proto11 && comment != null && !comment.isEmpty()) {
      sCom = "><a:comment>"
              + "<![CDATA["
              + comment
              + "]]>"
              + "</a:comment></a:attribute";
    }
    return sCom;
  }

  /**
   * Formats attribute value for XML. Function should provide date
   * converting for date attribute, string escaping for string based
   * attributes...
   *
   * @return string representing attribute value
   */
  protected String xmlFormatValue() {
    if (this.getValue() == null) {
      return "";
    }
    return Util.escapeForXml(this.getValue().toString());
  }

  /**
   * Returns ""
   * @return 
   */
  public String getTypeOntologyUri(){
      return "";
  }
  /**
   * Returns serialized informations about attribute of annotation in XML
   *
   * @param proto11 If true, protocol version is greater then 1.0
   * @param withOntology If true, URI in ontology will be serialized, if false, it will be omitted
   * @return Returns serialized informations about attribute of annotation in XML
   */
  public String toXMLString(boolean proto11, boolean withOntology) {
    String sCom = this.getCommentXmlPart(proto11);
    String escapedVal = xmlFormatValue();
    String ontoString = "";
    if(withOntology){
        ontoString += " typeOntologyUri=\""+getTypeOntologyUri()+"\"";
        ontoString += " ontologyUri=\"" + getUriInOntology() + "\"";
    }
    return "<a:attribute name=\"" + name + "\"" + ontoString + " type=\"" + simpleType + "\" rdf:value=\"" + escapedVal + "\"" + sCom + ">";
  }

  /**
   * Returns serialized informations about attribute of suggestion in XML for protocol V2
   *
   * @return Returns serialized informations about attribute of suggestion in XML for protocol V2
   */
  public String toXMLStringV2(){
    StringBuilder result = new StringBuilder();
    String escapedVal = xmlFormatValue();
    String ontoString = getUriInOntology();
    String docUri = refSuggestion.getSource() + refSuggestion.getFragmentXpointersV2();
    
    // open triple
    result.append("<trix:triple>");
    
    // make first two triples with document URI + xPointers
    result.append("<trix:uri>");
    result.append(docUri);
    result.append("</trix:uri>");
    
    // add triple with name or name from ontology
    if(ontoString == null || ontoString.isEmpty()){
      // if ontology name is not presented
      result.append("<trix:name>");
      result.append(Util.toHTMLString(name));
      result.append("</trix:name>");
    }else{
      // if ontology string is avaible
      result.append("<trix:uri>");
      result.append(Util.toHTMLString(ontoString));
      result.append("</trix:uri>");
    }
    
    // make attributes with special pruposes (that is geoPoint and attributes with mor then one triple)
    if (simpleType.equals("NestedAnnotation")) {
      result.append(((SugNestedAttribute) this).toXMLStringWHV2(ontoString));
    } else if (simpleType.equals("AnnotationLink") || simpleType.equals("LinkedAnnotation")) {
      // Linked annotation
      result.append(((SugLinkedAttribute) this).toXMLStringWHV2(ontoString));
    } else if (simpleType.equals("NestedSuggestion")) {
      result.append(((SugNestedAttribute) this).toXMLStringWHV2(ontoString));
    } else if (simpleType.equals("SuggestionLink") || simpleType.equals("LinkedSuggestion")) {
      // Linked suggestion
      result.append(((SugLinkedAttribute) this).toXMLStringWHV2(ontoString));
    } else if (simpleType.equalsIgnoreCase("Entity")) {
      // Entity
      SugEntityAttribute entity = (SugEntityAttribute) this;
      result.append(entity.toXMLStringWHV2());
    } else if (simpleType.equalsIgnoreCase("GeoPoint")) {
      // geo point
      result.append("<trix:typedLiteral datatype=\"http://www.w3.org/2003/01/geo/wgs84_pos#Point\">");
      result.append(((SugGeoPointAttribute) this).getXmlBody());
      result.append("</trix:typedLiteral>");

      // close triple
      result.append("</trix:triple>");
    } else if (simpleType.equals("AnyAnnotation")) {
      SugAnyAttribute anyAnnot = (SugAnyAttribute) this;
      result.append(anyAnnot.toXMLStringWHV2(ontoString));
    } else {
      // All others simple attributes
      int index = Constants.SIMPLE_TYPES_NAMES_V2.indexOf(simpleType);
      if (index < 0) {
        if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
            String msg = "Unknown type of attribute of suggestion: " + simpleType;
            Logger.getLogger(SugBaseAttribute.class.getName()).log(Level.SEVERE, msg);
        }
        // use string to prevent Exception or client crash
        index = Constants.SIMPLE_TYPES_NAMES_V2.indexOf("String");
      }
      
      result.append("<trix:typedLiteral datatype=\"");
      result.append(Constants.SIMPLE_TYPES_URI_V2.get(index));
      
      if(escapedVal == null){
        // attribute is empty
        result.append("\"/>");
      }else{
        result.append("\">");
        // value with escaped XML chars
        result.append(escapedVal);
        result.append("</trix:typedLiteral>");
      }
      
      // close triple
      result.append("</trix:triple>");
    }
    
    if (priority != null) {
      result.append("<trix:triple>");
        result.append("<trix:uri>");
        result.append(docUri);
        result.append("</trix:uri>");
        if (ontoString == null || ontoString.isEmpty()) {
          // if ontology name is not presented
          result.append("<trix:name>");
          result.append(Util.toHTMLString(name));
          result.append("</trix:name>");
        } else {
          // if ontology string is avaible
          result.append("<trix:uri>");
          result.append(Util.toHTMLString(ontoString));
          result.append("</trix:uri>");
        }
        result.append("<trix:typedLiteral datatype=\"http://knot.fit.vutbr.cz/annotations/knotOAExtension#attributePriority\">");
        result.append(priority);
        result.append("</trix:typedLiteral>");
      result.append("</trix:triple>");
    }
    
    return result.toString();
  }  // toXMLStringV2()

  /**
   * Converts this attribute to SugEntityAdditionalAttribute
   * Some conversions are not possible as a values are complex
   *
   * @return Returns this attribute as SugEntityAdditionalAttribute or null if conversion is not possible
   */
  public SugEntityAdditionalAttribute toSugEntityAdditionalAttribute(){
    SugEntityAdditionalAttribute result = new SugEntityAdditionalAttribute();

    result.setName(name);
    result.setType(Constants.DEFAULT_SIMPLE_TYPE_FOR_ENT_AD_AT);
    result.setStringValue("");

    if (simpleType.equals("NestedAnnotation")) {
      return null;
    } else if (simpleType.equals("AnnotationLink") || simpleType.equals("LinkedAnnotation")) {
      return null;
    } else if (simpleType.equals("NestedSuggestion")) {
      return null;
    } else if (simpleType.equals("SuggestionLink") || simpleType.equals("LinkedSuggestion")) {
      return null;
    } else if (simpleType.equalsIgnoreCase("Entity")) {
      return null;
    } else if (simpleType.equalsIgnoreCase("GeoPoint")) {
      if (this.getGeoLat() != null && this.getGeoLong() != null) {
        result.setStringValue(this.getGeoLat().toString() + ", " + this.getGeoLong().toString());
      }
    } else if (simpleType.equals("AnyAnnotation")) {
      return null;
    } else if (simpleType.equals("Date")) {
      if (this.getDateValue() != null) {
        result.setStringValue(Util.toRFC3339DateOnlyWTZ(this.getDateValue()));
      }
    } else if (simpleType.equals("DateTime")) {
      if (this.getDateValue() != null) {
        result.setStringValue(Util.toRFC3339Date(this.getDateValue()));
      }
    } else if (simpleType.equals("Time")) {
      if (this.getDateValue() != null) {
        result.setStringValue(Util.toRFC3339Time(this.getDateValue()));
      }
    } else if (simpleType.equals("URI")) {
      if (this.getValue() != null) {
        result.setStringValue(this.getValue().toString());
        result.setType("URI");
      }
    } else {
      // All others simple attributes
      int index = Constants.SIMPLE_TYPES_NAMES_V2.indexOf(simpleType);
      if (index < 0) {
        if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
            String msg = "Unknown type of attribute of suggestion: " + simpleType;
            Logger.getLogger(SugBaseAttribute.class.getName()).log(Level.SEVERE, msg);
        }
        return null;
      }
      
      Object val = this.getValue();
      if (val != null) {
        result.setStringValue(val.toString());
      }
    }
    
    return result;
  }  // toSugEntityAdditionalAttribute()
  
  /**
   * 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 SugBaseAttribute)) {
      throw new UnsupportedOperationException("Not supported yet.");
    }
    SugBaseAttribute other = (SugBaseAttribute) 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());
  }
  

  /**
   * Compares this with other object and returns, whether objects are same type
   *
   * and have same content (id is irrelevant). Contents of nested annotations
   * are also compared.
   * @param obj Object to compare with
   * @return If object is same type and have same content, returns true, false otherwise
   */
  public boolean contentEquals(Object obj){
    return contentEquals(obj,true);
  }
  
  /**
   * Compares this with other object and returns, whether objects are same type
   *
   * and have same content (id is irrelevant). Contents of nested annotations
   * are also compared.
   * @param obj Object to compare with
   * @param refAnnot RefAnnotation will not be checked if the parameter is set to false
   * @return If object is same type and have same content, returns true, false otherwise
   */
  public boolean contentEquals(Object obj, boolean refAnnot) {
    if (obj == null) {
      return false;
    }
    if (obj instanceof SugBaseAttribute) {
      final SugBaseAttribute other = (SugBaseAttribute) obj;

      if ((this.name == null) ? (other.name != null) : !this.name.equals(other.name)) {
        return false;
      }
      if (this.userValue != other.userValue && (this.userValue == null || !this.userValue.equals(other.userValue))) {
        return false;
      }
      if (this.geoLat != other.geoLat && (this.geoLat == null || !this.geoLat.equals(other.geoLat))) {
        return false;
      }
      if (this.geoLong != other.geoLong && (this.geoLong == null || !this.geoLong.equals(other.geoLong))) {
        return false;
      }
      if (this.attributeType != other.attributeType && (this.attributeType == null || !this.attributeType.equals(other.attributeType))) {
        return false;
      }
      if (this.comment == null ? other.comment != null : !this.comment.equals(other.comment)) {
        return false;
      }
      if (this.priority == null ? other.priority != null : !this.priority.equals(other.priority)) {
        return false;
      }
      
      if(refAnnot){
        if (this.refSuggestion != other.refSuggestion && (this.refSuggestion == null || !this.refSuggestion.equals(other.refSuggestion))) {
          return false;
        }
      }

      if ((this.simpleType == null) ? (other.simpleType != null) : !this.simpleType.equalsIgnoreCase(other.simpleType)) {
        return false;
      }
      if(this.simpleType != null){
        if(this.simpleType.equalsIgnoreCase("String") || this.simpleType.equalsIgnoreCase("Duration")){
          if ((this.stringValue == null) ? (other.stringValue != null) : !this.stringValue.equals(other.stringValue)) {
            return false;
          }
        }
        else if(this.simpleType.equalsIgnoreCase("Binary")){
           if (!Arrays.equals(this.binValue, other.binValue)) {
            return false;
          }
        }
        else if(this.simpleType.equalsIgnoreCase("Date") ||
                this.simpleType.equalsIgnoreCase("DateTime") ||
                this.simpleType.equalsIgnoreCase("Time") ||
                this.simpleType.equalsIgnoreCase("Integer") ||
                this.simpleType.equalsIgnoreCase("Decimal") ||
                this.simpleType.equalsIgnoreCase("Boolean")){
          if (this.getValue() != other.getValue() && (this.getValue() == null || !this.getValue().equals(other.getValue()))) {
            return false;
          }
        }
        else if(this.simpleType.equalsIgnoreCase("SuggestionLink")){
          if (this.linkedSuggestion != other.linkedSuggestion &&
                  (this.linkedSuggestion == null || !this.linkedSuggestion.equals(other.linkedSuggestion))) {
            return false;
          }
        }
        else if(this.simpleType.equalsIgnoreCase("AnnotationLink")){
          if (this.linkedAnnotation != other.linkedAnnotation &&
                  (this.linkedAnnotation == null || !this.linkedAnnotation.equals(other.linkedAnnotation))) {
            return false;
          }
        }
        else if(this.simpleType.equalsIgnoreCase("NestedSuggestion")){
          if (this.nestedSuggestion != other.nestedSuggestion &&
                  (this.nestedSuggestion == null || !this.nestedSuggestion.equals(other.nestedSuggestion))) {
            if (this.nestedSuggestion != null && other.nestedSuggestion != null) {
              if (!this.nestedSuggestion.contentEquals(other.nestedSuggestion)) {
                return false;
              }
            } else {
              return false;
            }
          }
        }
        else if(this.simpleType.equalsIgnoreCase("Person")){
          if (this.user != other.user && (this.user == null || !this.user.equals(other.user))) {
            return false;
          }
        }
        else if(this.simpleType.equalsIgnoreCase("GeoPoint")){
          if (this.geoLat != other.geoLat && (this.geoLat == null || !this.geoLat.equals(other.geoLat))) {
            return false;
          }
          if (this.geoLong != other.geoLong && (this.geoLong == null || !this.geoLong.equals(other.geoLong))) {
            return false;
          }
        }
        else if (this.simpleType.equalsIgnoreCase("Entity")) {
          if (this.uri != other.uri && (this.uri == null || !this.uri.equals(other.uri))) {
            return false;
          }
          if (this.entityType != other.entityType && (this.entityType == null || !this.entityType.equals(other.entityType))) {
            return false;
          }
          if (this.stringValue != other.stringValue && (this.stringValue == null || !this.stringValue.equals(other.stringValue))) {
            return false;
          }
          if (this.entityType != other.entityType && (this.entityType == null || !this.entityType.equals(other.entityType))) {
            return false;
          }
          if (this.entityVisualURI != other.entityVisualURI && (this.entityVisualURI == null || !this.entityVisualURI.equals(other.entityVisualURI))) {
            return false;
          }
          if (this.textValue != other.textValue && (this.textValue == null || !this.textValue.equals(other.textValue))) {
            return false;
          }
        }
        //AnyAnnotation, Text, URI, Image
        else{
          if ((this.getValue() == null) ? (other.getValue() != null) : (!this.getValue().equals(other.getValue()))) {
            return false;
          }
        }
      }
      else{
        if ((this.getValue() == null) ? (other.getValue() != null) : (!this.getValue().equals(other.getValue()))) {
          return false;
        }
      }
      return true;
    }
    return false;
  }  // contentEquals()


  /**
   * Gets value of the attribute
   *
   * @return value of the attribute
   */
  @Override
  public abstract Object getValue();


  /**
   * Sets value of the attribute. Value should already be a native java value.
   *
   * For example, for attribute of type Integer value should be integer, not
   * string. If you want to set value and parse that value, you should use
   * setRawValue
   *
   * @param value new value of the attribute
   */
  @Override
  public abstract void setValue(Object value);


  /**
   * Parses provided value and sets that value as a value of attribute
   *
   * @param value new value of the attribute in raw form from XML
   */
  public abstract void setRawValue(String value) throws IllegalArgumentException;

  /**
   * Checks if attribute value is empty or default value
   *
   * @return true, if attribute value is empty
   */
  public boolean isEmpty() {
    return this.getValue() == null;
  }

  /**
   * 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 SugBaseAttribute)) {
      return false;
    }
    SugBaseAttribute other = (SugBaseAttribute) object;
    if ((this.id == null && other.id != null) || (this.id != null && !this.id.equals(other.id))) {
      return false;
    }
    return true;
  }

  /**
   * Gets textual comment
   *
   * @return Returns textual comment
   */
  public String getComment() {
    return comment;
  }

  /**
   * Sets textual comment
   *
   * @param comment Textual comment
   */
  public void setComment(String comment) {
    this.comment = comment;
  }

  @Override
  public String toString() {
    return "cz.vutbr.fit.knot.annotations.entity.Attribute[id=" + id + "]";
  }

  @Override
  public int hashCode() {
    int hash = 0;
    hash += (id != null ? id.hashCode() : 0);
    return hash;
  }

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

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

  /**
   * Gets name of simple type of attribute
   *
   * @return Returns name of simple type of attribute
   */
  @Override
  public String getSimpleType() {
    return simpleType;
  }

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

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

  /**
   * Sets id of suggestion to which this attribute belongs
   *
   * @param suggestion id of suggestion to which this attribute belongs
   */
  public void setSuggestion(int suggestion) {
    this.suggestion = suggestion;
  }

  /**
   * Gets annotation to which this attribute belongs
   *
   * @return Returns annotation to which this attribute belongs
   */
  public Suggestion getRefSuggestion() {
    return refSuggestion;
  }

  /**
   * Sets suggestion to which this attribute belongs
   *
   * @param value Suggestion to which this attribute belongs
   */
  public void setRefSuggestion(Suggestion value) {
    this.refSuggestion = value;
  }

  /**
   * Sets suggestion to which this attribute belongs
   *
   * @param value Suggestion to which this attribute belongs
   */
  @Override
  public void setRefSecSuggestion(SecSuggestion value) {
    if (value instanceof Suggestion) {
      this.refSuggestion = (Suggestion) value;
    }
  }

  /**
   * Gets structured type of attribute (type of annotation)
   *
   * @return Returns structured type of attribute (type of annotation)
   */
  public AnnotType getAttributeType() {
    return attributeType;
  }

  /**
   * Sets structured type of attribute (type of annotation)
   *
   * @param attributeType Structured type of attribute (type of annotation)
   */
  public void setAttributeType(AnnotType attributeType) {
    this.attributeType = attributeType;
  }

  /**
   * Gets nested suggestion
   *
   * @return Returns nested suggestion
   */
  public Suggestion getNestedSuggestion() {
    return nestedSuggestion;
  }
  
  /**
   * Gets nested annotation
   *
   * @return Returns nested annotation
   */
  public Annotation getNestedAnnotation() {
    return nestedAnnotation;
  }

  /**
   * Gets tmpID of the nested suggestion
   *
   * @return Returns tmpID of the nested suggestion
   */
  public String getNestedSuggID() {
    return nestedSugg;
  }
  
  /**
   * Sets tmpID of the nested suggestion
   */
  public void setNestedSuggID(String nest) {
    if(nest != null && !nest.isEmpty()){
      this.nestedAnnot = null;
    }
    this.nestedSugg = nest;
  }
  
  /**
   * Gets tmpID of the nested annotation
   *
   * @return Returns tmpID of the nested annotation
   */
  public String getNestedAnnotID() {
    return nestedAnnot;
  }
  
  /**
   * Sets tmpID of the nested annotation
   */
  public void setNestedAnnotID(String nestAnnot) {
    if(nestAnnot != null && !nestAnnot.isEmpty()){
      this.nestedSugg = null;
    }
    this.nestedAnnot = nestAnnot;
  }

  /**
   * Sets nested suggestion
   *
   * @param nestedSuggestion Nested suggestion
   */
  public void setNestedSuggestion(Suggestion nestedSuggestion) {
    if(nestedSuggestion != null){
      this.nestedAnnotation = null;
    }
    this.nestedSuggestion = nestedSuggestion;
  }
  
  /**
   * Sets nested annotation
   *
   * @param nestedAnnotation Nested annotation
   */
  public void setNestedAnnotation(Annotation nestedAnnotation) {
    if(nestedAnnotation != null){
      this.nestedSuggestion = null;
    }
    this.nestedAnnotation = nestedAnnotation;
  }

  /**
   * Gets id of attribute of annotation
   *
   * @return returns id of attribute of annotation
   */
  public Integer getId() {
    return id;
  }

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

  /**
   * Gets id of structured type of attribute (type of annotation)
   *
   * @return Returns id of structured type of attribute (type of annotation)
   */
  public Integer getType() {
    return type;
  }

  /**
   * Sets id of structured type of attribute (type of annotation)
   *
   * @param type id of structured type of attribute (type of annotation)
   */
  public void setType(Integer type) {
    this.type = type;
  }

  /**
   * Checks if attribute is structured. Structured attribute is for example
   * GeoPointAttribute
   *
   * @return true, if attribute is structured
   */
  public boolean isStructured() {
    return false;
  }

  /**
   * Sets attribute value of type Person (user)
   *
   * @param user Attribute value of type Person (user)
   */
  public void setUser(User user) {
    this.user = user;
  }

  /**
   * Gets attribute value of type Person (user)
   *
   * @return Returns attribute value of type Person (user)
   */
  public User getUser() {
    return user;
  }

  /**
   * Sets attribute value of uri
   *
   * @param uri Attribute value of uri
   */
  public void setUri(String uri){
    this.uri = uri;
  }

  /**
   * Gets attribute value of uri
   *
   * @return Attribute value of uri
   */
  public String getUri(){
    return uri;
  }
  
  /**
   * Sets attributes URI in ontology
   * 
   * @param uriInOntology Uri in ontology
   */
  public void setUriInOntology(String uriInOntology){
    this.uriInOntology = uriInOntology;
  }
  
  /**
   * Gets attributes URI in ontology
   * 
   * @return URI in ontology
   */
  public String getUriInOntology(){
    return uriInOntology;
  }

  /**
   * Stores attribute data into the JSON string representation. String could be
   * processed on the NLP server. Method stores IDs of referenced structures, so
   * when creating an object from this representation, one must look up for
   * structures by IDs.
   *
   * @return String representation of JSON Attribute data
   */
  public String toJSONString() {
    StringBuilder sb = new StringBuilder("{\"attName\":\"");
    sb.append(this.name);
    sb.append("\",\"simpleType\":\"");
    sb.append(this.simpleType);

    sb.append("\",\"attValue\":\"");
    if (this.simpleType.equals("String")) {
      sb.append(this.stringValue);
    } else if (this.simpleType.equals("Image") || this.simpleType.equals("URI")) {
      sb.append(this.uri);
    } else if (this.simpleType.equals("Integer")) {
      if (this.intValue != null) {
        sb.append(this.intValue.toString());
      } else {
        sb.append(this.intValue);
      }
    } else if (this.simpleType.equals("Boolean")) {
      sb.append(this.boolVAlue.toString());
    } else if (this.simpleType.equals("Text")) {
      if (this.textValue == null) {
        sb.append("");
      }
      else {
        sb.append(this.textValue);
      }
    } else if (this.simpleType.equals("Decimal")) {
      sb.append(this.decValue.toString());
    } else if (simpleType.equals("DateTime")) {
      sb.append(Util.toRFC3339Date(dateValue));
    } else if (simpleType.equals("Date")) {
      sb.append(Util.toRFC3339DateOnly(dateValue));
    } else if (simpleType.equals("Time")) {
      sb.append(Util.toRFC3339Time(dateValue));
    } else if (this.simpleType.equals("Binary")) {
      if (this.binValue != null) {
        sb.append(org.apache.commons.codec.binary.Base64.encodeBase64String(this.binValue));
      }
    } else if (this.simpleType.equals("AnyAnnotation")) {
      sb.append("null");
    } else if (this.simpleType.equals("GeoPoint") || this.simpleType.equals("geoPoint")) {
      // no value has been provided; send empty attribute value
      if (this.geoLat == null || this.geoLong == null) {
        sb.append("null");
      }
      else {
        sb.append(this.geoLat.toString());
        sb.append(' ');
        sb.append(this.geoLong.toString());
      }
    } else if(this.simpleType.equals("entity") || this.simpleType.equals("Entity")){
      if(this.uri.isEmpty() || this.uri == null){
        sb.append("null");
      }else{
        sb.append(((EntityAttribute.Entity)getValue()).toJSONString());
      }
    }else if (this.simpleType.equals("Duration")) {
      sb.append(this.stringValue);
    }
    sb.append("\",\"nestedURI\":\"");
    if (this.nestedSuggestion != null) {
      sb.append(this.nestedSuggestion.getURI());
      this.nestedSugg = this.nestedSuggestion.getId().toString();
    }
    else {
      sb.append("null");
    }
    sb.append("\",\"nestedID\":\"null\",\"linkedURI\":\"");
    if (this.linkedSuggestion != null) {
      sb.append(this.linkedSuggestion.getURI());
      this.linkedSugg = this.linkedSuggestion.getId();
    }
    else {
      sb.append("null");
    }
    sb.append("\",\"linkedID\":\"null\",\"structuredType\":");
    if (this.linkedSuggestion != null && this.linkedSuggestion.getAnnotType() != null) {
      sb.append("\"").append(this.linkedSuggestion.getAnnotType().getUri().split(AppBean.getBaseTypeUri())[1].split("g[0-9]*/", 2)[1]).append("\"");
    }
    else if (this.nestedSuggestion != null && this.nestedSuggestion.getAnnotType() != null) {
      sb.append("\"").append(this.nestedSuggestion.getAnnotType().getUri().split(AppBean.getBaseTypeUri())[1].split("g[0-9]*/", 2)[1]).append("\"");
    }
    else {
      sb.append("null");
    }
    sb.append("}");
    return sb.toString();
  }  // toJSONString()
  
  /**
   * Copies data from annotation attribute into this attribute
   * Linked and nested annotation and linked and nested suggestion are not copied.
   * 
   * @param ba attribute of the annotation
   */
  public void updateFromBaseAttribut(BaseAttribute ba){
    this.name = ba.getName();
    this.simpleType = ba.getSimpleType();
    if(this.simpleType.equalsIgnoreCase("NestedAnnotation")){
      this.simpleType = "NestedSuggestion";
    }
    if(this.simpleType.equalsIgnoreCase("AnnotationLink")){
      this.simpleType = "SuggestionLink";
    }
    this.type = ba.getType();
    this.uri = ba.getUri();
    this.uriInOntology = ba.getUriInOntology();
    this.attributeType = ba.getAttributeType();
    this.comment = ba.getComment();
    this.entityType = ba.getEntityType();
    this.entityVisualURI = ba.getEntityVisualURI();
    this.binValue = ba.getBinValue();
    this.boolVAlue = ba.getBoolValue();
    this.dateValue = ba.getDateValue();
    this.decValue = ba.getDecValue();
    this.geoLat = ba.getGeoLat();
    this.geoLong = ba.getGeoLong();
    this.intValue = ba.getIntValue();
    this.stringValue = ba.getStringValue();
    this.textValue = ba.getTextValue();
    this.userValue = ba.getUserValue();
    this.priority = ba.getPriority();
    this.entityAdditionalAttributes = new ArrayList<SugEntityAdditionalAttribute>();
    if (ba.getEntityAdditionalAttributes() != null && this instanceof SugEntityAttribute) {
      Iterator<EntityAdditionalAttribute> eaIt = ba.getEntityAdditionalAttributes().iterator();
      while (eaIt.hasNext()) {
        EntityAdditionalAttribute at = eaIt.next();
        SugEntityAdditionalAttribute newAt = new SugEntityAdditionalAttribute(at.getName(), at.getType(), at.getStringValue(), (SugEntityAttribute) this);
        newAt.setPriority(at.getPriority());
        this.entityAdditionalAttributes.add(newAt);
      }
    }

    this.linkedAnnotation = null;
    this.nestedAnnotation = null;
    this.linkedSuggestion = null;
    this.nestedSuggestion = null;
  }  // updateFromBaseAttribut()
  
  /**
   * Set this attribute from alternative attribute
   * 
   * @param attr attribute of the alternative
   */
  public void updateFromAlternativeAttribut(AlternativeAttribute attr){
    this.name = attr.getName();
    this.simpleType = attr.getSimpleType();
    if(this.simpleType.equalsIgnoreCase("NestedAnnotation")){
      this.simpleType = "NestedSuggestion";
    }
    if(this.simpleType.equalsIgnoreCase("AnnotationLink")){
      this.simpleType = "SuggestionLink";
    }
    this.type = attr.getType();
    this.uri = attr.getUri();
    this.uriInOntology = attr.getUriInOntology();
    this.attributeType = attr.getAttributeType();
    this.comment = attr.getComment();
    this.entityType = attr.getEntityType();
    this.entityVisualURI = attr.getEntityVisualURI();
    this.binValue = attr.getBinValue();
    this.boolVAlue = attr.getBoolValue();
    this.dateValue = attr.getDateValue();
    this.decValue = attr.getDecValue();
    this.geoLat = attr.getGeoLat();
    this.geoLong = attr.getGeoLong();
    this.intValue = attr.getIntValue();
    this.stringValue = attr.getStringValue();
    this.textValue = attr.getTextValue();
    this.userValue = attr.getUserValue();
    this.priority = attr.getPriority();

    this.entityAdditionalAttributes = new ArrayList<SugEntityAdditionalAttribute>();
    if (attr.getEntityAdditionalAttributes() != null) {
      Iterator<AltEntityAdditionalAttribute> aeatit = attr.getEntityAdditionalAttributes().iterator(); 
      if (this.getClass().equals(EntityAttribute.class)) {
        while (aeatit.hasNext()) {
          AltEntityAdditionalAttribute aeat = aeatit.next(); 
          SugEntityAdditionalAttribute nAt = new SugEntityAdditionalAttribute(aeat.getName(), aeat.getType(), aeat.getStringValue(), (SugEntityAttribute) this); 
          nAt.setPriority(aeat.getPriority()); 
          this.entityAdditionalAttributes.add(nAt); 
        } 
      } else if (!attr.getEntityAdditionalAttributes().isEmpty()) { 
        if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
          Logger.getLogger(BaseAttribute.class.getName()).log(Level.SEVERE, "Trying to update attribute using attribute with different type."); 
        }
      } 
    }
    
    this.linkedAnnotation = null;
    this.nestedAnnotation = null;
    this.linkedSuggestion = null;
    this.nestedSuggestion = null;
  }  // updateFromAlternativeAttribut()
  
  /**
   * Gets attribute value of entityType
   *
   * @return Attribute value of entityType
   */
  public String getEntityType(){
    return this.entityType;
  }
  
  /**
   * Sets attribute value of entityType
   *
   * @param entityType Attribute value of entityType
   */
  public void setEntityType(String entityType) {
    this.entityType = entityType;
  }

  /**
   * Gets attribute value of entityVisualURI
   *
   * @return Attribute value of entityVisualURI
   */
  public String getEntityVisualURI(){
    return this.entityVisualURI;
  }
  
  /**
   * Sets attribute value of entityVisualURI
   *
   * @param entityVisualURI New value of entityVisualURI
   */
  public void setEntityVisualURI(String entityVisualURI) {
    this.entityVisualURI = entityVisualURI;
  }
  
  /**
   * Gets attribute value of boolean
   *
   * @return Attribute value of boolean
   */
  public Boolean getBoolValue(){
    return this.boolVAlue;
  }
  
  /**
   * Gets attribute value of binary
   *
   * @return Attribute value of binary
   */
  public byte[] getBinValue(){
    return this.binValue;
  }
  
  /**
   * Gets attribute value of date
   *
   * @return Attribute value of date
   */
  public Date getDateValue(){
    return this.dateValue;
  }

  /**
   * Gets attribute value of decimal
   *
   * @return Attribute value of decimal
   */
  @Override
  public BigDecimal getDecValue(){
    return this.decValue;
  }

  /**
   * Gets attribute value of geo latitude
   *
   * @return Attribute value of geo latitude
   */
  public BigDecimal getGeoLat(){
    return this.geoLat;
  }

  /**
   * Gets attribute value of geo longitude
   *
   * @return Attribute value of geo longitude
   */
  public BigDecimal getGeoLong(){
    return this.geoLong;
  }
  
  /**
   * Gets attribute value of integer
   *
   * @return Attribute value of integer
   */
  public Integer getIntValue(){
    return this.intValue;
  }

  /**
   * Gets attribute value of string
   *
   * @return Attribute value of string
   */
  @Override
  public String getStringValue(){
    return this.stringValue;
  }
  
  /**
   * Gets attribute value of text
   *
   * @return Attribute value of text
   */
  @Override
  public String getTextValue(){
    return this.textValue;
  }


  /**
   * Gets attribute value of user
   *
   * @return Attribute value of user
   */
  public Integer getUserValue(){
    return this.userValue;
  }
  
  /**
   * Gets attribute value of linked annotation
   *
   * @return Attribute value of user
   */
  public Annotation getLinkedAnnotation(){
    return this.linkedAnnotation;
  }
  
  /**
   * Gets attribute value of linked suggestion
   *
   * @return Attribute value of user
   */
  public Suggestion getLinkedSuggestion(){
    return this.linkedSuggestion;
  }
    
  /**
   * Sets attributes linked suggestion
   * @param suggestion Linked suggestion
   */
  public void setLinkedSuggestion(Suggestion suggestion){
    this.linkedSuggestion = suggestion;
  }
  
  /**
   * Gets attribute priority
   * 
   * @return Returns attribute priority
   */
  @Override
  public Integer getPriority() {
    return priority;
  }

  /**
   * Sets attribute priority
   * 
   * @param priority Attribute priority
   */
  @Override
  public void setPriority(Integer priority) {
    this.priority = priority;
  }

  /**
   * Gets list of entity additional attribute
   * 
   * @return List of entity additional attribute
   */
  public List<SugEntityAdditionalAttribute> getEntityAdditionalAttributes() {
    return entityAdditionalAttributes;
  }

  /**
   * Sets list of entity additional attribute
   * 
   * @param entityAdditionalAttributes List of entity additional attribute
   */
  public void setEntityAdditionalAttributes(List<SugEntityAdditionalAttribute> entityAdditionalAttributes) {
    this.entityAdditionalAttributes = entityAdditionalAttributes;
  }
  
  /**
   * Copies Attribute class attributes to a new instance
   * 
   * @param ba attribute of the annotation
   */
  public void updateFromBaseAttributeAll(SugBaseAttribute ba){
    this.attributeType = ba.getAttributeType();
    this.binValue = ba.getBinValue();
    this.boolVAlue = ba.getBoolValue();
    this.comment = ba.getComment();
    this.dateValue = ba.getDateValue();
    this.decValue = ba.getDecValue();
    this.entityType = ba.getEntityType();
    this.entityVisualURI = ba.getEntityVisualURI();
    this.geoLat = ba.getGeoLat();
    this.geoLong = ba.getGeoLong();
    this.id = ba.getId();
    this.intValue = ba.getIntValue();
    this.linkedAnnot = ba.linkedAnnot;
    this.linkedAnnotation = ba.getLinkedAnnotation();
    this.linkedSugg = ba.linkedSugg;
    this.nestedSuggestion = ba.getNestedSuggestion();
    this.name = ba.getName();
    this.nestedAnnot = ba.nestedAnnot;
    this.nestedAnnotation = ba.getNestedAnnotation();
    this.nestedSugg = ba.nestedSugg;
    this.linkedSuggestion = ba.getLinkedSuggestion();
    this.refSuggestion = ba.refSuggestion;
    this.stringValue = ba.getStringValue();
    this.suggestion = ba.suggestion;
    this.textValue = ba.getTextValue();
    this.type = ba.getType();
    this.uri = ba.getUri();
    this.uriInOntology = ba.getUriInOntology();
    this.user = ba.user;
    this.userValue = ba.getUserValue();
    this.priority = ba.getPriority();
  }

  /**
   * Sets boolean value of attribute
   * 
   * @param boolVAlue New boolean value of attribute
   */
  public void setBoolVAlue(Boolean boolVAlue) {
    this.boolVAlue = boolVAlue;
  }
  
}  // public abstract class SugBaseAttribute