X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fjalview%2Fws%2Febi%2FEBIFetchClient.java;h=9f6bc65a8524b5a3a20a4da12cd352c49313bfc4;hb=65d6d09cd08743d481d39521bb0298ea683888f8;hp=7135d0c2eaed2ad9d37a3241045ae1bd8867325c;hpb=a45774ee31d9f35d4eff46d54d7deab719afb092;p=jalview.git
diff --git a/src/jalview/ws/ebi/EBIFetchClient.java b/src/jalview/ws/ebi/EBIFetchClient.java
index 7135d0c..9f6bc65 100644
--- a/src/jalview/ws/ebi/EBIFetchClient.java
+++ b/src/jalview/ws/ebi/EBIFetchClient.java
@@ -1,242 +1,260 @@
-/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
- *
- * This file is part of Jalview.
- *
- * Jalview is free software: you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- *
- * Jalview is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty
- * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
- * PURPOSE. See the GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along with Jalview. If not, see .
- */
-package jalview.ws.ebi;
-
-import java.io.*;
-import java.util.*;
-import javax.xml.namespace.*;
-import javax.xml.rpc.*;
-
-import org.apache.axis.client.Call;
-import org.apache.axis.client.Service;
-import org.apache.axis.encoding.*;
-
-/**
- * DOCUMENT ME!
- *
- * @author $author$
- * @version $Revision$
- */
-public class EBIFetchClient
-{
- Call call;
-
- String format = "default";
-
- String style = "raw";
-
- /**
- * Creates a new EBIFetchClient object.
- */
- public EBIFetchClient()
- {
- try
- {
- call = (Call) new Service().createCall();
- call.setTargetEndpointAddress(new java.net.URL(
- "http://www.ebi.ac.uk/ws/services/Dbfetch"));
- } catch (Exception ex)
- {
- }
- }
-
- /**
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
- */
- public String[] getSupportedDBs()
- {
- try
- {
- call.setOperationName(new QName("urn:Dbfetch", "getSupportedDBs"));
- call.setReturnType(XMLType.SOAP_ARRAY);
-
- return (String[]) call.invoke(new Object[]
- {});
- } catch (Exception ex)
- {
- return null;
- }
- }
-
- /**
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
- */
- public String[] getSupportedFormats()
- {
- try
- {
- call.setOperationName(new QName("urn:Dbfetch", "getSupportedFormats"));
- call.setReturnType(XMLType.SOAP_ARRAY);
-
- return (String[]) call.invoke(new Object[]
- {});
- } catch (Exception ex)
- {
- return null;
- }
- }
-
- /**
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
- */
- public String[] getSupportedStyles()
- {
- try
- {
- call.setOperationName(new QName("urn:Dbfetch", "getSupportedStyles"));
- call.setReturnType(XMLType.SOAP_ARRAY);
-
- return (String[]) call.invoke(new Object[]
- {});
- } catch (Exception ex)
- {
- return null;
- }
- }
-
- public File fetchDataAsFile(String ids, String f, String s)
- throws OutOfMemoryError
- {
- String[] data = fetchData(ids, f, s);
- // TODO: after JV 2.4 - test data==null and pass error(s) back up if
- // possible (OutOfMemoryErrors are usual problem)
- if (data == null)
- {
- return null;
- }
- File outFile = null;
- try
- {
- outFile = File.createTempFile("jalview", ".xml");
- outFile.deleteOnExit();
- PrintWriter out = new PrintWriter(new FileOutputStream(outFile));
- int index = 0;
- while (index < data.length)
- {
- out.println(data[index]);
- index++;
- }
- out.close();
- } catch (Exception ex)
- {
- }
- return outFile;
- }
-
- /**
- * Single DB multiple record retrieval
- *
- * @param ids
- * db:query1;query2;query3
- * @param f
- * raw/xml
- * @param s
- * ?
- *
- * @return Raw string array result of query set
- */
- public String[] fetchData(String ids, String f, String s)
- throws OutOfMemoryError
- {
- // Need to split
- // ids of the form uniprot:25KD_SARPE;ADHR_DROPS;
- StringTokenizer queries = new StringTokenizer(ids, ";");
- String db = null;
- StringBuffer querystring = null;
- while (queries.hasMoreTokens())
- {
- String query = queries.nextToken();
- int p;
- if ((p = query.indexOf(':')) > -1)
- {
- db = query.substring(0, p);
- query = query.substring(p + 1);
- }
- if (querystring == null)
- {
- querystring = new StringBuffer(query);
- }
- else
- {
- querystring.append("," + query);
- }
- }
- if (db == null)
- {
- System.err.println("Invalid Query string : '" + ids
- + "'\nShould be of form 'dbname:q1;q2;q3;q4'");
- }
- return fetchBatch(querystring.toString(), db, f, s);
- }
-
- public String[] fetchBatch(String ids, String db, String f, String s)
- throws OutOfMemoryError
- {
- // max 50 ids can be added at one time
- try
- {
- // call.setOperationName(new QName("urn:Dbfetch", "fetchData"));
- call.setOperationName(new QName("urn:Dbfetch", "fetchBatch"));
- call.addParameter("ids", XMLType.XSD_STRING, ParameterMode.IN);
- call.addParameter("db", XMLType.XSD_STRING, ParameterMode.IN);
- call.addParameter("format", XMLType.XSD_STRING, ParameterMode.IN);
- call.addParameter("style", XMLType.XSD_STRING, ParameterMode.IN);
- call.setReturnType(XMLType.SOAP_ARRAY);
-
- if (f != null)
- {
- format = f;
- }
-
- if (s != null)
- {
- style = s;
- }
-
- try
- {
- return (String[]) call.invoke(new Object[]
- { ids.toLowerCase(), db.toLowerCase(), format, style });
- } catch (OutOfMemoryError er)
- {
-
- System.out.println("OUT OF MEMORY DOWNLOADING QUERY FROM " + db
- + ":\n" + ids);
- throw er;
- }
- // return null;
- } catch (Exception ex)
- {
- if (ex.getMessage().startsWith(
- "uk.ac.ebi.jdbfetch.exceptions.DbfNoEntryFoundException"))
- {
- return null;
- }
- System.err.println("Unexpected exception when retrieving from " + db
- + "\nQuery was : '" + ids + "'");
- ex.printStackTrace(System.err);
- return null;
- }
- }
-}
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.ws.ebi;
+
+import jalview.datamodel.DBRefSource;
+import jalview.util.MessageManager;
+
+import java.io.BufferedInputStream;
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.StringTokenizer;
+
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
+public class EBIFetchClient
+{
+ String format = "default";
+
+ String style = "raw";
+
+ /**
+ * Creates a new EBIFetchClient object.
+ */
+ public EBIFetchClient()
+ {
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
+ public String[] getSupportedDBs()
+ {
+ // TODO - implement rest call for dbfetch getSupportedDBs
+ throw new Error(MessageManager.getString("error.not_yet_implemented"));
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
+ public String[] getSupportedFormats()
+ {
+ // TODO - implement rest call for dbfetch getSupportedFormats
+ throw new Error(MessageManager.getString("error.not_yet_implemented"));
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
+ public String[] getSupportedStyles()
+ {
+ // TODO - implement rest call for dbfetch getSupportedStyles
+ throw new Error(MessageManager.getString("error.not_yet_implemented"));
+ }
+
+ /**
+ * Send an HTTP fetch request to EBI and save the reply in a temporary file.
+ *
+ * @param ids
+ * the query formatted as db:query1;query2;query3
+ * @param format
+ * the format wanted
+ * @param s
+ * - unused parameter
+ * @return the file holding the response
+ * @throws OutOfMemoryError
+ */
+
+ public File fetchDataAsFile(String ids, String format, String s,
+ String ext)
+ throws OutOfMemoryError
+ {
+ File outFile = null;
+ try
+ {
+ outFile = File.createTempFile("jalview", ext);
+ outFile.deleteOnExit();
+ fetchData(ids, format, s, outFile);
+ if (outFile.length() == 0)
+ {
+ outFile.delete();
+ return null;
+ }
+ } catch (Exception ex)
+ {
+ }
+ return outFile;
+ }
+
+ /**
+ * Single DB multiple record retrieval
+ *
+ * @param ids
+ * db:query1;query2;query3
+ * @param format
+ * raw/xml
+ * @param s
+ * not used - remove?
+ *
+ * @return Raw string array result of query set
+ */
+ public String[] fetchData(String ids, String format, String s)
+ throws OutOfMemoryError
+ {
+ return fetchData(ids, format, s, null);
+ }
+
+ String[] fetchData(String ids, String f, String s, File outFile)
+ throws OutOfMemoryError
+ {
+ // Need to split
+ // ids of the form uniprot:25KD_SARPE;ADHR_DROPS;
+ String[] rslts = new String[0];
+ StringTokenizer queries = new StringTokenizer(ids, ";");
+ String db = null;
+ StringBuffer querystring = null;
+ int nq = 0;
+ while (queries.hasMoreTokens())
+ {
+ String query = queries.nextToken();
+ int p;
+ if ((p = query.indexOf(':')) > -1)
+ {
+ db = query.substring(0, p);
+ query = query.substring(p + 1);
+ }
+ if (querystring == null)
+ {
+ querystring = new StringBuffer(query);
+ nq++;
+ }
+ else
+ {
+ querystring.append("," + query);
+ nq++;
+ }
+ }
+ if (db == null)
+ {
+ System.err.println("Invalid Query string : '" + ids
+ + "'\nShould be of form 'dbname:q1;q2;q3;q4'");
+ return null;
+ }
+ String[] rslt = fetchBatch(querystring.toString(), db, f, s, outFile);
+ if (rslt != null)
+ {
+ String[] nrslts = new String[rslt.length + rslts.length];
+ System.arraycopy(rslts, 0, nrslts, 0, rslts.length);
+ System.arraycopy(rslt, 0, nrslts, rslts.length, rslt.length);
+ rslts = nrslts;
+ }
+
+ return (rslts.length == 0 ? null : rslts);
+ }
+
+ public String[] fetchBatch(String ids, String dbPath, String format, String s,
+ File outFile) throws OutOfMemoryError
+ {
+ // long time = System.currentTimeMillis();
+ /*
+ * JAL-1855 dbfetch from ena_sequence, ena_coding
+ */
+ if (dbPath.equalsIgnoreCase(DBRefSource.EMBL))
+ {
+ dbPath = "ena_sequence";
+ }
+ else if (dbPath.equalsIgnoreCase(DBRefSource.EMBLCDS))
+ {
+ dbPath = "ena_coding";
+ }
+
+ try
+ {
+ URL rcall = new URL("http://www.ebi.ac.uk/Tools/dbfetch/dbfetch/"
+ + dbPath.toLowerCase() + "/" + ids.toLowerCase()
+ + (format != null ? "/" + format : ""));
+
+ InputStream is = new BufferedInputStream(rcall.openStream());
+ if (outFile != null)
+ {
+ FileOutputStream fio = new FileOutputStream(outFile);
+ byte[] bb = new byte[32 * 1024];
+ int l;
+ while ((l = is.read(bb)) > 0)
+ {
+ fio.write(bb, 0, l);
+ }
+ fio.close();
+ is.close();
+ }
+ else
+ {
+ BufferedReader br = new BufferedReader(new InputStreamReader(is));
+ String rtn;
+ List arl = new ArrayList();
+ while ((rtn = br.readLine()) != null)
+ {
+ arl.add(rtn);
+ }
+ return arl.toArray(new String[arl.size()]);
+ }
+ } catch (OutOfMemoryError er)
+ {
+
+ System.out.println("OUT OF MEMORY DOWNLOADING QUERY FROM " + dbPath
+ + ":\n" + ids);
+ throw er;
+ } catch (Exception ex)
+ {
+ if (ex.getMessage().startsWith(
+ "uk.ac.ebi.jdbfetch.exceptions.DbfNoEntryFoundException"))
+ {
+ return null;
+ }
+ System.err.println("Unexpected exception when retrieving from "
+ + dbPath
+ + "\nQuery was : '" + ids + "'");
+ ex.printStackTrace(System.err);
+ return null;
+ } finally
+ {
+ // System.err.println("EBIFetch took " + (System.currentTimeMillis() -
+ // time) + " ms");
+ }
+ return null;
+ }
+}