StructuredAttribute.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: StructuredAttribute.java
 * Description: Base class for more complex attributes, which are stored in 
 * different table, such as Person, GeoPoint...
 */

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

import cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr;
import java.util.Iterator;
import javax.persistence.MappedSuperclass;

/**
 * @file StructuredAttribute.java
 *
 * @brief Abstract class representing more complex attribute
 */

/**
 * Abstract class representing more complex attribute
 *
 * @brief Abstract class representing more complex attribute
 */
@MappedSuperclass
public abstract class StructuredAttribute extends BaseAttribute {
    
  /**
   * 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>";
  }

  /**
   * XML of the structured attribute looks like this:
   * @verbatim
   * <a:attribute ...... >
   *     <nested>
   *         <value1>...</value1>
   *         <value2>...</value2>
   *     </nested>
   * </a:attribute>
   * @endverbatim
   * 
   * This method returns the starting element for the a:attribute element.
   * 
   * @param withOntology If true, URI in ontology will be serialized, if false, it will be omitted
   * @return Returns the starting element for the a:attribute element.
   */
  protected String getXmlStart(boolean withOntology) {
    String ontoString = "";
    if(withOntology){
      if(!getTypeOntologyUri().isEmpty()){
        ontoString += " typeOntologyUri=\""+getTypeOntologyUri()+"\"";
      }

      Iterator<AnnotTypeAttr> typeAttrIt = refAnnotation.getAnnotType().getAttributes().iterator();
      while(typeAttrIt.hasNext()){
          AnnotTypeAttr actualAttr = typeAttrIt.next();
          if(name.equals(actualAttr.getName())){
              if(actualAttr.getUriInOntology() != null){
                ontoString += " ontologyUri=\"" + actualAttr.getUriInOntology() + "\"";
              }
          }
      }   
    }
    return "<a:attribute name=\"" + name + "\"" + ontoString + " type=\"" + simpleType + "\">";
  }

  /**
   * XML of the structured attribute looks like this:
   * @verbatim
   * <a:attribute ...... >
   *     <nested>
   *         <value1>...</value1>
   *         <value2>...</value2>
   *     </nested>
   * </a:attribute>
   * @endverbatim
   * 
   * This method returns the ending element for the a:attribute element.
   * 
   * @return Returns the ending element for the a:attribute element.
   */
  protected String getXmlEnd() {
    return "</a:attribute>";
  }
  
  /**
   * XML of the structured attribute looks like this:
   * @verbatim
   * <a:attribute ...... >
   *     <nested>
   *         <value1>...</value1>
   *         <value2>...</value2>
   *     </nested>
   * </a:attribute>
   * @endverbatim
   * 
   * This method returns the content of the a:attribute element with all nested 
   * elements.
   * 
   * @return Returns the content of the a:attribute element with all nested elements.
   */
  protected abstract String getXmlBody();

  /**
   * Returns serialized informations about attribute of annotation in XML
   * 
   * @param proto11 If true, protocol version is greater then 1.0
   * @param tmpIdForNested If true, nested annotations will have attribute tmpId
   * @param withOntology If true, URI in ontology will be serialized, if false, it will be omittedv
   * @return Returns serialized informations about attribute of annotation in XML
   */
  @Override
  public String toXMLString(boolean proto11, boolean tmpIdForNested, boolean withOntology) {

    if (this.getValue() == null) {
      return super.toXMLString(proto11, tmpIdForNested, false);
    }
    return getXmlStart(withOntology)
            + getXmlBody()
            + getCommentXmlPart(proto11)
            + getXmlEnd();
  }

  /**
   * Parses provided value and sets that value as a value of attribute
   * 
   * This method should not be used because structured attributes are not 
   * represented by single value.
   * 
   * @param value new value of the attribute in raw form from XML
   */
  @Override
  public void setRawValue(String value) throws IllegalArgumentException {
    throw new UnsupportedOperationException("Structured attributes are not represented by single value.");
  }
  
  /**
   * Checks if attribute is structured. Structured attribute is for example 
   * GeoPointAttribute
   * 
   * @return true, if attribute is structured
   */
  @Override
  public boolean isStructured() {
    return true;
  }

  /**
   * Parses provided values and sets that values as a values of the attribute
   * 
   * @param values New values of the attribute in raw forms from XML
   */
  public abstract void setRawValues(Object values) throws IllegalArgumentException;
    
    
  /**
   * XML of the structured attribute looks like this:
   * @verbatim
   * <a:attribute ...... >
   *     <nested>
   *         <value1>...</value1>
   *         <value2>...</value2>
   *     </nested>
   * </a:attribute>
   * @endverbatim
   * 
   * @return the name of the "nested" attribute 
   */
  public abstract String getXmlAttributeName();
  
  /**
   * 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.getUriInOntology() != null)
      {
        return this.attributeType.getUriInOntology();
      }else 
      {
         return "";
      }
  }
} // StructuredAttribute()