SugNestedAttribute.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz, Jan Planer xplane01@stud.fit.vutbr.cz
 * File: SugNestedAttribute.java
 * Description: Class representing attribute of type NestedAnnotation for peupose of suggestion
 */

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

import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr;
import cz.vutbr.fit.knot.annotations.entity.Annotation;
import cz.vutbr.fit.knot.annotations.entity.attribute.NestedAnnotationAttribute;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion;
import java.util.Iterator;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;

/**
 * @file SugNestedAttribute.java
 *
 * @brief Class representing attribute of type NestedAnnotation for peupose of suggestion
 */

/**
 * Class representing attribute of type NestedAnnotation for peupose of suggestion
 *
 * @brief Class representing attribute of type NestedAnnotation for peupose of suggestion
 */
@Entity
@DiscriminatorValue("NestedSuggestion")
@NamedQueries({
    @NamedQuery(name = "SuggestionAttribute.findByNested", query = "SELECT a FROM SuggestionAttribute a WHERE a.nestedSugg = :nested"),
})
public class SugNestedAttribute extends SugBaseAttribute {
   /**
   * Constructor
   */
  public SugNestedAttribute() {
  }

  /**
   * Constructor
   *
   * @param name Name of the attribute
   * @param nestedSuggestion Value of the attribute
   * @param refSuggestion Suggestion to which this attribute belongs.
   */
  public SugNestedAttribute(String name, Suggestion nestedSuggestion, Suggestion refSuggestion) {
    this.name = name;
    this.simpleType = "NestedSuggestion";
    this.nestedSuggestion = nestedSuggestion;
    this.refSuggestion = refSuggestion;
  }

  /**
   * Gets value of the attribute
   *
   * @return value of the attribute
   */
  @Override
  public Object getValue() {
    if(this.nestedSuggestion != null){
      return this.nestedSuggestion;
    }else if(this.nestedAnnotation != null){
      return this.nestedAnnotation;
    }
    
    return null;
  }

  /**
   * Sets value of the attribute. Value should already be a native java value.
   *
   * @param value New value of the attribute
   */
  @Override
  public void setValue(Object value) {
    if(value instanceof Suggestion){
      this.nestedSuggestion = (Suggestion) value;
      this.simpleType = "NestedSuggestion";
      this.nestedAnnotation = null;
    }else if(value instanceof Annotation){
      this.nestedAnnotation = (Annotation) value;
      this.simpleType = "NestedAnnotation";
      this.nestedSuggestion = null;
    }else{
      this.nestedSuggestion = null;
      this.nestedAnnotation = null;
    }
  }

  /**
   * Parses provided value and sets that value as a value of attribute
   *
   * This method should not be used, because this type of attribute is processed
   * in MessageProcessor.
   *
   * @param value new value of the attribute in raw form from XML
   */
  @Override
  public void setRawValue(String value) throws IllegalArgumentException {
    throw new UnsupportedOperationException("Server internal error.");
  }

  /**
   * 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
   */
  @Override
  public String toXMLString(boolean proto11, boolean withOntology) {

    String sCom = "/";
    String sCom2 = "";
    String ontoString = "";
    if (proto11 && comment != null && !comment.isEmpty()) {
      sCom = "><a:comment>"
              + "<![CDATA["
              + comment
              + "]]>"
              + "</a:comment></a:attribute";
      sCom2 = "<a:comment>"
              + "<![CDATA["
              + comment
              + "]]>"
              + "</a:comment>";
    }

    if(withOntology){
      if(!getTypeOntologyUri().isEmpty()){
        ontoString += " typeOntologyUri=\""+getTypeOntologyUri()+"\"";
      }

      Iterator<AnnotTypeAttr> typeAttrIt = refSuggestion.getAnnotType().getAttributes().iterator();
      while(typeAttrIt.hasNext()){
          AnnotTypeAttr actualAttr = typeAttrIt.next();
          if(name.equals(actualAttr.getName())){
              if(actualAttr.getUriInOntology() != null){
                ontoString += " ontologyUri=\"" + actualAttr.getUriInOntology() + "\"";
              }
          }
      }  
    }
    
    if (nestedSuggestion == null) {
      if (attributeType != null) {
        return "<a:attribute name=\"" + name + "\"" + ontoString + " type=\"" + attributeType.getUri() + "\"" + sCom + ">";
      } else {
        // this is not reachable
        if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_INTERNAL_ERRORS) {
          String msg = "Unknown type of attribute created.";
          Logger.getLogger(NestedAnnotationAttribute.class.getName()).log(Level.SEVERE, msg);
        }
        return "<a:attribute name=\"" + name + "\"" + ontoString + " type=\"\"" + sCom + ">";
      }

    }
    
