SugEntityAttribute.java

Go to the documentation of this file.

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

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.entity.attribute.EntityAttribute;
import java.util.ArrayList;
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 SugEntityAttribute.java
 *
 * @brief Class representing vocabulary entity attribute for prupose of suggestion
 */

/**
 * Class representing vocabulary entity attribute for prupose of suggestion
 *
 * @brief Class representing vocabulary entity attribute for prupose of suggestion
 */
@Entity
@DiscriminatorValue("Entity")
@NamedQueries({
    @NamedQuery(name = "SuggestionAttribute.findByEntityName", query = "SELECT a FROM SuggestionAttribute a WHERE a.stringValue = :name"),
    @NamedQuery(name = "SuggestionAttribute.findByEntityType", query = "SELECT a FROM SuggestionAttribute a WHERE a.entityType = :type"),
    @NamedQuery(name = "SuggestionAttribute.findByEntityUri", query = "SELECT a FROM SuggestionAttribute a WHERE a.uri = :uri")
})
public class SugEntityAttribute extends SugStructuredAttribute{
  /**
   * Constructor.
   */
  public SugEntityAttribute(){
  
  }
  
  /**
   * 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 SugEntityAttribute(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<SugEntityAdditionalAttribute> getEntityAdditionalAttributes() {
    return this.entityAdditionalAttributes;
  }

  /**
   * Sets additional attributes of this entity
   * 
   * @param EntityAdditionalAttributes Additional attributes of this entity
   */
  public void setEntityAdditionalAttributes(ArrayList<SugEntityAdditionalAttribute> 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=\"");
      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();
  }
  
  /**
   * Returns serialized informations about attribute of suggestion in XML 
   * for protocol v. 2.0 without header (target and attribute specification 
   * triples)
   *
   * @return Returns serialized informations about attribute of suggestion 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<SugEntityAdditionalAttribute> additionalAttrIt = entityAdditionalAttributes.iterator();
      while(additionalAttrIt.hasNext()){
        SugEntityAdditionalAttribute actualAttr = additionalAttrIt.next();
        result.append(actualAttr.toString());
      }
    }
    
    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 EntityAttribute.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 = ((EntityAttribute.Entity)value).getType();
    this.stringValue = ((EntityAttribute.Entity)value).getName();
    this.uri = ((EntityAttribute.Entity)value).getURI();
    this.entityVisualURI = ((EntityAttribute.Entity)value).getVisualRepresentation();
    this.textValue = ((EntityAttribute.Entity)value).getDescription();           
  }

  /**
   * The method sets the parameters from a string in JSON.
   * 
   * @param value string parsed from JSON
   */
  public void setStringValue(String value){
    EntityAttribute.Entity ent = new EntityAttribute.Entity();
    ent.fromJSONString(value);
    setValue(ent);
  }
  
  /**
   * 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 ((EntityAttribute.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;
  }
}  // public class SugEntityAttribute