EntityAttribute.java

Go to the documentation of this file.

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

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

import cz.vutbr.fit.knot.annotations.app.AppBean;
import cz.vutbr.fit.knot.annotations.app.Constants;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;

/**
 * @file EntityAttribute.java
 *
 * @brief Class representing vocabulary entity attribute.
 */

/**
 * Class representing vocabulary entity attribute.
 *
 * @brief Class representing vocabulary entity attribute.
 */
@Entity
@DiscriminatorValue("Entity")
@NamedQueries({
    @NamedQuery(name = "Attribute.findByEntityName", query = "SELECT a FROM Attribute a WHERE a.stringValue = :name"),
    @NamedQuery(name = "Attribute.findByEntityType", query = "SELECT a FROM Attribute a WHERE a.entityType = :type"),
    @NamedQuery(name = "Attribute.findByEntityUri", query = "SELECT a FROM Attribute a WHERE a.uri = :uri")
})
public class EntityAttribute extends StructuredAttribute{

  /**
   * Constructor.
   */
  public EntityAttribute(){
    this.simpleType = "Entity";
  }
  
  /**
   * Constructor.
   * 
   * @param name name of vocabulary entity
   * @param type type of vocabulary entity
   * @param URI uri of vocabulary entity
   * @param visualRepresentation uri of visual representation of vocabulary entity
   * @param description description of vocabulary entity
   */
  public EntityAttribute(String name, String type, String URI, String visualRepresentation, String description){
    this.entityType = type;
    this.stringValue = name;
    this.simpleType = "Entity";
    this.uri = URI;
    this.entityVisualURI = visualRepresentation;
    this.textValue = description;
  }
  
  /**
   * Gets additional attributes of this entity
   * 
   * @return Returns additional attributes of this entity
   */
  @Override
  public List<EntityAdditionalAttribute> getEntityAdditionalAttributes() {
    return this.entityAdditionalAttributes;
  }

  /**
   * Sets additional attributes of this entity
   * 
   * @param EntityAdditionalAttributes Additional attributes of this entity
   */
  public void setEntityAdditionalAttributes(ArrayList<EntityAdditionalAttribute> EntityAdditionalAttributes) {
    this.entityAdditionalAttributes = EntityAdditionalAttributes;
  }
  
  /**
   * Sets entity description
   * 
   * @param textValue New description
   */
  public void setDescription(String textValue) {
    this.textValue = textValue;
  }

  /**
   * Gets entity description
   * 
   * @return Returns entity description
   */
  public String getDescription() {
    return textValue;
  }
  
  /**
   * Sets entity name
   * 
   * @param name New entity name
   */
  public void setEntityName(String name) {
    this.stringValue = name;
  }
  
  /**
   * Gets value of attribute in XML (serailized informationa about entity)
   * 
   * @return Returns value of attribute in XML
   */
  @Override
  protected String getXmlBody() {
    StringBuilder result = new StringBuilder("<entity");
    
    if(this.stringValue != null && !this.stringValue.isEmpty()){
      result.append(" name=\"");
      result.append(escapeHTML(this.stringValue));
      result.append("\"");
    }
    
    if(this.uri != null && !this.uri.isEmpty()){
      result.append(" uri=\"");
      result.append(escapeHTML(this.uri));
      result.append("\"");
    }
    
    if(this.entityType != null && !this.entityType.isEmpty()){
      result.append(" type=\"");
      result.append(this.entityType);
      result.append("\"");
    }
    
    if(this.entityVisualURI != null && !this.entityVisualURI.isEmpty()){
      result.append(" visualRepresentation=\"");
      if (this.entityVisualURI != null && !this.entityVisualURI.startsWith("http")) {
        result.append(AppBean.getKBImagePrefix());
      }
      result.append(escapeHTML(this.entityVisualURI));
      result.append("\"");
    }
    
    if(this.textValue != null && !this.textValue.isEmpty()){
      result.append("><![CDATA[");
      result.append(this.textValue);
      result.append("]]></entity>");
    }else{
      result.append("/>");
    }
    
    return result.toString();
  }
  
