P2EntityTrix.java

Go to the documentation of this file.

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

/**
 * @file P2EntityTrix.java
 *
 * @brief Class that represents entity 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.entity.Annotation;
import cz.vutbr.fit.knot.annotations.entity.attribute.BaseAttribute;
import cz.vutbr.fit.knot.annotations.entity.attribute.EntityAdditionalAttribute;
import cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Class that represents entity trix triple.
 *
 * @brief Class that represents entity trix triple.
 */
public class P2EntityTrix extends P2BaseTrix{
  
  /** 
   * Constructs entity trix with specified destination
   * @param destinationUri Uri of destination
   */
  public P2EntityTrix(String destinationUri){
    super(destinationUri);
  }
  
  /** Uri of entity */
  private String entityUri;
  
  /** Type of entity */
  private String entityType;
  
  /** Name of entity */
  private String entityName;
  
  /** Graphical representation of entity */
  private String imageUri;
  
  /** Description of entity */
  private String description;
  
  /** List of entity additional attributes */
  private ArrayList<P2EntityAdditionalTrix> entityAdditionalTrixAL;
  
  /**
   * Sets Uri of entity
   * @return The Uri of entity
   */
  public String getEntityUri() {
    return entityUri;
  }

  /**
   * Gets Uri of entity
   * @param entityUri The Uri of entity
   */
  public void setEntityUri(String entityUri) {
    this.entityUri = entityUri;
  }

  /**
   * Gets type of entity
   * @return The type of entity
   */
  public String getEntityType() {
    return entityType;
  }

  /**
   * Sets type of entity
   * @param entityType The type of entity
   */
  public void setEntityType(String entityType) {
    this.entityType = entityType;
  }

  /**
   * Gets list of entity additional attributes
   * @return The list of entity additional attributes
   */
  public ArrayList<P2EntityAdditionalTrix> getEntityAdditionalTrixAL() {
    return entityAdditionalTrixAL;
  }

  /**
   * Sets list of entity additional attributes
   * @param entityAdditionalTrixAL The list of entity additional attributes
   */
  public void setEntityAdditionalTrixAL(ArrayList<P2EntityAdditionalTrix> entityAdditionalTrixAL) {
    this.entityAdditionalTrixAL = entityAdditionalTrixAL;
  }

  /**
   * Gets name of entity
   * @return the name of entity
   */
  public String getEntityName() {
    return entityName;
  }

  /**
   * Sets name of entity
   * @param entityName the entity name to set
   */
  public void setEntityName(String entityName) {
    this.entityName = entityName;
  }

  /**
   * Gets graphical representation of entity
   * @return the graphical representation of entity
   */
  public String getImageUri() {
    return imageUri;
  }

  /**
   * Sets graphical representation of entity
   * @param imageUri the graphical representation of entity to set
   */
  public void setImageUri(String imageUri) {
    this.imageUri = imageUri;
  }

  /**
   * Gets description of entity
   * @return the description of entity
   */
  public String getDescription() {
    return description;
  }

  /**
   * Sets description of entity
   * @param description the description of entity
   */
  public void setDescription(String description) {
    this.description = description;
  }

