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.
23 import jalview.analysis.AlignSeq;
24 import jalview.bin.Cache;
25 import jalview.datamodel.AlignmentI;
26 import jalview.datamodel.DBRefEntry;
27 import jalview.datamodel.DBRefSource;
28 import jalview.datamodel.Mapping;
29 import jalview.datamodel.SequenceFeature;
30 import jalview.datamodel.SequenceI;
31 import jalview.gui.AlignFrame;
32 import jalview.gui.CutAndPasteTransfer;
33 import jalview.gui.Desktop;
34 import jalview.gui.IProgressIndicator;
35 import jalview.gui.OOMWarning;
36 import jalview.util.MessageManager;
37 import jalview.ws.dbsources.das.api.jalviewSourceI;
38 import jalview.ws.seqfetcher.DbSourceProxy;
40 import java.util.ArrayList;
41 import java.util.Enumeration;
42 import java.util.Hashtable;
43 import java.util.List;
44 import java.util.StringTokenizer;
45 import java.util.Vector;
47 import uk.ac.ebi.picr.model.UPEntry;
50 * Implements a runnable for validating a sequence against external databases
51 * and then propagating references and features onto the sequence(s)
56 public class DBRefFetcher implements Runnable
60 IProgressIndicator af;
62 CutAndPasteTransfer output = new CutAndPasteTransfer();
64 StringBuffer sbuffer = new StringBuffer();
66 boolean running = false;
69 * picr client instance
71 uk.ac.ebi.www.picr.AccessionMappingService.AccessionMapperInterface picrClient = null;
73 // /This will be a collection of Vectors of sequenceI refs.
74 // The key will be the seq name or accession id of the seq
77 DbSourceProxy[] dbSources;
79 SequenceFetcher sfetcher;
81 private SequenceI[] alseqs;
84 * when true - retrieved sequences will be trimmed to cover longest derived
87 private boolean trimDsSeqs = true;
94 * Creates a new SequenceFeatureFetcher object and fetches from the currently
95 * selected set of databases.
98 * fetch references for these sequences
100 * the parent alignframe for progress bar monitoring.
102 public DBRefFetcher(SequenceI[] seqs, AlignFrame af)
104 this(seqs, af, null);
108 * Creates a new SequenceFeatureFetcher object and fetches from the currently
109 * selected set of databases.
112 * fetch references for these sequences
114 * the parent alignframe for progress bar monitoring.
116 * array of database source strings to query references from
118 public DBRefFetcher(SequenceI[] seqs, AlignFrame af,
119 DbSourceProxy[] sources)
122 alseqs = new SequenceI[seqs.length];
123 SequenceI[] ds = new SequenceI[seqs.length];
124 for (int i = 0; i < seqs.length; i++)
127 if (seqs[i].getDatasetSequence() != null)
129 ds[i] = seqs[i].getDatasetSequence();
137 // TODO Jalview 2.5 lots of this code should be in the gui package!
138 sfetcher = jalview.gui.SequenceFetcher.getSequenceFetcherSingleton(af);
139 // set default behaviour for transferring excess sequence data to the
141 trimDsSeqs = Cache.getDefault("TRIM_FETCHED_DATASET_SEQS", true);
144 // af.featureSettings_actionPerformed(null);
145 String[] defdb = null, otherdb = sfetcher
146 .getDbInstances(jalview.ws.dbsources.das.datamodel.DasSequenceSource.class);
147 List<DbSourceProxy> selsources = new ArrayList<DbSourceProxy>();
148 Vector dasselsrc = (af.featureSettings != null) ? af.featureSettings
149 .getSelectedSources() : new jalview.gui.DasSourceBrowser()
150 .getSelectedSources();
151 Enumeration<jalviewSourceI> en = dasselsrc.elements();
152 while (en.hasMoreElements())
154 jalviewSourceI src = en.nextElement();
155 List<DbSourceProxy> sp = src.getSequenceSourceProxies();
158 selsources.addAll(sp);
161 Cache.log.debug("Added many Db Sources for :" + src.getTitle());
165 // select appropriate databases based on alignFrame context.
166 if (af.getViewport().getAlignment().isNucleotide())
168 defdb = DBRefSource.DNACODINGDBS;
172 defdb = DBRefSource.PROTEINDBS;
174 List<DbSourceProxy> srces = new ArrayList<DbSourceProxy>();
175 for (String ddb : defdb)
177 List<DbSourceProxy> srcesfordb = sfetcher.getSourceProxy(ddb);
178 if (srcesfordb != null)
180 srces.addAll(srcesfordb);
184 // append the selected sequence sources to the default dbs
185 srces.addAll(selsources);
186 dbSources = srces.toArray(new DbSourceProxy[0]);
190 // we assume the caller knows what they're doing and ensured that all the
191 // db source names are valid
197 * retrieve all the das sequence sources and add them to the list of db
198 * sources to retrieve from
200 public void appendAllDasSources()
202 if (dbSources == null)
204 dbSources = new DbSourceProxy[0];
206 // append additional sources
207 DbSourceProxy[] otherdb = sfetcher
208 .getDbSourceProxyInstances(jalview.ws.dbsources.das.datamodel.DasSequenceSource.class);
209 if (otherdb != null && otherdb.length > 0)
211 DbSourceProxy[] newsrc = new DbSourceProxy[dbSources.length
213 System.arraycopy(dbSources, 0, newsrc, 0, dbSources.length);
214 System.arraycopy(otherdb, 0, newsrc, dbSources.length, otherdb.length);
220 * start the fetcher thread
222 * @param waitTillFinished
223 * true to block until the fetcher has finished
225 public void fetchDBRefs(boolean waitTillFinished)
227 Thread thread = new Thread(this);
231 if (waitTillFinished)
238 } catch (Exception ex)
246 * The sequence will be added to a vector of sequences belonging to key which
247 * could be either seq name or dbref id
254 void addSeqId(SequenceI seq, String key)
256 key = key.toUpperCase();
259 if (seqRefs.containsKey(key))
261 seqs = (Vector) seqRefs.get(key);
263 if (seqs != null && !seqs.contains(seq))
265 seqs.addElement(seq);
267 else if (seqs == null)
270 seqs.addElement(seq);
277 seqs.addElement(seq);
280 seqRefs.put(key, seqs);
289 if (dbSources == null)
293 .getString("error.implementation_error_must_init_dbsources"));
296 long startTime = System.currentTimeMillis();
297 af.setProgressBar(MessageManager.getString("status.fetching_db_refs"),
301 if (Cache.getDefault("DBREFFETCH_USEPICR", false))
303 picrClient = new uk.ac.ebi.www.picr.AccessionMappingService.AccessionMapperServiceLocator()
304 .getAccessionMapperPort();
306 } catch (Exception e)
308 System.err.println("Couldn't locate PICR service instance.\n");
312 Vector sdataset = new Vector();
313 for (int s = 0; s < dataset.length; s++)
315 sdataset.addElement(dataset[s]);
317 while (sdataset.size() > 0 && db < dbSources.length)
319 int maxqlen = 1; // default number of queries made to at one time
320 System.err.println("Verifying against " + dbSources[db].getDbName());
323 // iterate through db for each remaining un-verified sequence
324 SequenceI[] currSeqs = new SequenceI[sdataset.size()];
325 sdataset.copyInto(currSeqs);// seqs that are to be validated against
327 Vector queries = new Vector(); // generated queries curSeq
328 seqRefs = new Hashtable();
332 jalview.ws.seqfetcher.DbSourceProxy dbsource = dbSources[db];
334 // for moment, we dumbly iterate over all retrieval sources for a
335 // particular database
336 // TODO: introduce multithread multisource queries and logic to remove a
337 // query from other sources if any source for a database returns a
339 maxqlen = dbsource.getMaximumQueryCount();
341 while (queries.size() > 0 || seqIndex < currSeqs.length)
343 if (queries.size() > 0)
345 // Still queries to make for current seqIndex
346 StringBuffer queryString = new StringBuffer("");
347 int numq = 0, nqSize = (maxqlen > queries.size()) ? queries
350 while (queries.size() > 0 && numq < nqSize)
352 String query = (String) queries.elementAt(0);
353 if (dbsource.isValidReference(query))
355 queryString.append((numq == 0) ? "" : dbsource
356 .getAccessionSeparator());
357 queryString.append(query);
360 // remove the extracted query string
361 queries.removeElementAt(0);
363 // make the queries and process the response
364 AlignmentI retrieved = null;
367 if (jalview.bin.Cache.log.isDebugEnabled())
369 jalview.bin.Cache.log.debug("Querying "
370 + dbsource.getDbName() + " with : '"
371 + queryString.toString() + "'");
373 retrieved = dbsource.getSequenceRecords(queryString
375 } catch (Exception ex)
377 ex.printStackTrace();
378 } catch (OutOfMemoryError err)
380 new OOMWarning("retrieving database references ("
381 + queryString.toString() + ")", err);
383 if (retrieved != null)
385 transferReferences(sdataset, dbsource.getDbSource(),
386 retrieved, trimDsSeqs);
391 // make some more strings for use as queries
392 for (int i = 0; (seqIndex < dataset.length) && (i < 50); seqIndex++, i++)
394 SequenceI sequence = dataset[seqIndex];
395 DBRefEntry[] uprefs = jalview.util.DBRefUtils.selectRefs(
397 new String[] { dbsource.getDbSource() }); // jalview.datamodel.DBRefSource.UNIPROT
399 // check for existing dbrefs to use
400 if (uprefs != null && uprefs.length > 0)
402 for (int j = 0; j < uprefs.length; j++)
404 addSeqId(sequence, uprefs[j].getAccessionId());
405 queries.addElement(uprefs[j].getAccessionId()
411 // generate queries from sequence ID string
412 StringTokenizer st = new StringTokenizer(
413 sequence.getName(), "|");
414 while (st.hasMoreTokens())
416 String token = st.nextToken();
417 UPEntry[] presp = null;
418 if (picrClient != null)
420 // resolve the string against PICR to recover valid IDs
423 presp = picrClient.getUPIForAccession(token, null,
424 picrClient.getMappedDatabaseNames(), null,
426 } catch (Exception e)
428 System.err.println("Exception with Picr for '"
433 if (presp != null && presp.length > 0)
435 for (int id = 0; id < presp.length; id++)
437 // construct sequences from response if sequences are
438 // present, and do a transferReferences
439 // otherwise transfer non sequence x-references directly.
442 .println("Validated ID against PICR... (for what its worth):"
444 addSeqId(sequence, token);
445 queries.addElement(token.toUpperCase());
450 // System.out.println("Not querying source with token="+token+"\n");
451 addSeqId(sequence, token);
452 queries.addElement(token.toUpperCase());
460 // advance to next database
462 } // all databases have been queries.
463 if (sbuffer.length() > 0)
465 output.setText(MessageManager
466 .getString("label.your_sequences_have_been_verified")
467 + sbuffer.toString());
468 Desktop.addInternalFrame(output,
469 MessageManager.getString("label.sequence_names_updated"),
471 // The above is the dataset, we must now find out the index
472 // of the viewed sequence
477 MessageManager.getString("label.dbref_search_completed"),
479 // promptBeforeBlast();
486 * Verify local sequences in seqRefs against the retrieved sequence database
489 * @param trimDatasetSeqs
492 void transferReferences(Vector sdataset, String dbSource,
493 AlignmentI retrievedAl, boolean trimDatasetSeqs) // File
496 System.out.println("trimming ? " + trimDatasetSeqs);
497 if (retrievedAl == null || retrievedAl.getHeight() == 0)
501 SequenceI[] retrieved = recoverDbSequences(retrievedAl
502 .getSequencesArray());
503 SequenceI sequence = null;
504 boolean transferred = false;
505 StringBuffer messages = new StringBuffer();
507 // Vector entries = new Uniprot().getUniprotEntries(file);
509 int i, iSize = retrieved.length; // entries == null ? 0 : entries.size();
510 // UniprotEntry entry;
511 for (i = 0; i < iSize; i++)
513 SequenceI entry = retrieved[i]; // (UniprotEntry) entries.elementAt(i);
515 // Work out which sequences this sequence matches,
516 // taking into account all accessionIds and names in the file
517 Vector sequenceMatches = new Vector();
518 // look for corresponding accession ids
519 DBRefEntry[] entryRefs = jalview.util.DBRefUtils.selectRefs(
520 entry.getDBRef(), new String[] { dbSource });
521 if (entryRefs == null)
524 .println("Dud dbSource string ? no entryrefs selected for "
525 + dbSource + " on " + entry.getName());
528 for (int j = 0; j < entryRefs.length; j++)
530 String accessionId = entryRefs[j].getAccessionId(); // .getAccession().elementAt(j).toString();
531 // match up on accessionId
532 if (seqRefs.containsKey(accessionId.toUpperCase()))
534 Vector seqs = (Vector) seqRefs.get(accessionId);
535 for (int jj = 0; jj < seqs.size(); jj++)
537 sequence = (SequenceI) seqs.elementAt(jj);
538 if (!sequenceMatches.contains(sequence))
540 sequenceMatches.addElement(sequence);
545 if (sequenceMatches.size() == 0)
547 // failed to match directly on accessionId==query so just compare all
548 // sequences to entry
549 Enumeration e = seqRefs.keys();
550 while (e.hasMoreElements())
552 Vector sqs = (Vector) seqRefs.get(e.nextElement());
553 if (sqs != null && sqs.size() > 0)
555 Enumeration sqe = sqs.elements();
556 while (sqe.hasMoreElements())
558 sequenceMatches.addElement(sqe.nextElement());
563 // look for corresponding names
564 // this is uniprot specific ?
565 // could be useful to extend this so we try to find any 'significant'
566 // information in common between two sequence objects.
568 * DBRefEntry[] entryRefs =
569 * jalview.util.DBRefUtils.selectRefs(entry.getDBRef(), new String[] {
570 * dbSource }); for (int j = 0; j < entry.getName().size(); j++) { String
571 * name = entry.getName().elementAt(j).toString(); if
572 * (seqRefs.containsKey(name)) { Vector seqs = (Vector) seqRefs.get(name);
573 * for (int jj = 0; jj < seqs.size(); jj++) { sequence = (SequenceI)
574 * seqs.elementAt(jj); if (!sequenceMatches.contains(sequence)) {
575 * sequenceMatches.addElement(sequence); } } } }
577 // sequenceMatches now contains the set of all sequences associated with
578 // the returned db record
579 String entrySeq = entry.getSequenceAsString().toUpperCase();
580 for (int m = 0; m < sequenceMatches.size(); m++)
582 sequence = (SequenceI) sequenceMatches.elementAt(m);
583 // only update start and end positions and shift features if there are
584 // no existing references
585 // TODO: test for legacy where uniprot or EMBL refs exist but no
586 // mappings are made (but content matches retrieved set)
587 boolean updateRefFrame = sequence.getDBRef() == null
588 || sequence.getDBRef().length == 0;
590 // verify sequence against the entry sequence
592 String nonGapped = AlignSeq.extractGaps("-. ",
593 sequence.getSequenceAsString()).toUpperCase();
595 int absStart = entrySeq.indexOf(nonGapped);
598 final int sequenceStart = sequence.getStart();
601 // Is local sequence contained in dataset sequence?
602 absStart = nonGapped.indexOf(entrySeq);
604 { // verification failed.
605 messages.append(sequence.getName()
606 + " SEQUENCE NOT %100 MATCH \n");
610 sbuffer.append(sequence.getName() + " HAS " + absStart
611 + " PREFIXED RESIDUES COMPARED TO " + dbSource + "\n");
613 // + " - ANY SEQUENCE FEATURES"
614 // + " HAVE BEEN ADJUSTED ACCORDINGLY \n");
616 // create valid mapping between matching region of local sequence and
617 // the mapped sequence
618 mp = new Mapping(null, new int[] { sequenceStart + absStart,
619 sequenceStart + absStart + entrySeq.length() - 1 }, new int[]
620 { entry.getStart(), entry.getStart() + entrySeq.length() - 1 },
622 updateRefFrame = false; // mapping is based on current start/end so
623 // don't modify start and end
628 // update start and end of local sequence to place it in entry's
630 // apply identity map map from whole of local sequence to matching
631 // region of database
633 mp = null; // Mapping.getIdentityMap();
635 // new int[] { absStart+sequence.getStart(),
636 // absStart+sequence.getStart()+entrySeq.length()-1},
637 // new int[] { entry.getStart(), entry.getEnd() }, 1, 1);
638 // relocate local features for updated start
641 if (sequence.getSequenceFeatures() != null)
643 SequenceFeature[] sf = sequence.getSequenceFeatures();
644 int start = sequenceStart;
645 int end = sequence.getEnd();
646 int startShift = 1 - absStart - start; // how much the features
649 for (int sfi = 0; sfi < sf.length; sfi++)
651 if (sf[sfi].getBegin() >= start && sf[sfi].getEnd() <= end)
653 // shift feature along by absstart
654 sf[sfi].setBegin(sf[sfi].getBegin() + startShift);
655 sf[sfi].setEnd(sf[sfi].getEnd() + startShift);
662 System.out.println("Adding dbrefs to " + sequence.getName()
663 + " from " + dbSource + " sequence : " + entry.getName());
664 sequence.transferAnnotation(entry, mp);
665 // unknownSequences.remove(sequence);
666 absStart += entry.getStart();
667 int absEnd = absStart + nonGapped.length() - 1;
668 if (!trimDatasetSeqs)
670 // insert full length sequence from record
671 sequence.setSequence(entry.getSequenceAsString());
672 sequence.setStart(entry.getStart());
676 // finally, update local sequence reference frame if we're allowed
679 // just fix start/end
680 sequence.setStart(absStart);
681 sequence.setEnd(absEnd);
683 // search for alignment sequences to update coordinate frame for
684 for (int alsq = 0; alsq < alseqs.length; alsq++)
686 if (alseqs[alsq].getDatasetSequence() == sequence)
688 String ngAlsq = AlignSeq.extractGaps("-. ",
689 alseqs[alsq].getSequenceAsString()).toUpperCase();
690 int oldstrt = alseqs[alsq].getStart();
691 alseqs[alsq].setStart(sequence.getSequenceAsString()
692 .toUpperCase().indexOf(ngAlsq)
693 + sequence.getStart());
694 if (oldstrt != alseqs[alsq].getStart())
696 alseqs[alsq].setEnd(ngAlsq.length()
697 + alseqs[alsq].getStart() - 1);
701 // TODO: search for all other references to this dataset sequence, and
703 // TODO: update all AlCodonMappings which involve this alignment
704 // sequence (e.g. Q30167 cdna translation from exon2 product (vamsas
707 // and remove it from the rest
708 // TODO: decide if we should remove annotated sequence from set
709 sdataset.remove(sequence);
710 // TODO: should we make a note of sequences that have received new DB
711 // ids, so we can query all enabled DAS servers for them ?
716 // report the ID/sequence mismatches
717 sbuffer.append(messages);
722 * loop thru and collect additional sequences in Map.
724 * @param sequencesArray
727 private SequenceI[] recoverDbSequences(SequenceI[] sequencesArray)
729 Vector nseq = new Vector();
730 for (int i = 0; sequencesArray != null && i < sequencesArray.length; i++)
732 nseq.addElement(sequencesArray[i]);
733 DBRefEntry dbr[] = sequencesArray[i].getDBRef();
734 jalview.datamodel.Mapping map = null;
735 for (int r = 0; (dbr != null) && r < dbr.length; r++)
737 if ((map = dbr[r].getMap()) != null)
739 if (map.getTo() != null && !nseq.contains(map.getTo()))
741 nseq.addElement(map.getTo());
748 sequencesArray = new SequenceI[nseq.size()];
749 nseq.toArray(sequencesArray);
751 return sequencesArray;