  /**
   * Method converts the object into an XML string (for protocol 1.x).
   * 
   * @return XML string that represents this object
   */
  public String toXmlString(){

    StringBuilder result = new StringBuilder("<entity");
    
    if (this.stringValue != null && !this.stringValue.isEmpty()) {
      result.append(" name=\"");
      result.append(escapeHTML(this.stringValue));
      result.append("\"");
    }

    if (this.uri != null && !this.uri.isEmpty()) {
      result.append(" uri=\"");
      result.append(escapeHTML(this.uri));
      result.append("\"");
    }
    
    if (this.entityType != null && !this.entityType.isEmpty()) {
      result.append(" type=\"");
      result.append(this.entityType);
      result.append("\"");
    }

    if (this.entityVisualURI != null && !this.entityVisualURI.isEmpty()) {
      result.append(" visualRepresentation=\"");
      if (this.entityVisualURI != null && !this.entityVisualURI.startsWith("http")) {
        result.append(AppBean.getKBImagePrefix());
      }
      result.append(escapeHTML(this.entityVisualURI));
      result.append("\"");
    }
    
    if (this.textValue != null && !this.textValue.isEmpty()) {
      result.append("><![CDATA[");
      result.append(this.textValue);
      result.append("]]></entity>");
    } else {
      result.append("/>");
    }
    
    return result.toString();
  }  // toXmlString()
  
  /**
   * Returns serialized informations about attribute of annotation in XML 
   * for protocol v. 2.0 without header (target and attribute specification 
   * triples)
   *
   * @return Returns serialized informations about attribute of annotation in XML
   */
  public String toXMLStringWHV2(){
    StringBuilder result = new StringBuilder();
    
    if(this.uri == null){
      // empty entity
      result.append("<trix:uri>");
      result.append("http://knot.fit.vutbr.cz/annotations/knotOAExtension#anyEntity");
      result.append("</trix:uri></trix:triple>");
      return result.toString();
    }
    
    result.append("<trix:uri>");
    result.append(escapeHTML(this.uri));
    result.append("</trix:uri></trix:triple>");
    
    // trix with entity type
    result.append("<trix:triple><trix:uri>");
    result.append(escapeHTML(this.uri));
    result.append("</trix:uri><trix:uri>rdf:type</trix:uri><trix:name>");
    result.append(entityType);
    result.append("</trix:name></trix:triple>");

    // trix with name
    if(stringValue != null && !stringValue.isEmpty()){
      result.append("<trix:triple><trix:uri>");
      result.append(escapeHTML(this.uri));
      result.append("</trix:uri><trix:name>name</trix:name><trix:typedLiteral datatype=\"http://www.w3.org/2001/XMLSchema#string\">");
      result.append(escapeHTML(stringValue));
      result.append("</trix:typedLiteral></trix:triple>");
    }
    
    // trix with description
    if(textValue != null && !textValue.isEmpty()){
      result.append("<trix:triple><trix:uri>");
      result.append(escapeHTML(this.uri));
      result.append("</trix:uri><trix:name>description</trix:name><trix:typedLiteral datatype=\"http://www.w3.org/2001/XMLSchema#string\">");
      result.append(escapeHTML(textValue));
      result.append("</trix:typedLiteral></trix:triple>");
    }
    
    // trix with image
    if(entityVisualURI != null && !entityVisualURI.isEmpty()){
      result.append("<trix:triple><trix:uri>");
      result.append(escapeHTML(this.uri));
      result.append("</trix:uri><trix:name>image</trix:name><trix:typedLiteral datatype=\"http://knot.fit.vutbr.cz/annotations/knotOAExtension#imageUri\">");
      result.append(escapeHTML(entityVisualURI));
      result.append("</trix:typedLiteral></trix:triple>");
    }
    
    if(entityAdditionalAttributes != null && !entityAdditionalAttributes.isEmpty()){
      Collections.sort(entityAdditionalAttributes);
      Iterator additionalAttrIt = entityAdditionalAttributes.iterator();
      while(additionalAttrIt.hasNext()){
        EntityAdditionalAttribute actualAttr = (EntityAdditionalAttribute) additionalAttrIt.next();
        result.append(actualAttr.toXmlStringV2());
      }
    }
        
    return result.toString();
  }
  
