src/jalview/ws/dbsources/PDBRestClient.java

   1 package jalview.ws.dbsources;
   2
   3 import jalview.ws.uimodel.PDBRestRequest;
   4 import jalview.ws.uimodel.PDBRestResponse;
   5 import jalview.ws.uimodel.PDBRestResponse.PDBResponseSummary;
   6
   7 import java.util.ArrayList;
   8 import java.util.Collection;
   9 import java.util.Iterator;
  10 import java.util.List;
  11
  12 import javax.ws.rs.core.MediaType;
  13
  14 import org.json.simple.JSONArray;
  15 import org.json.simple.JSONObject;
  16 import org.json.simple.parser.JSONParser;
  17 import org.json.simple.parser.ParseException;
  18
  19 import com.sun.jersey.api.client.Client;
  20 import com.sun.jersey.api.client.ClientResponse;
  21 import com.sun.jersey.api.client.WebResource;
  22 import com.sun.jersey.api.client.config.ClientConfig;
  23 import com.sun.jersey.api.client.config.DefaultClientConfig;
  24 import com.sun.jersey.api.json.JSONConfiguration;
  25
  26 /**
  27  * A rest client for querying the Search endpoing of the PDB REST API
  28  *
  29  * @author tcnofoegbu
  30  *
  31  */
  32 public class PDBRestClient
  33 {
  34   private static String PDB_SEARCH_ENDPOINT = "http://wwwdev.ebi.ac.uk/pdbe/search/pdb/select?";
  35
  36   private static int DEFAULT_RESPONSE_SIZE = 200;
  37
  38   /**
  39    * Takes a PDBRestRequest object and returns a response upon execution
  40    *
  41    * @param pdbRestRequest
  42    *          the PDBRestRequest instance to be processed
  43    * @return the pdbResponse object for the given request
  44    */
  45   public PDBRestResponse executeRequest(PDBRestRequest pdbRestRequest)
  46   {
  47     ClientConfig clientConfig = new DefaultClientConfig();
  48     clientConfig.getFeatures().put(JSONConfiguration.FEATURE_POJO_MAPPING,
  49             Boolean.TRUE);
  50     Client client = Client.create(clientConfig);
  51
  52     String wantedFields = getPDBDocFieldsAsCommaDelimitedString(pdbRestRequest
  53             .getWantedFields());
  54     int responseSize = (pdbRestRequest.getResponseSize() == 0) ? DEFAULT_RESPONSE_SIZE
  55             : pdbRestRequest.getResponseSize();
  56     String sortParam = (pdbRestRequest.getFieldToSortBy() == null || pdbRestRequest
  57             .getFieldToSortBy().trim().isEmpty()) ? "" : (pdbRestRequest
  58             .getFieldToSortBy() + (pdbRestRequest.isAscending() ? " asc"
  59             : " desc"));
  60
  61     // Build request parameters for the REST Request
  62     WebResource webResource = client.resource(PDB_SEARCH_ENDPOINT)
  63             .queryParam("wt", "json").queryParam("fl", wantedFields)
  64             .queryParam("rows", String.valueOf(responseSize))
  65             .queryParam("q", pdbRestRequest.getQuery())
  66             .queryParam("sort", sortParam);
  67
  68     // Execute the REST request
  69     ClientResponse clientResponse = webResource.accept(
  70             MediaType.APPLICATION_JSON).get(ClientResponse.class);
  71
  72     // Get the JSON string from the response object
  73     String responseString = clientResponse.getEntity(String.class);
  74
  75     // Check the response status and report exception if one occurs
  76     if (clientResponse.getStatus() != 200)
  77     {
  78       String errorMessage = "";
  79       if (clientResponse.getStatus() == 400)
  80       {
  81         errorMessage = parseJsonExceptionString(responseString);
  82         throw new RuntimeException(errorMessage);
  83       }
  84       else
  85       {
  86         errorMessage = "Failed : HTTP error code : "
  87                 + clientResponse.getStatus();
  88         throw new RuntimeException(errorMessage);
  89       }
  90     }
  91
  92     // Make redundant objects eligible for garbage collection to conserve
  93     // memory
  94     clientResponse = null;
  95     client = null;
  96
  97     // Process the response and return the result to the caller.
  98     return parsePDBJsonResponse(responseString, pdbRestRequest);
  99   }
 100
 101   /**
 102    * Process error response from PDB server if/when one occurs.
 103    *
 104    * @param jsonResponse
 105    *          the JSON string containing error message from the server
 106    * @return the processed error message from the JSON string
 107    */
 108   public static String parseJsonExceptionString(String jsonErrorResponse)
 109   {
 110     StringBuilder errorMessage = new StringBuilder(
 111             "\n============= PDB Rest Client RunTime error =============\n");
 112     try
 113     {
 114       JSONParser jsonParser = new JSONParser();
 115       JSONObject jsonObj = (JSONObject) jsonParser.parse(jsonErrorResponse);
 116       JSONObject errorResponse = (JSONObject) jsonObj.get("error");
 117       JSONObject responseHeader = (JSONObject) jsonObj
 118               .get("responseHeader");
 119       JSONObject paramsObj = (JSONObject) responseHeader.get("params");
 120       String status = responseHeader.get("status").toString();
 121       String message = errorResponse.get("msg").toString();
 122       String query = paramsObj.get("q").toString();
 123       String fl = paramsObj.get("fl").toString();
 124
 125       errorMessage.append("Status: ").append(status).append("\n");
 126       errorMessage.append("Message: ").append(message).append("\n");
 127       errorMessage.append("query: ").append(query).append("\n");
 128       errorMessage.append("fl: ").append(fl).append("\n");
 129     } catch (ParseException e)
 130     {
 131       e.printStackTrace();
 132     }
 133     return errorMessage.toString();
 134   }
 135
 136   /**
 137    * Parses the JSON response string from PDB REST API. The response is dynamic
 138    * hence, only fields specifically requested for in the 'wantedFields'
 139    * parameter is fetched/processed
 140    *
 141    * @param pdbJsonResponseString
 142    *          the JSON string to be parsed
 143    * @param pdbRestRequest
 144    *          the request object which contains parameters used to process the
 145    *          JSON string
 146    * @return
 147    */
 148   @SuppressWarnings("unchecked")
 149   public static PDBRestResponse parsePDBJsonResponse(
 150           String pdbJsonResponseString, PDBRestRequest pdbRestRequest)
 151   {
 152     PDBRestResponse searchResult = new PDBRestResponse();
 153     List<PDBResponseSummary> result = null;
 154     try
 155     {
 156       JSONParser jsonParser = new JSONParser();
 157       JSONObject jsonObj = (JSONObject) jsonParser
 158               .parse(pdbJsonResponseString);
 159
 160       JSONObject pdbResponse = (JSONObject) jsonObj.get("response");
 161       String queryTime = ((JSONObject) jsonObj.get("responseHeader")).get(
 162               "QTime").toString();
 163       int numFound = Integer
 164               .valueOf(pdbResponse.get("numFound").toString());
 165       if (numFound > 0)
 166       {
 167         result = new ArrayList<PDBResponseSummary>();
 168         JSONArray docs = (JSONArray) pdbResponse.get("docs");
 169         for (Iterator<JSONObject> docIter = docs.iterator(); docIter
 170                 .hasNext();)
 171         {
 172           JSONObject doc = docIter.next();
 173           result.add(searchResult.new PDBResponseSummary(doc,
 174                   pdbRestRequest));
 175         }
 176         searchResult.setNumberOfItemsFound(numFound);
 177         searchResult.setResponseTime(queryTime);
 178         searchResult.setSearchSummary(result);
 179       }
 180     } catch (ParseException e)
 181     {
 182       e.printStackTrace();
 183     }
 184     return searchResult;
 185   }
 186
 187   /**
 188    * Takes a collection of PDBDocField and converts its 'code' Field values into
 189    * a comma delimited string.
 190    *
 191    * @param pdbDocfields
 192    *          the collection of PDBDocField to process
 193    * @return the comma delimited string from the pdbDocFields collection
 194    */
 195   public static String getPDBDocFieldsAsCommaDelimitedString(
 196           Collection<PDBDocField> pdbDocfields)
 197   {
 198     String result = "";
 199     if (pdbDocfields != null && !pdbDocfields.isEmpty())
 200     {
 201       StringBuilder returnedFields = new StringBuilder();
 202       for (PDBDocField field : pdbDocfields)
 203       {
 204         returnedFields.append(",").append(field.getCode());
 205       }
 206       returnedFields.deleteCharAt(0);
 207       result = returnedFields.toString();
 208     }
 209     return result;
 210   }
 211
 212   /**
 213    * Determines the column index for 'PDB Id' Fields in the dynamic summary
 214    * table. The PDB Id serves as a unique identifier for a given row in the
 215    * summary table
 216    *
 217    * @param wantedFeilds
 218    *          the available table columns in no particular order
 219    * @return the pdb id field column index
 220    */
 221   public static int getPDBIdColumIndex(
 222           Collection<PDBDocField> wantedFeilds, boolean hasRefSeq)
 223   {
 224
 225     // If a reference sequence is attached then start counting from 1 else
 226     // start from zero
 227     int pdbFeildIndexCounter = hasRefSeq ? 1 : 0;
 228
 229     for (PDBDocField feild : wantedFeilds)
 230     {
 231       if (feild.equals(PDBDocField.PDB_ID))
 232       {
 233         break; // Once PDB Id index is determined exit iteration
 234       }
 235       ++pdbFeildIndexCounter;
 236     }
 237     return pdbFeildIndexCounter;
 238   }
 239
 240   /**
 241    * This enum represents the fields available in the PDB JSON response
 242    *
 243    */
 244   public enum PDBDocField
 245   {
 246     PDB_ID("PDB Id", "pdb_id"), TITLE("Title", "title"), MOLECULE_NAME(
 247             "Molecule", "molecule_name"), MOLECULE_TYPE("Molecule Type",
 248             "molecule_type"), MOLECULE_SEQUENCE("Sequence",
 249             "molecule_sequence"), PFAM_ACCESSION("PFAM Accession",
 250             "pfam_accession"), PFAM_NAME("PFAM Name", "pfam_name"), INTERPRO_NAME(
 251             "InterPro Name", "interpro_name"), INTERPRO_ACCESSION(
 252             "InterPro Accession", "interpro_accession"), UNIPROT_ID(
 253             "UniProt Id", "uniprot_id"), UNIPROT_ACCESSION(
 254             "UniProt Accession", "uniprot_accession"), UNIPROT_COVERAGE(
 255             "UniProt Coverage", "uniprot_coverage"), UNIPROT_FEATURES(
 256             "Uniprot Features", "uniprot_features"), R_FACTOR("R Factor",
 257             "r_factor"), RESOLUTION("Resolution", "resolution"), DATA_QUALITY(
 258             "Data Quality", "data_quality"), OVERALL_QUALITY(
 259             "Overall Quality", "overall_quality"), POLYMER_COUNT(
 260             "Number of Polymers", "number_of_polymers"), PROTEIN_CHAIN_COUNT(
 261             "Number of Protein Chains", "number_of_protein_chains"), BOUND_MOLECULE_COUNT(
 262             "Number of Bound Molecule", "number_of_bound_molecules"), POLYMER_RESIDUE_COUNT(
 263             "Number of Polymer Residue", "number_of_polymer_residues"), GENUS(
 264             "GENUS", "genus"), GENE_NAME("Gene Name", "gene_name"), EXPERIMENTAL_METHOD(
 265             "Experimental Method", "experimental_method"), GO_ID("GO Id",
 266             "go_id"), ASSEMBLY_ID("Assembly Id", "assembly_form"), ASSEMBLY_FORM(
 267             "Assembly Form", "assembly_id"), ASSEMBLY_TYPE("Assembly Type",
 268             "assembly_type"), SPACE_GROUP("Space Group", "spacegroup"), CATH_CODE(
 269             "Cath Code", "cath_code"), TAX_ID("Tax Id", "tax_id"), TAX_QUERY(
 270             "Tax Query", "tax_query"), INTERACTING_ENTRY_ID(
 271             "Interacting Entry Id", "interacting_entry_id"), INTERACTING_ENTITY_ID(
 272             "Interacting Entity Id", "interacting_entity_id"), INTERACTING_MOLECULES(
 273             "Interacting Molecules", "interacting_molecules"), PUBMED_ID(
 274             "Pubmed Id", "pubmed_id"), STATUS("Status", "status"), MODEL_QUALITY(
 275             "Model Quality", "model_quality"), PIVOT_RESOLUTION(
 276             "Pivot Resolution", "pivot_resolution"), DATA_REDUCTION_SOFTWARE(
 277             "Data reduction software", "data_reduction_software"), MAX_OBSERVED_RES(
 278             "Max observed residues", "max_observed_residues"), ORG_SCI_NAME(
 279             "Organism scientific name", "organism_scientific_name"), SUPER_KINGDOM(
 280             "Super kingdom", "superkingdom"), RANK("Rank", "rank"), CRYSTALLISATION_PH(
 281             "Crystallisation Ph", "crystallisation_ph"), BIOLOGICAL_FUNCTION(
 282             "Biological Function", "biological_function"), BIOLOGICAL_PROCESS(
 283             "Biological Process", "biological_process"), BIOLOGICAL_CELL_COMPONENT(
 284             "Biological Cell Component", "biological_cell_component"), COMPOUND_NAME(
 285             "Compound Name", "compound_name"), COMPOUND_ID("Compound Id",
 286             "compound_id"), COMPOUND_WEIGHT("Compound Weight",
 287             "compound_weight"), COMPOUND_SYSTEMATIC_NAME(
 288             "Compound Systematic Name", "compound_systematic_name"), INTERACTING_LIG(
 289             "Interacting Ligands", "interacting_ligands"), JOURNAL(
 290             "Journal", "journal"), ALL_AUTHORS("All Authors", "all_authors"), EXPERIMENTAL_DATA_AVAILABLE(
 291             "Experiment Data Available", "experiment_data_available"), DIFFRACTION_PROTOCOL(
 292             "Diffraction Protocol", "diffraction_protocol"), REFINEMENT_SOFTWARE(
 293             "Refinement Software", "refinement_software"), STRUCTURE_DETERMINATION_METHOD(
 294             "Structure Determination Method",
 295             "structure_determination_method"), SYNCHROTON_SITE(
 296             "Synchrotron Site", "synchrotron_site"), SAMPLE_PREP_METHOD(
 297             "Sample Preparation Method", "sample_preparation_method"), ENTRY_AUTHORS(
 298             "Entry Authors", "entry_authors"), CITATION_TITLE(
 299             "Citation Title", "citation_title"), STRUCTURE_SOLUTION_SOFTWARE(
 300             "Structure Solution Software", "structure_solution_software"), ENTRY_ENTITY(
 301             "Entry Entity", "entry_entity"), R_FREE("R Free", "r_free"), NO_OF_POLYMER_ENTITIES(
 302             "Number of Polymer Entities", "number_of_polymer_entities"), NO_OF_BOUND_ENTITIES(
 303             "Number of Bound Entities", "number_of_bound_entities"), CRYSTALLISATION_RESERVOIR(
 304             "Crystallisation Reservoir", "crystallisation_reservoir"), DATA_SCALING_SW(
 305             "Data Scalling Software", "data_scaling_software"), DETECTOR(
 306             "Detector", "detector"), DETECTOR_TYPE("Detector Type",
 307             "detector_type"), MODIFIED_RESIDUE_FLAG(
 308             "Modified Residue Flag", "modified_residue_flag"), NUMBER_OF_COPIES(
 309             "Number of Copies", "number_of_copies"), STRUCT_ASYM_ID(
 310             "Struc Asym Id", "struct_asym_id"), HOMOLOGUS_PDB_ENTITY_ID(
 311             "Homologus PDB Entity Id", "homologus_pdb_entity_id"), MOLECULE_SYNONYM(
 312             "Molecule Synonym", "molecule_synonym"), DEPOSITION_SITE(
 313             "Deposition Site", "deposition_site"), SYNCHROTRON_BEAMLINE(
 314             "Synchrotron Beamline", "synchrotron_beamline"), ENTITY_ID(
 315             "Entity Id", "entity_id"), BEAM_SOURCE_NAME("Beam Source Name",
 316             "beam_source_name"), PROCESSING_SITE("Processing Site",
 317             "processing_site"), ENTITY_WEIGHT("Entity Weight",
 318             "entity_weight"), VERSION("Version", "_version_"), ALL("ALL",
 319             "text");
 320
 321     private String name;
 322
 323     private String code;
 324
 325     PDBDocField(String name, String code)
 326     {
 327       this.name = name;
 328       this.code = code;
 329     }
 330
 331     public String getName()
 332     {
 333       return name;
 334     }
 335
 336     public String getCode()
 337     {
 338       return code;
 339     }
 340
 341     public String toString()
 342     {
 343       return name;
 344     }
 345   }
 346 }