P2NestedTrix.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: P2NestedTrix.java
 * Description: Class that represents nested trix triple.
 */

/**
 * @file P2NestedTrix.java
 *
 * @brief Class that represents nested trix triple.
 */

package cz.vutbr.fit.knot.annotations.comet.protocolV2_0.P2Trix;

import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.app.Localisation;
import cz.vutbr.fit.knot.annotations.comet.RequestInfo;
import cz.vutbr.fit.knot.annotations.comet.protocolV2_0.P2AnnotTypeProcessor;
import cz.vutbr.fit.knot.annotations.entity.AnnotType;
import cz.vutbr.fit.knot.annotations.entity.Annotation;
import cz.vutbr.fit.knot.annotations.entity.attribute.AttributeManager;
import cz.vutbr.fit.knot.annotations.entity.attribute.BaseAttribute;
import cz.vutbr.fit.knot.annotations.entity.attribute.NestedAnnotationAttribute;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Class that represents nested trix triple.
 *
 * @brief Class that represents nested trix triple.
 */
public class P2NestedTrix extends P2BaseTrix{
  
  /** 
   * Constructs nested trix with specified destination
   * @param destinationUri Uri of destination
   */
  public P2NestedTrix(String destinationUri){
    super(destinationUri);
  }
  
  public P2NestedTrix(P2BaseTrix trix){
    super(trix.getDestinationUri());
    this.name = trix.name;
    this.annotType = trix.annotType;
    this.priority = trix.priority;
    this.fromOntology = trix.fromOntology;
    this.uriInOntology = trix.uriInOntology;
  }
  
  /** Uris of nested annotation */
  private ArrayList<String> nestedAnnotUris;
  
  /** Uri of reference annotation */
  private String refAnnotUri;

  /**
   * Gets Uris of nested annotation
   * @return The Uris of nested annotations
   */
  public ArrayList<String> getNestedAnnotUris() {
    return nestedAnnotUris;
  }

  /**
   * Sets Uris of nested annotations
   * @param nestedAnnotUris The Uris of nested annotations
   */
  public void setNestedAnnotUri(ArrayList<String> nestedAnnotUris) {
    this.nestedAnnotUris = nestedAnnotUris;
  }
  
  /**
   * Add Uri of nested annotation
   * @param nestedAnnotUri The Uri of nested annotation
   */
  public void addNestedAnnotUri(String nestedAnnotUri){
    if(nestedAnnotUris == null){
      nestedAnnotUris = new ArrayList<String>();
    }
    
    nestedAnnotUris.add(nestedAnnotUri);
  }
  
  /**
   * Add all Uris of nested annotation
   * @param allNestedAnnotUris  The Uris of nested annotations
   */
  public void addAllNestedAnnotUris(ArrayList<String> allNestedAnnotUris){
    if(nestedAnnotUris == null){
      this.nestedAnnotUris = new ArrayList<String>();
    }
    nestedAnnotUris.addAll(allNestedAnnotUris);
  }

  /**
   * Gets Uri of reference annotation
   * @return The Uri reference annotation
   */
  public String getRefAnnotUri() {
    return refAnnotUri;
  }

  /**
   * Sets Uri of reference annotation
   * @param refAnnotUri The Uri reference annotation
   */
  public void setRefAnnotUri(String refAnnotUri) {
    this.refAnnotUri = refAnnotUri;
  }
  