  /**
   * Method converts the object into an XML string for prupose of protocol version 2.
   * 
   * @return XML string that represents this object
   */
  public String toXMLResponseStringV2(){    
    StringBuilder result = new StringBuilder("<entity");
    boolean hasContent = false;
    //Name
    result.append(" name=\"");
    if (this.stringValue != null && !this.stringValue.isEmpty()) {
      result.append(escapeHTML(this.stringValue));
    }
    result.append("\"");

    // Uri
    result.append(" uri=\"");
    if (this.uri != null && !this.uri.isEmpty()) {
      result.append(escapeHTML(this.uri));
    }
    result.append("\"");

    // Type
    result.append(" type=\"");
    if (this.entityType != null && !this.entityType.isEmpty()) {
      result.append(this.entityType);
    }
    result.append("\"");

    //Image
    result.append(" image=\"");
    if (this.entityVisualURI != null && !this.entityVisualURI.isEmpty()) {
      if (!this.entityVisualURI.startsWith("http")) {
        result.append(AppBean.getKBImagePrefix());
      }
      result.append(escapeHTML(this.entityVisualURI));
    }

    if (this.entityAdditionalAttributes != null && !this.entityAdditionalAttributes.isEmpty()) {
      result.append("\">");
      Collections.sort(entityAdditionalAttributes);
      Iterator<EntityAdditionalAttribute> addtitionalAttrsIt = entityAdditionalAttributes.iterator();
      while (addtitionalAttrsIt.hasNext()) {
        EntityAdditionalAttribute a = addtitionalAttrsIt.next();
        if (a.getName() != null && a.getName().equals("disambiguation")) {
          a.setName("Disambiguation");  // small fix of special attribute for case sensitive clients
        }
        result.append(a.toXMLResponseStringV2());
      }

      hasContent = true;
    }

    // Description
    if (this.textValue != null && !this.textValue.isEmpty()) {
      if (!hasContent) {
        result.append("\">");
      }
      result.append("<description><![CDATA[").append(this.textValue).append("]]></description>");
      hasContent = true;
    }

    if (hasContent) {
      result.append("</entity>");
    } else {
      result.append("\"/>");
    }

    return result.toString();
  }

  /**
   * Sets value of attribute using given parameters from raw input
   * 
   * @param values Parameters from raw input
   * @throws IllegalArgumentException 
   */
  @Override
  public void setRawValues(Object values) throws IllegalArgumentException {
    @SuppressWarnings("unchecked") ArrayList<Object> valuesArray =  (ArrayList<Object>)values;
    @SuppressWarnings("unchecked") Map<String,String> parameters = (Map<String,String>)valuesArray.get(1);
    String value = (String)valuesArray.get(2);
    
    if(parameters.get("name") != null){
      this.stringValue = parameters.get("name");
    }
    
    if(parameters.get("type") != null){
      this.entityType = parameters.get("type");
    }
    
    if(parameters.get("uri") != null){
      this.uri = parameters.get("uri");
    }
    
    if(parameters.get("visualRepresentation") != null){
      this.entityVisualURI = parameters.get("visualRepresentation");
    }
    
    if(value != null){
      this.textValue = value;
    }    
  }
  
  
  /**
   * The method converts HTML forbidden symbols to their safe version.
   * 
   * @param s string that contains forbiden symbols
   * @return HTML safe string
   */
  private String escapeHTML(String s){
      StringBuilder sb = new StringBuilder();
      int n = s.length();
      for (int i = 0; i < n; i++) {
         char c = s.charAt(i);
         switch (c) {
            case '<': sb.append("&lt;"); break;
            case '>': sb.append("&gt;"); break;
            case '&': sb.append("&amp;"); break;
            case '"': sb.append("&quot;"); break;
            case '\'': sb.append("&apos;");break;
            default:  sb.append(c); break;
         }
      }
      return sb.toString();
   }

  /**
   * Gets name of this attribute to XML
   * 
   * @return Name of this attribute to XML
   */
  @Override
  public String getXmlAttributeName() {
    return "entity";
  }

