SugTextAttribute.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SugTextAttribute.java
 * Description: Class representing attribute of type Text for prupose 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.modules.suggestionManager.Suggestion;
import java.util.Iterator;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;

/**
 * @file SugTextAttribute.java
 *
 * @brief Class representing attribute of type Text for prupose of suggestion. 
 */

/**
 * Class representing attribute of type Text for prupose of suggestion.
 * 
 * @brief Class representing attribute of type Text for prupose of suggestion.
 */
@Entity
@DiscriminatorValue(value="Text")
public class SugTextAttribute extends SugStringAttribute{

  public SugTextAttribute() {
  }

  /**
   * Constructor
   * 
   * @param name Name of the attribute
   * @param value Value of the attribute
   * @param refSuggestion Suggestion to which this attribute belongs
   */
  public SugTextAttribute(String name, String value, Suggestion refSuggestion) {
    this.name = name;
    this.simpleType = "Text";
    this.textValue = value;
    this.refSuggestion = refSuggestion;
  }
  
  /**
   * Constructor
   * 
   * @param name Name of the attribute
   * @param value Value of the attribute
   * @param refSuggestion Suggestion to which this attribute belongs
   * @param priority Priority of attribute
   */
  public SugTextAttribute(String name, String value, Suggestion refSuggestion, Integer priority) {
    this.name = name;
    this.simpleType = "Text";
    this.textValue = value;
    this.refSuggestion = refSuggestion;
    this.priority = priority;
  }
  
  /**
   * Gets value of the attribute
   * 
   * @return value of the attribute
   */
  @Override
  public Object getValue() {
    return this.textValue;
  }

  /**
   * 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) {
    this.textValue = (String) 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
   */
  @Override
  public void setRawValue(String value) {
    this.setValue(value);
  }
  
  /**
   * Helper function,which returns XML part for comments.
   * 
   * @param proto11 If true, protocol version is greater then 1.0
   * @return XML part for comments
   */
  @Override
  public String getCommentXmlPart(boolean proto11) {
    return "<a:comment>"
           + "<![CDATA["
           + comment
           + "]]>"
         + "</a:comment>";
  }
  
  /**
   * 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 ontoString = "";  
    
    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 (this.textValue == null) {
    return    "<a:attribute name=\"" + name + "\"" + ontoString + " type=\"" + simpleType + "\">"
          +   "<a:Content>"
          +     "<![CDATA[]]>"
          +   "</a:Content>"
          +   getCommentXmlPart(proto11)
          + "</a:attribute>";
    }
    return    "<a:attribute name=\"" + name + "\"" + ontoString + " type=\"" + simpleType + "\">"
            +   "<a:Content>"
            +     "<![CDATA["
            +       this.textValue
            +     "]]>"
            +   "</a:Content>"
            +   getCommentXmlPart(proto11)
            + "</a:attribute>";
  }
  
  /**
   * 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.TEXT_URI;
  }
}