    if(nestedSuggestion.getTmpId() != null){
      return "<a:attribute name=\"" + name + "\"" + ontoString + " type=\"nestedAnnotation\" "
              + "tmpId=\"" + nestedSuggestion.getTmpId() + "\">"
              + nestedSuggestion.toXMLString(false, "", proto11)
              + sCom2
              + "</a:attribute>";
    }
    else{
      return "<a:attribute name=\"" + name + "\"" + ontoString + " type=\"nestedAnnotation\" "
              + "tmpId=\"" + nestedSuggestion.getId() + "\">"
              + nestedSuggestion.toXMLString(false, "", proto11)
              + sCom2
              + "</a:attribute>";
    }
  }  // toXMLString()
  
  /**
   * Returns serialized informations about attribute of suggestion in XML 
   * for protocol v. 2.0 without header (target and attribute specification 
   * triples)
   *
   * @param ontologyUri URI of attribute in ontology
   * @return Returns serialized informations about attribute of suggestion in XML
   */
  public String toXMLStringWHV2(String ontologyUri){
    StringBuilder result = new StringBuilder();

    /* Attribute contain nested annotation */
    if(this.nestedAnnotation != null){
      // serialize triple with information about nesting
      result.append("<trix:uri>");
      result.append(this.nestedAnnotation.getURIV2());
      result.append("</trix:uri>");
      result.append("</trix:triple>");
      
      // <annotation uri><nestedIn><annotation uri>
      result.append("<trix:triple>");

      result.append("<trix:uri>");
      result.append(this.nestedAnnotation.getURIV2());
      result.append("</trix:uri>");

      result.append("<trix:uri>koae:nestedIn</trix:uri>");

      result.append("<trix:uri>");
      result.append(this.refSuggestion.getURIV2());
      result.append("</trix:uri>");

      result.append("</trix:triple>");
      
      
      // <uri of document><attr name><annotation uri> 
      result.append("<trix:triple>");
      result.append("<trix:uri>");
      result.append(this.refSuggestion.getSource()).append(this.refSuggestion.getFragmentXpointersV2());
      result.append("</trix:uri>");

      if (ontologyUri == null || ontologyUri.isEmpty()) {
        result.append("<trix:name>");
        result.append(this.name);
        result.append("</trix:name>");
      } else {
        result.append("<trix:uri>");
        result.append(ontologyUri);
        result.append("</trix:uri>");
      }

      result.append("<trix:uri>");
      result.append(this.refSuggestion.getAnnotType().getUri());
      result.append("</trix:uri>");

      result.append("</trix:triple>");
      
      
      // <document uri><attr name><uri of type>
      result.append("<trix:triple>");
      result.append("<trix:uri>");
      result.append(this.refSuggestion.getSource()).append(this.refSuggestion.getFragmentXpointersV2());
      result.append("</trix:uri>");

      // serialize triple with name
      if (ontologyUri == null || ontologyUri.isEmpty()) {
        result.append("<trix:name>");
        result.append(this.name);
        result.append("</trix:name>");
      } else {
        result.append("<trix:uri>");
        result.append(ontologyUri);
        result.append("</trix:uri>");
      }

      // serialize triple with information about nesting
      result.append("<trix:uri>");
      result.append("koae:nestedAnnotation");
      result.append("</trix:uri>");
      result.append("</trix:triple>");
    }
    /* 
     * Attribute contain nested annotation 
     */
    else if(this.nestedSuggestion != null){
      // serialize triple with information about nesting
      result.append("<trix:uri>");
      result.append(this.nestedSuggestion.getURIV2());
      result.append("</trix:uri>");
      result.append("</trix:triple>");
      
      // <annotation uri><nestedIn><annotation uri>
      result.append("<trix:triple>");

      result.append("<trix:uri>");
      result.append(this.nestedSuggestion.getURIV2());
      result.append("</trix:uri>");

      result.append("<trix:uri>koae:nestedIn</trix:uri>");

      result.append("<trix:uri>");
      result.append(this.refSuggestion.getURIV2());
      result.append("</trix:uri>");

      result.append("</trix:triple>");
      
      
      // <uri of document><attr name><annotation uri> 
      result.append("<trix:triple>");
      result.append("<trix:uri>");
      result.append(this.refSuggestion.getSource()).append(this.refSuggestion.getFragmentXpointersV2());
      result.append("</trix:uri>");

      if (ontologyUri == null || ontologyUri.isEmpty()) {
        result.append("<trix:name>");
        result.append(this.name);
        result.append("</trix:name>");
      } else {
        result.append("<trix:uri>");
        result.append(ontologyUri);
        result.append("</trix:uri>");
      }

      result.append("<trix:uri>");
      result.append(this.refSuggestion.getAnnotType().getUri());
      result.append("</trix:uri>");

      result.append("</trix:triple>");
      
      
      // <document uri><attr name><uri of type>
      result.append("<trix:triple>");
      result.append("<trix:uri>");
      result.append(this.refSuggestion.getSource()).append(this.refSuggestion.getFragmentXpointersV2());
      result.append("</trix:uri>");

      // serialize triple with name
      if (ontologyUri == null || ontologyUri.isEmpty()) {
        result.append("<trix:name>");
        result.append(this.name);
        result.append("</trix:name>");
      } else {
        result.append("<trix:uri>");
        result.append(ontologyUri);
        result.append("</trix:uri>");
      }

      // serialize triple with information about nesting
      result.append("<trix:uri>");
      result.append("koae:nestedAnnotation");
      result.append("</trix:uri>");
      result.append("</trix:triple>");
    /*
     * Empty attribute
     */
    }else{
      // nested 
      result.append("<trix:uri>");
      if(getAttributeType() == null){
      
      }
      else{
        result.append(getAttributeType().getUri());
      }
      result.append("</trix:uri>");
      result.append("</trix:triple>");

      // <document uri><attr name><koae:nested>
      result.append("<trix:triple>");
      result.append("<trix:uri>");
      result.append(this.refSuggestion.getSource()).append(this.refSuggestion.getFragmentXpointersV2());
      result.append("</trix:uri>");

      // serialize triple with name
      if (ontologyUri == null || ontologyUri.isEmpty()) {
        result.append("<trix:name>");
        result.append(this.name);
        result.append("</trix:name>");
      } else {
        result.append("<trix:uri>");
        result.append(ontologyUri);
        result.append("</trix:uri>");
      }

      // serialize triple with information about nesting
      result.append("<trix:uri>");
      result.append("koae:nestedAnnotation");
      result.append("</trix:uri>");
      result.append("</trix:triple>");
    }
    
    return result.toString();
  }

  /**
   * 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(){
      if(this.attributeType != null)
      {
        return this.attributeType.getUriInOntology();
      }else 
      {
         return "";
      }
  }
}