SECTypesTranslator.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SECTypesTranslator.java
 * Description: Translates JSON with types from SEC API to requested type 
 *              definitions
 */

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

import cz.vutbr.fit.knot.annotations.app.Constants;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.JSONValue;

/**
 * Translates JSON with types from SEC API to requested type definitions
 * 
 * @brief Translates JSON with types from SEC API to requested type definitions
 */
public class SECTypesTranslator {
  
  public static ArrayList<SecApiReqTypeDef> translate(String typesData) {
    ArrayList<SecApiReqTypeDef> result = new ArrayList<SecApiReqTypeDef>();
    if (typesData == null || typesData.isEmpty()) {
      return result;
    }
    JSONObject jsonData = (JSONObject)JSONValue.parse(typesData);
    if (jsonData == null) {
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Unable to parse received JSON string with types and attributes.";
        Logger.getLogger(SECTypesTranslator.class.getName()).log(Level.SEVERE, msg);
      }
      return result;
    }
    if (checkException(jsonData)) {  // check for exception
      return result;
    }
    try {
      JSONArray jsonTypes = (JSONArray)jsonData.get("data");
      if (jsonTypes == null || jsonTypes.isEmpty()) {
        if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
          String msg = "Unable to get types and attributes.";
          Logger.getLogger(SECTypesTranslator.class.getName()).log(Level.SEVERE, msg);
        }
      }
      int typesLength = jsonTypes.size();
      for (int i = 0; i < typesLength; i++) {
        JSONObject typesItem = (JSONObject)jsonTypes.get(i);
        String name = (String)typesItem.get("type");
        if (name == null || name.isEmpty()) {
          continue;
        }
        
        SecApiReqTypeDef satd = new SecApiReqTypeDef(name);
        
        JSONArray attributes = (JSONArray)typesItem.get("attributes");
        
        int attLength = attributes.size();
        for (int j = 0; j < attLength; j++) {
          String attItem = (String) attributes.get(j);
          if (attItem == null || attItem.isEmpty()) {
            continue;
          }
          satd.addAvailableAttribute(attItem);
        }
        if (Constants.ADD_IDENTIFIER && !satd.getAvailableAttributes().contains("identifier")) {
          // identifier is internal - it is hardcoded hidden feature of SEC API 
          // and must be added manually here
          satd.addAvailableAttribute("identifier");
        }
        if (Constants.ADD_DISAMBIGUATION && !satd.getAvailableAttributes().contains("disambiguation")) {
          // disambiguation is internal - it is hardcoded hidden feature of SEC API 
          // and must be added manually here
          satd.addAvailableAttribute("disambiguation");
        }
        if (Constants.ADD_CONFIDENCE && !satd.getAvailableAttributes().contains("confidence")) {
          // confidence is necessary for features which should be available
          // so if it is missing it must be added manually here
          satd.addAvailableAttribute("confidence");
        }
        
        JSONObject priorities = (JSONObject)typesItem.get("priorities");
        if (priorities != null) {
          Iterator<String> attIt = satd.getAvailableAttributes().iterator();
          while (attIt.hasNext()) {
            String att = attIt.next();
            try {
              Long priority = (Long) priorities.get(att);
              if (priority != null) {
                satd.setPriority(att, priority.intValue());
              }
            } catch (Exception e) {
              if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
                String msg = "Unable to load priority of attribute.";
                Logger.getLogger(SECTypesTranslator.class.getName()).log(Level.SEVERE, msg, e);
              }
            }
          }
        }
        
        result.add(satd);
      }
      
    } catch (Exception e) {
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Unable to parse received JSON string with types and attributes.";
        Logger.getLogger(SECTypesTranslator.class.getName()).log(Level.SEVERE, msg, e);
      }
      return result;
    }
    
    return result;
  }  // translate()
  
  
  /**
   * Checks if JSON from SEC API contains exception and if yes, logs it
   * 
   * @param jsonData JSON data from SEC API
   * @return If exception was presented, returns true, false otherwise
   */
  private static boolean checkException(JSONObject jsonData) {
    String exceptionData = null;
    try {  // try to get exception
      exceptionData = (String) jsonData.get("exception");
    } catch (Exception e) {  // error never mind here
    }
    if (exceptionData != null && !exceptionData.isEmpty()) {
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "SEC API returned exception: " + exceptionData;
        Logger.getLogger(SECTypesTranslator.class.getName()).log(Level.SEVERE, msg);
      }
      return true;
    }
    return false;
  }
}  // class SECTypesTranslator