  /**
   * Gets attribute value
   * 
   * @return Returns attribute value
   */
  @Override
  public Object getValue() {
    return new Entity(this.entityType,this.stringValue,this.uri,this.entityVisualURI, this.textValue);
  }

  /**
   * Sets attribute value
   * 
   * @param value Attribute value (Entity)
   */
  @Override
  public void setValue(Object value) {
    this.entityType = ((Entity)value).getType();
    this.stringValue = ((Entity)value).getName();
    this.uri = ((Entity)value).getURI();
    this.entityVisualURI = ((Entity)value).getVisualRepresentation();
    this.textValue = ((Entity)value).getDescription();           
  }

  /**
   * The method sets the parameters from a string in JSON.
   * 
   * @param value String parsed from JSON
   */
  public void setFromJSONStringValue(String value){
    Entity ent = new Entity();
    ent.fromJSONString(value);
    setValue(ent);
  }
  
  /**
   * Sets URI of visual representation of entity
   * 
   * @param entityVisualURI URI of visual representation of entity
   */
  public void setEntityVisualURI(String entityVisualURI) {
    this.entityVisualURI = entityVisualURI;
  }

  /**
   * Sets type of entity
   * 
   * @param entityType Type of entity
   */
  public void setEntityType(String entityType) {
    this.entityType = entityType;
  }

  /**
   * Sets string value of attribute
   * 
   * @param stringValue Gets string value of attribute 
   */
  public void setStringValue(String stringValue) {
    this.stringValue = stringValue;
  }
  
  /**
   * Encode values of the attribute to one string
   *
   * This method can be used for generating value for JSON object
   *
   * @return Encoded values of the attribute in one string
   */
  @Override
  public String toString() {
    return ((Entity)getValue()).toJSONString();
  }

  /**
   * Gets URI addres in ontology for this type of attribute
   *
   * @return Return URI addres in ontology for this type of attribute.
   */
  @Override
  public String getTypeOntologyUri(){
      return Constants.ENTITY_URI;
  }
  
  /**
   * Class holds values of dictionary entity.
   * 
   * @brief Class holds values of dictionary entity.
   */
  public static class Entity {
    
    /** type of vocabulary entity */
    private String type;
    /** name of vocalbulary entity */
    private String name;
    /** uri of vocabulary entity */
    private String URI;
    /** uri of image that entity represents */
    private String visualRepresentation;
    /** description of vocabulary entity */
    private String description;
    
    /** Array of forbidden JSON characters */
    public static final ArrayList<String> UNESACPED_CHARS = new ArrayList<String>(Arrays.asList(
      "\\",      
      "\"",
      "/" ,
      "=" ,
      ","
    ));
    
    /** Array escaped characters of forbidden JSON characters */
    public static final ArrayList<String> ESCAPED_CHARS = new ArrayList<String>(Arrays.asList(
      "\\\\",      
      "\\\"",
      "\\/" ,
      "\\=" ,
      "\\,"
    ));

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

   /**
    * Creates new Entity
    *
    * @param type type of vocabulary entity
    * @param name name of vocalbulary entity
    * @param URI uri of vocabulary entity
    * @param visualRepresentation URI address of image of object that entity represents 
    * @param description description of vocabulary entity
    */
    public Entity(String type, String name, String URI, String visualRepresentation, String description) {
      this.type = type;
      this.name = name;
      this.URI = URI;
      this.visualRepresentation = visualRepresentation;
      this.description = description;
    }

   /**
    * Gets type of vocabulary entity.
    *
    * @return type of vocabulary entity
    */
    public String getType() {
      return type;
    }

   /**
    * Sets type of vocabulary entity.
    *
    * @param type type of vocabulary entity
    */
    public void setType(String type) {
      this.type = type;
    }

   /**
    * Gets name of vocalbulary entity.
    *
    * @return name of vocalbulary entity
    */
    public String getName() {
      return name;
    }

   /**
    * Sets name of vocalbulary entity.
    *
    * @param name name of vocalbulary entity
    */
    public void setName(String name) {
      this.name = name;
    }
  
   /**
    * Gets uri of vocabulary entity.
    *
    * @return uri of vocabulary entity
    */
    public String getURI() {
      return URI;
    }