  @Override
  public ArrayList<BaseAttribute> trixToAnnotAtt(Annotation annot, RequestInfo requestInfo, Integer sparePriority) {
    ArrayList<BaseAttribute> atList = new ArrayList<BaseAttribute>();
    ArrayList<EntityAdditionalAttribute> additionalAttributes = new ArrayList<EntityAdditionalAttribute>();
    
    /* 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(P2EntityTrix.class.getName()).log(Level.SEVERE, null);
      }
      return null;
    }
    
    EntityAttribute newAtt = new EntityAttribute();      
    
    
    newAtt.setName(name);
    newAtt.setUriInOntology(uriInOntology);
    newAtt.setRefAnnotation(annot);
    
    
    newAtt.setUri(entityUri);
    newAtt.setEntityType(entityType);
    newAtt.setEntityVisualURI(searchEntityImage());
    newAtt.setStringValue(searchEntityName());
    newAtt.setTextValue(searchEntityDescription());
    
    /* 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(P2EntityTrix.class.getName()).log(Level.SEVERE, null, ex);
        }
        return null;
      }
    }

    if(priority != null){
      newAtt.setPriority(newPriority);
    } else {
      newAtt.setPriority(sparePriority);
    }
    
    Iterator<P2EntityAdditionalTrix> addAttIt = entityAdditionalTrixAL.iterator();
    while(addAttIt.hasNext()){
      EntityAdditionalAttribute tmpAtt = makeEntityAdditionalAttribute(addAttIt.next(), newAtt);
      additionalAttributes.add(tmpAtt);
    }
    
    newAtt.setEntityAdditionalAttributes(additionalAttributes);
    
    atList.add(newAtt);
    return atList;
  }
  
  /**
   * Method that creates entity additional attribute from trix
   * @param trixAtt Entity additional trix
   * @param entity Reference entity
   * @return Entity additional attribute
   */
  private EntityAdditionalAttribute makeEntityAdditionalAttribute(P2EntityAdditionalTrix trixAtt, EntityAttribute entity){
    EntityAdditionalAttribute newAtt = new EntityAdditionalAttribute();

    newAtt.setName(trixAtt.getEntityAttributeName());
    newAtt.setStringValue(trixAtt.getValue());
    newAtt.setRefEntityAttribute(entity);
    newAtt.setType(Constants.DEFAULT_SIMPLE_TYPE_FOR_ENT_AD_AT);
    if (trixAtt.getTypeUri() != null) {
      int typeIndex = Constants.SIMPLE_TYPES_URIS_FOR_ENT_AD_AT.indexOf(trixAtt.getTypeUri());
      if (typeIndex >= 0 && Constants.SIMPLE_TYPES_FOR_ENT_AD_AT.size() > typeIndex) {
        newAtt.setType(Constants.SIMPLE_TYPES_FOR_ENT_AD_AT.get(typeIndex));
      } else {
        if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_ALL_ERRORS) {
          String msg = "Unknown type of entity additional attribute: " + trixAtt.getTypeUri();
          Logger.getLogger(P2EntityTrix.class.getName()).log(Level.SEVERE, msg);
        }
      }
    } else {
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_ALL_ERRORS) {
        String msg = "Type of entity additional attribute is missing.";
        Logger.getLogger(P2EntityTrix.class.getName()).log(Level.SEVERE, msg);
      }
    }

    return newAtt;
  }
  
  private String searchEntityName(){
    Iterator<P2EntityAdditionalTrix> it = entityAdditionalTrixAL.iterator();
    String tmpName = null;
    while(it.hasNext()){
      P2EntityAdditionalTrix tmp = it.next();
      if(tmp.getEntityAttributeName().equalsIgnoreCase("name")){
        tmpName = tmp.getValue();
        entityAdditionalTrixAL.remove(tmp);
        break;
      }
    }
    
    return tmpName;
  }
  
  private String searchEntityImage(){
    Iterator<P2EntityAdditionalTrix> it = entityAdditionalTrixAL.iterator();
    String tmpImage = null;
    while(it.hasNext()){
      P2EntityAdditionalTrix tmp = it.next();
      if(tmp.getEntityAttributeName().equalsIgnoreCase("image")){
        tmpImage = tmp.getValue();
        entityAdditionalTrixAL.remove(tmp);
        break;
      }
    }
    
    return tmpImage;
  }
  
  private String searchEntityDescription(){
    Iterator<P2EntityAdditionalTrix> it = entityAdditionalTrixAL.iterator();
    String tmpDesc = null;
    while(it.hasNext()){
      P2EntityAdditionalTrix tmp = it.next();
      if(tmp.getEntityAttributeName().equalsIgnoreCase("description")){
        tmpDesc = tmp.getValue();
        entityAdditionalTrixAL.remove(tmp);
        break;
      }
    }
    
    return tmpDesc;
  }
  
}