  @Override
  public ArrayList<BaseAttribute> trixToAnnotAtt(Annotation annot, RequestInfo requestInfo, Integer sparePriority) {
    ArrayList<BaseAttribute> atList = new ArrayList<BaseAttribute>();
    
    
    /* Check if name is not empty */
    if(name.isEmpty()){
      int langNum = requestInfo.getSession().getLanguageNum();
      int lod = requestInfo.getSession().getProtocolLOD();

      String info = "<attribute annotationUri=\"" + annot.getURIV2();
      if(isFromOntology()){
        info += "\" uri=\"" + uriInOntology;
      }
      else{
        info += "\" name=\"" + name;
      }
      info += "\" invalidProperty=\"name\"/>";

      requestInfo.addError(lod, langNum, Localisation.ERROR_26_ATTRIBUTE_MALFORMED, info);
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_ALL_ERRORS) {
          Logger.getLogger(P2NestedTrix.class.getName()).log(Level.SEVERE, null);
      }
      return null;
    }
    
    
    if (nestedAnnotUris == null) {  // prevent NUllPointerException
      nestedAnnotUris = new ArrayList<String>();
    }
    Iterator<String> nestedAnnUrisIt = nestedAnnotUris.iterator();
    do {  // attribute can be empty - it is necessary to create one even if there is no value
      NestedAnnotationAttribute newAtt;

      try {
        newAtt = (NestedAnnotationAttribute) AttributeManager.createAttribute(name, "NestedAnnotation", annot);
      } catch (ClassNotFoundException ex) {
        int langNum = requestInfo.getSession().getLanguageNum();
        int lod = requestInfo.getSession().getProtocolLOD();

        String info = "<attribute annotationUri=\"" + annot.getURIV2();
        if(isFromOntology()){
          info += "\" uri=\"" + uriInOntology;
        }
        else{
          info += "\" name=\"" + name;
        }
        info += "\" invalidProperty=\"type\"/>";

        requestInfo.addError(lod, langNum, Localisation.ERROR_26_ATTRIBUTE_MALFORMED, info);
        if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_ALL_ERRORS) {
            Logger.getLogger(P2NestedTrix.class.getName()).log(Level.SEVERE, "Unable to create nested attribute", ex);
        }   
        return null;
      }

      /*
      * Searching for attribute type
      * - in Flier as it could be just created type
      * - in DB
      */
      AnnotType type = P2AnnotTypeProcessor.searchAnnotType(annotType, requestInfo.getFlier().getAddedTypes());
      if(type == null){
        int langNum = requestInfo.getSession().getLanguageNum();
        int lod = requestInfo.getSession().getProtocolLOD();

        String info = "<attribute annotationUri=\"" + annot.getURIV2() 
                      + "\" uri=\"" + newAtt.getUriInOntology() 
                      + "\" name=\"" + newAtt.getName() 
                      + "\" valueType=\"" + newAtt.getValueType() 
                      + "\" type=\"" + annotType + "\"/>";
        requestInfo.addError(lod, langNum, Localisation.ERROR_15_ATTRIBUTE_TYPE_UNAVAILABLE, info);
        if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_ALL_ERRORS) {
            Logger.getLogger(P2NestedTrix.class.getName()).log(Level.SEVERE, "Unable to search for attribute type");
        }
        return null;
      }
      
      /* Sets uri in ontology */
      newAtt.setUriInOntology(uriInOntology);

      // Set additional informations
      if (nestedAnnUrisIt.hasNext()) {
        newAtt.setUri(nestedAnnUrisIt.next());
      }
      newAtt.setAttributeType(type);

      /* Process priority */
      Integer newPriority = null;
      if(priority != null){
        try{
          newPriority = Integer.parseInt(priority);
        }catch(NumberFormatException ex){
          int langNum = requestInfo.getSession().getLanguageNum();
          int lod = requestInfo.getSession().getProtocolLOD();

          String info = "<attribute annotationUri=\"" + annot.getURIV2();
          if(isFromOntology()){
            info += "\" uri=\"" + uriInOntology;
          }
          else{
            info += "\" name=\"" + name;
          }
          info += "\" invalidProperty=\"priority\"/>";

          requestInfo.addError(lod, langNum, Localisation.ERROR_26_ATTRIBUTE_MALFORMED, info);
          if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_ALL_ERRORS) {
              Logger.getLogger(P2NestedTrix.class.getName()).log(Level.SEVERE, null, ex);
          }
          return null;
        }
      }

      if(priority != null){
        newAtt.setPriority(newPriority);
      } else {
        newAtt.setPriority(sparePriority);
      }
      
      atList.add(newAtt);
    
    } while (nestedAnnUrisIt.hasNext());

    return atList;
  }  // trixToAnnotAtt()
}  // public class P2NestedTrix