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.ws.seqfetcher;
23 import jalview.bin.Cache;
24 import jalview.datamodel.AlignmentI;
25 import jalview.datamodel.DBRefEntry;
26 import jalview.datamodel.SequenceI;
27 import jalview.util.DBRefUtils;
28 import jalview.util.MessageManager;
30 import java.util.ArrayList;
31 import java.util.Collections;
32 import java.util.Comparator;
33 import java.util.Enumeration;
34 import java.util.HashSet;
35 import java.util.Hashtable;
36 import java.util.List;
38 import java.util.Stack;
39 import java.util.Vector;
41 public class ASequenceFetcher
45 * set of databases we can retrieve entries from
47 protected Hashtable<String, Map<String, DbSourceProxy>> fetchableDbs;
50 * comparator to sort by tier (0/1/2) and name
52 private Comparator<DbSourceProxy> proxyComparator;
57 public ASequenceFetcher()
62 * comparator to sort proxies by tier and name
64 proxyComparator = new Comparator<DbSourceProxy>()
67 public int compare(DbSourceProxy o1, DbSourceProxy o2)
70 * Tier 0 precedes 1 precedes 2
72 int compared = Integer.compare(o1.getTier(), o2.getTier());
75 // defend against NullPointer - should never happen
76 String o1Name = o1.getDbName();
77 String o2Name = o2.getDbName();
78 if (o1Name != null && o2Name != null)
80 compared = o1Name.compareToIgnoreCase(o2Name);
89 * get array of supported Databases
91 * @return database source string for each database - only the latest version
92 * of a source db is bound to each source.
94 public String[] getSupportedDb()
96 if (fetchableDbs == null)
100 String[] sf = fetchableDbs.keySet().toArray(
101 new String[fetchableDbs.size()]);
105 public boolean isFetchable(String source)
107 for (String db : fetchableDbs.keySet())
109 if (source.equalsIgnoreCase(db))
114 Cache.log.warn("isFetchable doesn't know about '" + source
120 * Fetch sequences for the given cross-references
124 * if true, only fetch from nucleotide data sources, else peptide
127 public SequenceI[] getSequences(DBRefEntry[] refs, boolean dna)
129 Vector<SequenceI> rseqs = new Vector<SequenceI>();
130 Hashtable<String, List<String>> queries = new Hashtable<String, List<String>>();
131 for (int r = 0; r < refs.length; r++)
133 if (!queries.containsKey(refs[r].getSource()))
135 queries.put(refs[r].getSource(), new ArrayList<String>());
137 List<String> qset = queries.get(refs[r].getSource());
138 if (!qset.contains(refs[r].getAccessionId()))
140 qset.add(refs[r].getAccessionId());
143 Enumeration<String> e = queries.keys();
144 while (e.hasMoreElements())
146 List<String> query = null;
148 db = e.nextElement();
149 query = queries.get(db);
150 if (!isFetchable(db))
152 reportStdError(db, query, new Exception(
153 "Don't know how to fetch from this database :" + db));
157 Stack<String> queriesLeft = new Stack<String>();
158 queriesLeft.addAll(query);
160 for (DbSourceProxy fetcher : getSourceProxy(db))
162 List<String> queriesMade = new ArrayList<String>();
163 HashSet<String> queriesFound = new HashSet<String>();
166 if (fetcher.isDnaCoding() != dna)
168 continue; // wrong sort of data
170 boolean doMultiple = fetcher.getAccessionSeparator() != null;
171 // No separator - no Multiple Queries
172 while (!queriesLeft.isEmpty())
174 StringBuffer qsb = new StringBuffer();
177 if (qsb.length() > 0)
179 qsb.append(fetcher.getAccessionSeparator());
181 String q = queriesLeft.pop();
184 } while (doMultiple && !queriesLeft.isEmpty());
186 AlignmentI seqset = null;
189 // create a fetcher and go to it
190 seqset = fetcher.getSequenceRecords(qsb.toString()); // ,
192 } catch (Exception ex)
194 System.err.println("Failed to retrieve the following from "
196 System.err.println(qsb);
197 ex.printStackTrace(System.err);
199 // TODO: Merge alignment together - perhaps
202 SequenceI seqs[] = seqset.getSequencesArray();
205 for (int is = 0; is < seqs.length; is++)
207 rseqs.addElement(seqs[is]);
208 DBRefEntry[] frefs = DBRefUtils.searchRefs(seqs[is]
209 .getDBRefs(), new DBRefEntry(db, null, null));
212 for (DBRefEntry dbr : frefs)
214 queriesFound.add(dbr.getAccessionId());
215 queriesMade.remove(dbr.getAccessionId());
223 if (fetcher.getRawRecords() != null)
225 System.out.println("# Retrieved from " + db + ":"
227 StringBuffer rrb = fetcher.getRawRecords();
229 * for (int rr = 0; rr<rrb.length; rr++) {
234 hdr = "# " + db + ":" + qsb.toString();
236 * } else { hdr = "# part "+rr; }
238 System.out.println(hdr);
241 System.out.println(rrb);
243 System.out.println("# end of " + hdr);
250 } catch (Exception ex)
252 reportStdError(db, queriesMade, ex);
254 if (queriesMade.size() > 0)
256 System.out.println("# Adding " + queriesMade.size()
257 + " ids back to queries list for searching again (" + db
259 queriesLeft.addAll(queriesMade);
264 SequenceI[] result = null;
265 if (rseqs.size() > 0)
267 result = new SequenceI[rseqs.size()];
269 for (SequenceI s : rseqs)
278 public void reportStdError(String db, List<String> queriesMade,
282 System.err.println("Failed to retrieve the following references from "
285 for (String qv : queriesMade)
287 System.err.print(" " + qv + ";");
290 System.err.println();
294 System.err.println();
295 ex.printStackTrace();
299 * Returns a list of proxies for the given source
302 * database source string TODO: add version string/wildcard for
303 * retrieval of specific DB source/version combinations.
304 * @return a list of DbSourceProxy for the db
306 public List<DbSourceProxy> getSourceProxy(String db)
308 db = DBRefUtils.getCanonicalName(db);
309 Map<String, DbSourceProxy> dblist = fetchableDbs.get(db);
312 return new ArrayList<DbSourceProxy>();
316 * sort so that primary sources precede secondary
318 List<DbSourceProxy> dbs = new ArrayList<DbSourceProxy>(dblist.values());
319 Collections.sort(dbs, proxyComparator);
324 * constructs an instance of the proxy and registers it as a valid dbrefsource
326 * @param dbSourceProxy
327 * reference for class implementing
328 * jalview.ws.seqfetcher.DbSourceProxy
330 protected void addDBRefSourceImpl(
331 Class<? extends DbSourceProxy> dbSourceProxy)
332 throws IllegalArgumentException
334 DbSourceProxy proxy = null;
337 DbSourceProxy proxyObj = dbSourceProxy.getConstructor().newInstance();
339 } catch (IllegalArgumentException e)
342 } catch (Exception e)
344 // Serious problems if this happens.
347 .getString("error.dbrefsource_implementation_exception"),
350 addDbRefSourceImpl(proxy);
354 * add the properly initialised DbSourceProxy object 'proxy' to the list of
359 protected void addDbRefSourceImpl(DbSourceProxy proxy)
363 if (fetchableDbs == null)
365 fetchableDbs = new Hashtable<String, Map<String, DbSourceProxy>>();
367 Map<String, DbSourceProxy> slist = fetchableDbs.get(proxy
371 fetchableDbs.put(proxy.getDbSource(),
372 slist = new Hashtable<String, DbSourceProxy>());
374 slist.put(proxy.getDbName(), proxy);
379 * select sources which are implemented by instances of the given class
381 * @param class that implements DbSourceProxy
382 * @return null or vector of source names for fetchers
384 public String[] getDbInstances(Class class1)
386 if (!DbSourceProxy.class.isAssignableFrom(class1))
391 "error.implementation_error_dbinstance_must_implement_interface",
392 new String[] { class1.toString() }));
394 if (fetchableDbs == null)
398 String[] sources = null;
399 Vector<String> src = new Vector<String>();
400 Enumeration<String> dbs = fetchableDbs.keys();
401 while (dbs.hasMoreElements())
403 String dbn = dbs.nextElement();
404 for (DbSourceProxy dbp : fetchableDbs.get(dbn).values())
406 if (class1.isAssignableFrom(dbp.getClass()))
414 src.copyInto(sources = new String[src.size()]);
419 public DbSourceProxy[] getDbSourceProxyInstances(Class class1)
421 List<DbSourceProxy> prlist = new ArrayList<DbSourceProxy>();
422 for (String fetchable : getSupportedDb())
424 for (DbSourceProxy pr : getSourceProxy(fetchable))
426 if (class1.isInstance(pr))
432 if (prlist.size() == 0)
436 return prlist.toArray(new DbSourceProxy[0]);