   /**
    * Sets uri of vocabulary entity.
    *
    * @param URI uri of vocabulary entity
    */
    public void setURI(String URI) {
      this.URI = URI;
    }

   /**
    * Gets URI address of image of object that entity represents.
    *
    * @return URI address of image of object that entity represents
    */
    public String getVisualRepresentation() {
      return visualRepresentation;
    }

   /**
    * Sets URI address of image of object that entity represents.
    *
    * @param visualRepresentation URI address of image of object that entity represents
    */
    public void setVisualRepresentation(String visualRepresentation) {
      this.visualRepresentation = visualRepresentation;
    }

   /**
    * Gets description of vocabulary entity.
    *
    * @return description of vocabulary entity
    */
    public String getDescription() {
      return description;
    }

   /**
    * Sets description of vocabulary entity.
    *
    * @param description description of vocabulary entity
    */
    public void setDescription(String description) {
      this.description = description;
    }

    @Override
    public String toString() {
      return "Entity{" + "type=" + type 
              + ", name=" + name 
              + ", URI=" + URI 
              + ", visualRepresentation=" + visualRepresentation 
              + ", description=" + description + '}';
    }
    
    /**
     * The method converts the string to a JSON safe string.
     * 
     * @param text string to convert
     * @return string without forbidden JSON characters
     */
    private String escapeJSON(String text){
      String result = text;
      for(int i = 0; i < UNESACPED_CHARS.size(); i++){
        result = result.replace(UNESACPED_CHARS.get(i), ESCAPED_CHARS.get(i));
      }   
      
      return result;
    }
    
    /**
     * Method converts the JSON safe string to normal string.
     * 
     * @param text JSON safe string to convert
     * @return converted normal string
     */
    private String unescapeJSON(String text){
      String result = text;
      for(int i = 0; i < UNESACPED_CHARS.size(); i++){
        result = result.replace(ESCAPED_CHARS.get(i),UNESACPED_CHARS.get(i));
      } 
      
      return result;
    }
    
    /**
     * The method converts the object to a JSON string.
     * 
     * @return JSON string
     */
    public String toJSONString(){
      StringBuilder result = new StringBuilder();
      if(this.name != null && !this.name.isEmpty()){
        result.append("name = ");
        result.append(escapeJSON(this.name));
        result.append(" ,");
      }
      
      if(this.type != null && !this.type.isEmpty()){
        result.append("type = ");
        result.append(escapeJSON(this.type));
        result.append(" ,");
      }

      if(this.URI != null && !this.URI.isEmpty()){
        result.append("uri = ");
        result.append(escapeJSON(this.URI));
        result.append(" ,");
      }
      
      if(this.visualRepresentation != null && !this.visualRepresentation.isEmpty()){
        result.append("visualRepresentation = ");
        result.append(escapeJSON(this.visualRepresentation));
        result.append(" ,");
      }
      
      if(this.description != null && !this.description.isEmpty()){
        result.append("description = ");
        result.append(escapeJSON(this.description));
        result.append(" ,");
      }
      
      if(result.length() > 2){
        result.deleteCharAt(result.length()-1);
      }

      return result.toString();
    }
    
    /**
     * Method sets the object parameters from JSON string.
     *
     * @param text JSON string
     */
    public void fromJSONString(String text) {
      if (text != null && !text.isEmpty()) {
        String[] splited = text.split(" ,");
        for (int i = 0; i < splited.length; i++) {
          String[] pair = splited[i].split(" = ");
          if (pair.length == 2) {
            if (pair[0].equals("name")) {
              this.name = unescapeJSON(pair[1]);
            }

            if (pair[0].equals("type")) {
              this.name = unescapeJSON(pair[1]);
            }

            if (pair[0].equals("uri")) {
              this.URI = unescapeJSON(pair[1]);
            }

            if (pair[0].equals("visualRepresentation")) {
              this.visualRepresentation = unescapeJSON(pair[1]);
            }

            if (pair[0].equals("description")) {
              this.description = unescapeJSON(pair[1]);
            }
          }
        }
      }
    }  // fromJSONString()
  }  // public static class Entity
}  // public class EntityAttribute