2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
21 package jalview.fts.service.pdb;
23 import jalview.datamodel.SequenceI;
24 import jalview.fts.api.FTSData;
25 import jalview.fts.api.FTSDataColumnI;
26 import jalview.fts.api.FTSRestClientI;
27 import jalview.fts.core.FTSRestClient;
28 import jalview.fts.core.FTSRestRequest;
29 import jalview.fts.core.FTSRestResponse;
30 import jalview.util.MessageManager;
32 import java.util.ArrayList;
33 import java.util.Collection;
34 import java.util.Iterator;
35 import java.util.List;
36 import java.util.Objects;
38 import javax.ws.rs.core.MediaType;
40 import org.json.simple.JSONArray;
41 import org.json.simple.JSONObject;
42 import org.json.simple.parser.JSONParser;
43 import org.json.simple.parser.ParseException;
45 import com.sun.jersey.api.client.Client;
46 import com.sun.jersey.api.client.ClientResponse;
47 import com.sun.jersey.api.client.WebResource;
48 import com.sun.jersey.api.client.config.ClientConfig;
49 import com.sun.jersey.api.client.config.DefaultClientConfig;
52 * A rest client for querying the Search endpoint of the PDB API
57 public class PDBFTSRestClient extends FTSRestClient
60 private static FTSRestClientI instance = null;
62 public static final String PDB_SEARCH_ENDPOINT = "http://www.ebi.ac.uk/pdbe/search/pdb/select?";
64 protected PDBFTSRestClient()
69 * Takes a PDBRestRequest object and returns a response upon execution
71 * @param pdbRestRequest
72 * the PDBRestRequest instance to be processed
73 * @return the pdbResponse object for the given request
77 public FTSRestResponse executeRequest(FTSRestRequest pdbRestRequest)
82 ClientConfig clientConfig = new DefaultClientConfig();
83 Client client = Client.create(clientConfig);
85 String wantedFields = getDataColumnsFieldsAsCommaDelimitedString(pdbRestRequest
87 int responseSize = (pdbRestRequest.getResponseSize() == 0) ? getDefaultResponsePageSize()
88 : pdbRestRequest.getResponseSize();
89 int offSet = pdbRestRequest.getOffSet();
90 String sortParam = null;
91 if (pdbRestRequest.getFieldToSortBy() == null
92 || pdbRestRequest.getFieldToSortBy().trim().isEmpty())
98 if (pdbRestRequest.getFieldToSortBy()
99 .equalsIgnoreCase("Resolution"))
101 sortParam = pdbRestRequest.getFieldToSortBy()
102 + (pdbRestRequest.isAscending() ? " asc" : " desc");
106 sortParam = pdbRestRequest.getFieldToSortBy()
107 + (pdbRestRequest.isAscending() ? " desc" : " asc");
111 String facetPivot = (pdbRestRequest.getFacetPivot() == null || pdbRestRequest
112 .getFacetPivot().isEmpty()) ? "" : pdbRestRequest
114 String facetPivotMinCount = String.valueOf(pdbRestRequest
115 .getFacetPivotMinCount());
117 String query = pdbRestRequest.getFieldToSearchBy()
118 + pdbRestRequest.getSearchTerm()
119 + (pdbRestRequest.isAllowEmptySeq() ? ""
120 : " AND molecule_sequence:['' TO *]")
121 + (pdbRestRequest.isAllowUnpublishedEntries() ? ""
122 : " AND status:REL");
124 // Build request parameters for the REST Request
125 WebResource webResource = null;
126 if (pdbRestRequest.isFacet())
128 webResource = client.resource(PDB_SEARCH_ENDPOINT)
129 .queryParam("wt", "json").queryParam("fl", wantedFields)
130 .queryParam("rows", String.valueOf(responseSize))
131 .queryParam("q", query)
132 .queryParam("start", String.valueOf(offSet))
133 .queryParam("sort", sortParam).queryParam("facet", "true")
134 .queryParam("facet.pivot", facetPivot)
135 .queryParam("facet.pivot.mincount", facetPivotMinCount);
139 webResource = client.resource(PDB_SEARCH_ENDPOINT)
140 .queryParam("wt", "json").queryParam("fl", wantedFields)
141 .queryParam("rows", String.valueOf(responseSize))
142 .queryParam("start", String.valueOf(offSet))
143 .queryParam("q", query)
144 .queryParam("sort", sortParam);
146 // Execute the REST request
147 ClientResponse clientResponse = webResource.accept(
148 MediaType.APPLICATION_JSON).get(ClientResponse.class);
150 // Get the JSON string from the response object
151 String responseString = clientResponse.getEntity(String.class);
152 // System.out.println("query >>>>>>> " + pdbRestRequest.toString());
154 // Check the response status and report exception if one occurs
155 if (clientResponse.getStatus() != 200)
157 String errorMessage = "";
158 if (clientResponse.getStatus() == 400)
160 errorMessage = parseJsonExceptionString(responseString);
161 throw new Exception(errorMessage);
165 errorMessage = getMessageByHTTPStatusCode(clientResponse
166 .getStatus(), "PDB");
167 throw new Exception(errorMessage);
171 // Make redundant objects eligible for garbage collection to conserve
173 clientResponse = null;
176 // Process the response and return the result to the caller.
177 return parsePDBJsonResponse(responseString, pdbRestRequest);
178 } catch (Exception e)
180 String exceptionMsg = e.getMessage();
181 if (exceptionMsg.contains("SocketException"))
183 // No internet connection
186 .getString("exception.unable_to_detect_internet_connection"));
188 else if (exceptionMsg.contains("UnknownHostException"))
190 // The server 'www.ebi.ac.uk' is unreachable
191 throw new Exception(MessageManager.formatMessage(
192 "exception.fts_server_unreachable", "PDB Solr"));
203 * Process error response from PDB server if/when one occurs.
205 * @param jsonResponse
206 * the JSON string containing error message from the server
207 * @return the processed error message from the JSON string
209 public static String parseJsonExceptionString(String jsonErrorResponse)
211 StringBuilder errorMessage = new StringBuilder(
212 "\n============= PDB Rest Client RunTime error =============\n");
216 JSONParser jsonParser = new JSONParser();
217 JSONObject jsonObj = (JSONObject) jsonParser.parse(jsonErrorResponse);
218 JSONObject errorResponse = (JSONObject) jsonObj.get("error");
220 JSONObject responseHeader = (JSONObject) jsonObj
221 .get("responseHeader");
222 JSONObject paramsObj = (JSONObject) responseHeader.get("params");
223 String status = responseHeader.get("status").toString();
224 String message = errorResponse.get("msg").toString();
225 String query = paramsObj.get("q").toString();
226 String fl = paramsObj.get("fl").toString();
228 errorMessage.append("Status: ").append(status).append("\n");
229 errorMessage.append("Message: ").append(message).append("\n");
230 errorMessage.append("query: ").append(query).append("\n");
231 errorMessage.append("fl: ").append(fl).append("\n");
233 } catch (ParseException e)
237 return errorMessage.toString();
241 * Parses the JSON response string from PDB REST API. The response is dynamic
242 * hence, only fields specifically requested for in the 'wantedFields'
243 * parameter is fetched/processed
245 * @param pdbJsonResponseString
246 * the JSON string to be parsed
247 * @param pdbRestRequest
248 * the request object which contains parameters used to process the
252 @SuppressWarnings("unchecked")
253 public static FTSRestResponse parsePDBJsonResponse(
254 String pdbJsonResponseString, FTSRestRequest pdbRestRequest)
256 FTSRestResponse searchResult = new FTSRestResponse();
257 List<FTSData> result = null;
260 JSONParser jsonParser = new JSONParser();
261 JSONObject jsonObj = (JSONObject) jsonParser
262 .parse(pdbJsonResponseString);
264 JSONObject pdbResponse = (JSONObject) jsonObj.get("response");
265 String queryTime = ((JSONObject) jsonObj.get("responseHeader")).get(
267 int numFound = Integer
268 .valueOf(pdbResponse.get("numFound").toString());
271 result = new ArrayList<FTSData>();
272 JSONArray docs = (JSONArray) pdbResponse.get("docs");
273 for (Iterator<JSONObject> docIter = docs.iterator(); docIter
276 JSONObject doc = docIter.next();
277 result.add(getFTSData(doc, pdbRestRequest));
279 searchResult.setNumberOfItemsFound(numFound);
280 searchResult.setResponseTime(queryTime);
281 searchResult.setSearchSummary(result);
283 } catch (ParseException e)
290 public static FTSData getFTSData(JSONObject pdbJsonDoc,
291 FTSRestRequest request)
294 String primaryKey = null;
296 Object[] summaryRowData;
298 SequenceI associatedSequence;
300 Collection<FTSDataColumnI> diplayFields = request.getWantedFields();
301 SequenceI associatedSeq = request.getAssociatedSequence();
303 summaryRowData = new Object[(associatedSeq != null) ? diplayFields
304 .size() + 1 : diplayFields.size()];
305 if (associatedSeq != null)
307 associatedSequence = associatedSeq;
308 summaryRowData[0] = associatedSequence;
312 for (FTSDataColumnI field : diplayFields)
314 String fieldData = (pdbJsonDoc.get(field.getCode()) == null) ? ""
315 : pdbJsonDoc.get(field.getCode()).toString();
316 if (field.isPrimaryKeyColumn())
318 primaryKey = fieldData;
319 summaryRowData[colCounter++] = primaryKey;
321 else if (fieldData == null || fieldData.isEmpty())
323 summaryRowData[colCounter++] = null;
329 summaryRowData[colCounter++] = (field.getDataType()
330 .getDataTypeClass() == Integer.class) ? Integer
332 : (field.getDataType()
333 .getDataTypeClass() == Double.class) ? Double
335 : sanitiseData(fieldData);
336 } catch (Exception e)
339 System.out.println("offending value:" + fieldData);
344 final String primaryKey1 = primaryKey;
346 final Object[] summaryRowData1 = summaryRowData;
350 public Object[] getSummaryData()
352 return summaryRowData1;
356 public Object getPrimaryKey()
362 * Returns a string representation of this object;
365 public String toString()
367 StringBuilder summaryFieldValues = new StringBuilder();
368 for (Object summaryField : summaryRowData1)
370 summaryFieldValues.append(
371 summaryField == null ? " " : summaryField.toString())
374 return summaryFieldValues.toString();
378 * Returns hash code value for this object
381 public int hashCode()
383 return Objects.hash(primaryKey1, this.toString());
387 public boolean equals(Object that)
389 return this.toString().equals(that.toString());
394 private static String sanitiseData(String data)
396 String cleanData = data.replaceAll("\\[\"", "").replaceAll("\\]\"", "")
397 .replaceAll("\\[", "").replaceAll("\\]", "")
398 .replaceAll("\",\"", ", ").replaceAll("\"", "");
403 public String getColumnDataConfigFileName()
405 return "/fts/pdb_data_columns.txt";
409 public static FTSRestClientI getInstance()
411 if (instance == null)
413 instance = new PDBFTSRestClient();
418 private Collection<FTSDataColumnI> allDefaultDisplayedStructureDataColumns;
420 public Collection<FTSDataColumnI> getAllDefaultDisplayedStructureDataColumns()
422 if (allDefaultDisplayedStructureDataColumns == null
423 || allDefaultDisplayedStructureDataColumns.isEmpty())
425 allDefaultDisplayedStructureDataColumns = new ArrayList<FTSDataColumnI>();
426 allDefaultDisplayedStructureDataColumns.addAll(super
427 .getAllDefaultDisplayedFTSDataColumns());
429 return allDefaultDisplayedStructureDataColumns;