src/jalview/ws/DBRefFetcher.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21 package jalview.ws;
  22
  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.CutAndPasteTransfer;
  32 import jalview.gui.DasSourceBrowser;
  33 import jalview.gui.Desktop;
  34 import jalview.gui.FeatureSettings;
  35 import jalview.gui.IProgressIndicator;
  36 import jalview.gui.OOMWarning;
  37 import jalview.util.DBRefUtils;
  38 import jalview.util.MessageManager;
  39 import jalview.ws.dbsources.das.api.jalviewSourceI;
  40 import jalview.ws.dbsources.das.datamodel.DasSequenceSource;
  41 import jalview.ws.seqfetcher.DbSourceProxy;
  42
  43 import java.util.ArrayList;
  44 import java.util.Arrays;
  45 import java.util.Enumeration;
  46 import java.util.Hashtable;
  47 import java.util.List;
  48 import java.util.StringTokenizer;
  49 import java.util.Vector;
  50
  51 import uk.ac.ebi.picr.model.UPEntry;
  52 import uk.ac.ebi.www.picr.AccessionMappingService.AccessionMapperServiceLocator;
  53
  54 /**
  55  * Implements a runnable for validating a sequence against external databases
  56  * and then propagating references and features onto the sequence(s)
  57  *
  58  * @author $author$
  59  * @version $Revision$
  60  */
  61 public class DBRefFetcher implements Runnable
  62 {
  63   private static final String NEWLINE = System.lineSeparator();
  64
  65   public interface FetchFinishedListenerI
  66   {
  67     void finished();
  68   }
  69
  70   SequenceI[] dataset;
  71
  72   IProgressIndicator progressWindow;
  73
  74   CutAndPasteTransfer output = new CutAndPasteTransfer();
  75
  76   boolean running = false;
  77
  78   /**
  79    * picr client instance
  80    */
  81   uk.ac.ebi.www.picr.AccessionMappingService.AccessionMapperInterface picrClient = null;
  82
  83   // This will be a collection of Vectors of sequenceI refs.
  84   // The key will be the seq name or accession id of the seq
  85   Hashtable<String, Vector<SequenceI>> seqRefs;
  86
  87   DbSourceProxy[] dbSources;
  88
  89   SequenceFetcher sfetcher;
  90
  91   private List<FetchFinishedListenerI> listeners;
  92
  93   private SequenceI[] alseqs;
  94
  95   /*
  96    * when true - retrieved sequences will be trimmed to cover longest derived
  97    * alignment sequence
  98    */
  99   private boolean trimDsSeqs = true;
 100
 101   /**
 102    * Creates a new DBRefFetcher object and fetches from the currently selected
 103    * set of databases, if this is null then it fetches based on feature settings
 104    *
 105    * @param seqs
 106    *          fetch references for these SequenceI array
 107    * @param progressIndicatorFrame
 108    *          the frame for progress bar monitoring
 109    * @param sources
 110    *          array of DbSourceProxy to query references form
 111    * @param featureSettings
 112    *          FeatureSettings to get alternative DbSourceProxy from
 113    * @param isNucleotide
 114    *          indicates if the array of SequenceI are Nucleotides or not
 115    */
 116   public DBRefFetcher(SequenceI[] seqs,
 117           IProgressIndicator progressIndicatorFrame,
 118           DbSourceProxy[] sources, FeatureSettings featureSettings, boolean isNucleotide)
 119   {
 120     listeners = new ArrayList<FetchFinishedListenerI>();
 121     this.progressWindow = progressIndicatorFrame;
 122     alseqs = new SequenceI[seqs.length];
 123     SequenceI[] ds = new SequenceI[seqs.length];
 124     for (int i = 0; i < seqs.length; i++)
 125     {
 126       alseqs[i] = seqs[i];
 127       if (seqs[i].getDatasetSequence() != null)
 128       {
 129         ds[i] = seqs[i].getDatasetSequence();
 130       }
 131       else
 132       {
 133         ds[i] = seqs[i];
 134       }
 135     }
 136     this.dataset = ds;
 137     // TODO Jalview 2.5 lots of this code should be in the gui package!
 138     sfetcher = jalview.gui.SequenceFetcher
 139             .getSequenceFetcherSingleton(progressIndicatorFrame);
 140     // set default behaviour for transferring excess sequence data to the
 141     // dataset
 142     trimDsSeqs = Cache.getDefault("TRIM_FETCHED_DATASET_SEQS", true);
 143     if (sources == null)
 144     {
 145       setDatabaseSources(featureSettings, isNucleotide);
 146     }
 147     else
 148     {
 149       // we assume the caller knows what they're doing and ensured that all the
 150       // db source names are valid
 151       dbSources = sources;
 152     }
 153   }
 154
 155   /**
 156    * Helper method to configure the list of database sources to query
 157    *
 158    * @param featureSettings
 159    * @param forNucleotide
 160    */
 161   void setDatabaseSources(FeatureSettings featureSettings,
 162           boolean forNucleotide)
 163   {
 164     // af.featureSettings_actionPerformed(null);
 165     String[] defdb = null;
 166     List<DbSourceProxy> selsources = new ArrayList<DbSourceProxy>();
 167     Vector<jalviewSourceI> dasselsrc = (featureSettings != null) ? featureSettings
 168             .getSelectedSources() : new DasSourceBrowser()
 169             .getSelectedSources();
 170
 171     for (jalviewSourceI src : dasselsrc)
 172     {
 173       List<DbSourceProxy> sp = src.getSequenceSourceProxies();
 174       if (sp != null)
 175       {
 176         selsources.addAll(sp);
 177         if (sp.size() > 1)
 178         {
 179           Cache.log.debug("Added many Db Sources for :" + src.getTitle());
 180         }
 181       }
 182     }
 183     // select appropriate databases based on alignFrame context.
 184     if (forNucleotide)
 185     {
 186       defdb = DBRefSource.DNACODINGDBS;
 187     }
 188     else
 189     {
 190       defdb = DBRefSource.PROTEINDBS;
 191     }
 192     List<DbSourceProxy> srces = new ArrayList<DbSourceProxy>();
 193     for (String ddb : defdb)
 194     {
 195       List<DbSourceProxy> srcesfordb = sfetcher.getSourceProxy(ddb);
 196       if (srcesfordb != null)
 197       {
 198         for (DbSourceProxy src : srcesfordb)
 199         {
 200           if (!srces.contains(src))
 201           {
 202             srces.addAll(srcesfordb);
 203           }
 204         }
 205       }
 206     }
 207     // append the PDB data source, since it is 'special', catering for both
 208     // nucleotide and protein
 209     // srces.addAll(sfetcher.getSourceProxy(DBRefSource.PDB));
 210
 211     srces.addAll(selsources);
 212     dbSources = srces.toArray(new DbSourceProxy[srces.size()]);
 213   }
 214
 215   /**
 216    * Constructor with only sequences provided
 217    *
 218    * @param sequences
 219    */
 220   public DBRefFetcher(SequenceI[] sequences)
 221   {
 222     this(sequences, null, null, null, false);
 223   }
 224
 225   /**
 226    * Add a listener to be notified when sequence fetching is complete
 227    *
 228    * @param l
 229    */
 230   public void addListener(FetchFinishedListenerI l)
 231   {
 232     listeners.add(l);
 233   }
 234
 235   /**
 236    * retrieve all the das sequence sources and add them to the list of db
 237    * sources to retrieve from
 238    */
 239   public void appendAllDasSources()
 240   {
 241     if (dbSources == null)
 242     {
 243       dbSources = new DbSourceProxy[0];
 244     }
 245     // append additional sources
 246     DbSourceProxy[] otherdb = sfetcher
 247             .getDbSourceProxyInstances(DasSequenceSource.class);
 248     if (otherdb != null && otherdb.length > 0)
 249     {
 250       DbSourceProxy[] newsrc = new DbSourceProxy[dbSources.length
 251               + otherdb.length];
 252       System.arraycopy(dbSources, 0, newsrc, 0, dbSources.length);
 253       System.arraycopy(otherdb, 0, newsrc, dbSources.length, otherdb.length);
 254       dbSources = newsrc;
 255     }
 256   }
 257
 258   /**
 259    * start the fetcher thread
 260    *
 261    * @param waitTillFinished
 262    *          true to block until the fetcher has finished
 263    */
 264   public void fetchDBRefs(boolean waitTillFinished)
 265   {
 266     // TODO can we not simply write
 267     // if (waitTillFinished) { run(); } else { new Thread(this).start(); }
 268
 269     Thread thread = new Thread(this);
 270     thread.start();
 271     running = true;
 272
 273     if (waitTillFinished)
 274     {
 275       while (running)
 276       {
 277         try
 278         {
 279           Thread.sleep(500);
 280         } catch (Exception ex)
 281         {
 282         }
 283       }
 284     }
 285   }
 286
 287   /**
 288    * The sequence will be added to a vector of sequences belonging to key which
 289    * could be either seq name or dbref id
 290    *
 291    * @param seq
 292    *          SequenceI
 293    * @param key
 294    *          String
 295    */
 296   void addSeqId(SequenceI seq, String key)
 297   {
 298     key = key.toUpperCase();
 299
 300     Vector<SequenceI> seqs;
 301     if (seqRefs.containsKey(key))
 302     {
 303       seqs = seqRefs.get(key);
 304
 305       if (seqs != null && !seqs.contains(seq))
 306       {
 307         seqs.addElement(seq);
 308       }
 309       else if (seqs == null)
 310       {
 311         seqs = new Vector<SequenceI>();
 312         seqs.addElement(seq);
 313       }
 314
 315     }
 316     else
 317     {
 318       seqs = new Vector<SequenceI>();
 319       seqs.addElement(seq);
 320     }
 321
 322     seqRefs.put(key, seqs);
 323   }
 324
 325   /**
 326    * DOCUMENT ME!
 327    */
 328   @Override
 329   public void run()
 330   {
 331     if (dbSources == null)
 332     {
 333       throw new Error(
 334               MessageManager
 335                       .getString("error.implementation_error_must_init_dbsources"));
 336     }
 337     running = true;
 338     long startTime = System.currentTimeMillis();
 339     if (progressWindow != null)
 340     {
 341       progressWindow.setProgressBar(
 342               MessageManager.getString("status.fetching_db_refs"),
 343             startTime);
 344     }
 345     try
 346     {
 347       if (Cache.getDefault("DBREFFETCH_USEPICR", false))
 348       {
 349         picrClient = new AccessionMapperServiceLocator()
 350                 .getAccessionMapperPort();
 351       }
 352     } catch (Exception e)
 353     {
 354       System.err.println("Couldn't locate PICR service instance.\n");
 355       e.printStackTrace();
 356     }
 357
 358     Vector<SequenceI> sdataset = new Vector<SequenceI>(
 359             Arrays.asList(dataset));
 360     List<String> warningMessages = new ArrayList<String>();
 361
 362     int db = 0;
 363     while (sdataset.size() > 0 && db < dbSources.length)
 364     {
 365       int maxqlen = 1; // default number of queries made at one time
 366       System.out.println("Verifying against " + dbSources[db].getDbName());
 367
 368       // iterate through db for each remaining un-verified sequence
 369       SequenceI[] currSeqs = new SequenceI[sdataset.size()];
 370       sdataset.copyInto(currSeqs);// seqs that are to be validated against
 371       // dbSources[db]
 372       Vector<String> queries = new Vector<String>(); // generated queries curSeq
 373       seqRefs = new Hashtable<String, Vector<SequenceI>>();
 374
 375       int seqIndex = 0;
 376
 377       DbSourceProxy dbsource = dbSources[db];
 378       // for moment, we dumbly iterate over all retrieval sources for a
 379       // particular database
 380       // TODO: introduce multithread multisource queries and logic to remove a
 381       // query from other sources if any source for a database returns a
 382       // record
 383       maxqlen = dbsource.getMaximumQueryCount();
 384
 385       while (queries.size() > 0 || seqIndex < currSeqs.length)
 386       {
 387         if (queries.size() > 0)
 388         {
 389           // Still queries to make for current seqIndex
 390           StringBuffer queryString = new StringBuffer("");
 391           int numq = 0;
 392           int nqSize = (maxqlen > queries.size()) ? queries
 393                   .size() : maxqlen;
 394
 395           while (queries.size() > 0 && numq < nqSize)
 396           {
 397             String query = queries.elementAt(0);
 398             if (dbsource.isValidReference(query))
 399             {
 400               queryString.append((numq == 0) ? "" : dbsource
 401                       .getAccessionSeparator());
 402               queryString.append(query);
 403               numq++;
 404             }
 405             // remove the extracted query string
 406             queries.removeElementAt(0);
 407           }
 408           // make the queries and process the response
 409           AlignmentI retrieved = null;
 410           try
 411           {
 412             if (Cache.log.isDebugEnabled())
 413             {
 414               Cache.log.debug("Querying " + dbsource.getDbName()
 415                       + " with : '" + queryString.toString() + "'");
 416             }
 417             retrieved = dbsource.getSequenceRecords(queryString.toString());
 418           } catch (Exception ex)
 419           {
 420             ex.printStackTrace();
 421           } catch (OutOfMemoryError err)
 422           {
 423             new OOMWarning("retrieving database references ("
 424                     + queryString.toString() + ")", err);
 425           }
 426           if (retrieved != null)
 427           {
 428             transferReferences(sdataset, dbsource.getDbSource(), retrieved,
 429                     trimDsSeqs, warningMessages);
 430           }
 431         }
 432         else
 433         {
 434           // make some more strings for use as queries
 435           for (int i = 0; (seqIndex < dataset.length) && (i < 50); seqIndex++, i++)
 436           {
 437             SequenceI sequence = dataset[seqIndex];
 438             DBRefEntry[] uprefs = DBRefUtils.selectRefs(
 439                     sequence.getDBRefs(),
 440                     new String[] { dbsource.getDbSource() }); // jalview.datamodel.DBRefSource.UNIPROT
 441             // });
 442             // check for existing dbrefs to use
 443             if (uprefs != null && uprefs.length > 0)
 444             {
 445               for (int j = 0; j < uprefs.length; j++)
 446               {
 447                 addSeqId(sequence, uprefs[j].getAccessionId());
 448                 queries.addElement(uprefs[j].getAccessionId().toUpperCase());
 449               }
 450             }
 451             else
 452             {
 453               // generate queries from sequence ID string
 454               StringTokenizer st = new StringTokenizer(sequence.getName(),
 455                       "|");
 456               while (st.hasMoreTokens())
 457               {
 458                 String token = st.nextToken();
 459                 UPEntry[] presp = null;
 460                 if (picrClient != null)
 461                 {
 462                   // resolve the string against PICR to recover valid IDs
 463                   try
 464                   {
 465                     presp = picrClient
 466                             .getUPIForAccession(token, null,
 467                                     picrClient.getMappedDatabaseNames(),
 468                                     null, true);
 469                   } catch (Exception e)
 470                   {
 471                     System.err.println("Exception with Picr for '" + token
 472                             + "'\n");
 473                     e.printStackTrace();
 474                   }
 475                 }
 476                 if (presp != null && presp.length > 0)
 477                 {
 478                   for (int id = 0; id < presp.length; id++)
 479                   {
 480                     // construct sequences from response if sequences are
 481                     // present, and do a transferReferences
 482                     // otherwise transfer non sequence x-references directly.
 483                   }
 484                   System.out
 485                           .println("Validated ID against PICR... (for what its worth):"
 486                                   + token);
 487                   addSeqId(sequence, token);
 488                   queries.addElement(token.toUpperCase());
 489                 }
 490                 else
 491                 {
 492                   // if ()
 493                   // System.out.println("Not querying source with token="+token+"\n");
 494                   addSeqId(sequence, token);
 495                   queries.addElement(token.toUpperCase());
 496                 }
 497               }
 498             }
 499           }
 500         }
 501       }
 502       // advance to next database
 503       db++;
 504     } // all databases have been queried
 505     if (!warningMessages.isEmpty())
 506     {
 507       StringBuilder sb = new StringBuilder(warningMessages.size() * 30);
 508       sb.append(MessageManager
 509               .getString("label.your_sequences_have_been_verified"));
 510       for (String msg : warningMessages)
 511       {
 512         sb.append(msg).append(NEWLINE);
 513       }
 514       output.setText(sb.toString());
 515
 516       Desktop.addInternalFrame(output,
 517               MessageManager.getString("label.sequences_updated"),
 518               600, 300);
 519       // The above is the dataset, we must now find out the index
 520       // of the viewed sequence
 521
 522     }
 523     if (progressWindow != null)
 524     {
 525       progressWindow.setProgressBar(
 526               MessageManager.getString("label.dbref_search_completed"),
 527               startTime);
 528     }
 529
 530     for (FetchFinishedListenerI listener : listeners)
 531     {
 532       listener.finished();
 533     }
 534     running = false;
 535   }
 536
 537   /**
 538    * Verify local sequences in seqRefs against the retrieved sequence database
 539    * records. Returns true if any sequence was modified as a result (start/end
 540    * changed and/or sequence enlarged), else false.
 541    *
 542    * @param sdataset
 543    *          dataset sequences we are retrieving for
 544    * @param dbSource
 545    *          database source we are retrieving from
 546    * @param retrievedAl
 547    *          retrieved sequences as alignment
 548    * @param trimDatasetSeqs
 549    *          if true, sequences will not be enlarged to match longer retrieved
 550    *          sequences, only their start/end adjusted
 551    * @param warningMessages
 552    *          a list of messages to add to
 553    */
 554   boolean transferReferences(Vector<SequenceI> sdataset,
 555           String dbSource,
 556           AlignmentI retrievedAl, boolean trimDatasetSeqs,
 557           List<String> warningMessages)
 558   {
 559     // System.out.println("trimming ? " + trimDatasetSeqs);
 560     if (retrievedAl == null || retrievedAl.getHeight() == 0)
 561     {
 562       return false;
 563     }
 564
 565     boolean modified = false;
 566     SequenceI[] retrieved = recoverDbSequences(retrievedAl
 567             .getSequencesArray());
 568     SequenceI sequence = null;
 569
 570     for (SequenceI retrievedSeq : retrieved)
 571     {
 572       // Work out which sequences this sequence matches,
 573       // taking into account all accessionIds and names in the file
 574       Vector<SequenceI> sequenceMatches = new Vector<SequenceI>();
 575       // look for corresponding accession ids
 576       DBRefEntry[] entryRefs = DBRefUtils.selectRefs(retrievedSeq.getDBRefs(),
 577               new String[] { dbSource });
 578       if (entryRefs == null)
 579       {
 580         System.err
 581                 .println("Dud dbSource string ? no entryrefs selected for "
 582                         + dbSource + " on " + retrievedSeq.getName());
 583         continue;
 584       }
 585       for (int j = 0; j < entryRefs.length; j++)
 586       {
 587         String accessionId = entryRefs[j].getAccessionId();
 588         // match up on accessionId
 589         if (seqRefs.containsKey(accessionId.toUpperCase()))
 590         {
 591           Vector<SequenceI> seqs = seqRefs.get(accessionId);
 592           for (int jj = 0; jj < seqs.size(); jj++)
 593           {
 594             sequence = seqs.elementAt(jj);
 595             if (!sequenceMatches.contains(sequence))
 596             {
 597               sequenceMatches.addElement(sequence);
 598             }
 599           }
 600         }
 601       }
 602       if (sequenceMatches.isEmpty())
 603       {
 604         // failed to match directly on accessionId==query so just compare all
 605         // sequences to entry
 606         Enumeration<String> e = seqRefs.keys();
 607         while (e.hasMoreElements())
 608         {
 609           Vector<SequenceI> sqs = seqRefs.get(e.nextElement());
 610           if (sqs != null && sqs.size() > 0)
 611           {
 612             Enumeration<SequenceI> sqe = sqs.elements();
 613             while (sqe.hasMoreElements())
 614             {
 615               sequenceMatches.addElement(sqe.nextElement());
 616             }
 617           }
 618         }
 619       }
 620       // look for corresponding names
 621       // this is uniprot specific ?
 622       // could be useful to extend this so we try to find any 'significant'
 623       // information in common between two sequence objects.
 624       /*
 625        * DBRefEntry[] entryRefs =
 626        * jalview.util.DBRefUtils.selectRefs(entry.getDBRef(), new String[] {
 627        * dbSource }); for (int j = 0; j < entry.getName().size(); j++) { String
 628        * name = entry.getName().elementAt(j).toString(); if
 629        * (seqRefs.containsKey(name)) { Vector seqs = (Vector) seqRefs.get(name);
 630        * for (int jj = 0; jj < seqs.size(); jj++) { sequence = (SequenceI)
 631        * seqs.elementAt(jj); if (!sequenceMatches.contains(sequence)) {
 632        * sequenceMatches.addElement(sequence); } } } }
 633        */
 634       // sequenceMatches now contains the set of all sequences associated with
 635       // the returned db record
 636       final String retrievedSeqString = retrievedSeq.getSequenceAsString();
 637       String entrySeq = retrievedSeqString.toUpperCase();
 638       for (int m = 0; m < sequenceMatches.size(); m++)
 639       {
 640         sequence = sequenceMatches.elementAt(m);
 641         // only update start and end positions and shift features if there are
 642         // no existing references
 643         // TODO: test for legacy where uniprot or EMBL refs exist but no
 644         // mappings are made (but content matches retrieved set)
 645         boolean updateRefFrame = sequence.getDBRefs() == null
 646                 || sequence.getDBRefs().length == 0;
 647         // TODO:
 648         // verify sequence against the entry sequence
 649
 650         Mapping mp;
 651         final int sequenceStart = sequence.getStart();
 652
 653         boolean remoteEnclosesLocal = false;
 654         String nonGapped = AlignSeq.extractGaps("-. ",
 655                 sequence.getSequenceAsString()).toUpperCase();
 656         int absStart = entrySeq.indexOf(nonGapped);
 657         if (absStart == -1)
 658         {
 659           // couldn't find local sequence in sequence from database, so check if
 660           // the database sequence is a subsequence of local sequence
 661           absStart = nonGapped.indexOf(entrySeq);
 662           if (absStart == -1)
 663           {
 664             // verification failed. couldn't find any relationship between
 665             // entrySeq and local sequence
 666             // messages suppressed as many-to-many matches are confusing
 667             // String msg = sequence.getName()
 668             // + " Sequence not 100% match with "
 669             // + retrievedSeq.getName();
 670             // addWarningMessage(warningMessages, msg);
 671             continue;
 672           }
 673           /*
 674            * retrieved sequence is a proper subsequence of local sequence
 675            */
 676           String msg = sequence.getName() + " has " + absStart
 677                   + " prefixed residues compared to "
 678                   + retrievedSeq.getName();
 679           addWarningMessage(warningMessages, msg);
 680
 681           /*
 682            * So create a mapping to the external entry from the matching region of
 683            * the local sequence, and leave local start/end untouched.
 684            */
 685           mp = new Mapping(null, new int[] { sequenceStart + absStart,
 686               sequenceStart + absStart + entrySeq.length() - 1 }, new int[]
 687           { retrievedSeq.getStart(), retrievedSeq.getStart() + entrySeq.length() - 1 },
 688                   1, 1);
 689           updateRefFrame = false;
 690         }
 691         else
 692         {
 693           /*
 694            * local sequence is a subsequence of (or matches) retrieved sequence
 695            */
 696           remoteEnclosesLocal = true;
 697           mp = null;
 698
 699           if (updateRefFrame)
 700           {
 701             SequenceFeature[] sfs = sequence.getSequenceFeatures();
 702             if (sfs != null)
 703             {
 704               /*
 705                * relocate existing sequence features by offset
 706                */
 707               int start = sequenceStart;
 708               int end = sequence.getEnd();
 709               int startShift = 1 - absStart - start;
 710
 711               if (startShift != 0)
 712               {
 713                 for (SequenceFeature sf : sfs)
 714                 {
 715                   if (sf.getBegin() >= start && sf.getEnd() <= end)
 716                   {
 717                     sf.setBegin(sf.getBegin() + startShift);
 718                     sf.setEnd(sf.getEnd() + startShift);
 719                     modified = true;
 720                   }
 721                 }
 722               }
 723             }
 724           }
 725         }
 726
 727         System.out.println("Adding dbrefs to " + sequence.getName()
 728                 + " from " + dbSource + " sequence : " + retrievedSeq.getName());
 729         sequence.transferAnnotation(retrievedSeq, mp);
 730
 731         absStart += retrievedSeq.getStart();
 732         int absEnd = absStart + nonGapped.length() - 1;
 733         if (!trimDatasetSeqs)
 734         {
 735           /*
 736            * update start position and/or expand to longer retrieved sequence
 737            */
 738           if (!retrievedSeqString.equals(sequence.getSequenceAsString())
 739                   && remoteEnclosesLocal)
 740           {
 741             sequence.setSequence(retrievedSeqString);
 742             modified = true;
 743             addWarningMessage(warningMessages,
 744                     "Sequence for " + sequence.getName()
 745                             + " expanded from " + retrievedSeq.getName());
 746           }
 747           if (sequence.getStart() != retrievedSeq.getStart())
 748           {
 749             sequence.setStart(retrievedSeq.getStart());
 750             modified = true;
 751             if (absStart != sequenceStart)
 752             {
 753               addWarningMessage(warningMessages, "Start/end position for "
 754                       + sequence.getName() + " updated from "
 755                       + retrievedSeq.getName());
 756             }
 757           }
 758         }
 759         if (updateRefFrame)
 760         {
 761           // finally, update local sequence reference frame if we're allowed
 762           if (trimDatasetSeqs)
 763           {
 764             // just fix start/end
 765             if (sequence.getStart() != absStart
 766                     || sequence.getEnd() != absEnd)
 767             {
 768               sequence.setStart(absStart);
 769               sequence.setEnd(absEnd);
 770               modified = true;
 771               addWarningMessage(warningMessages, "Start/end for "
 772                       + sequence.getName() + " updated from "
 773                       + retrievedSeq.getName());
 774             }
 775           }
 776           // search for alignment sequences to update coordinate frame for
 777           for (int alsq = 0; alsq < alseqs.length; alsq++)
 778           {
 779             if (alseqs[alsq].getDatasetSequence() == sequence)
 780             {
 781               String ngAlsq = AlignSeq.extractGaps("-. ",
 782                       alseqs[alsq].getSequenceAsString()).toUpperCase();
 783               int oldstrt = alseqs[alsq].getStart();
 784               alseqs[alsq].setStart(sequence.getSequenceAsString()
 785                       .toUpperCase().indexOf(ngAlsq)
 786                       + sequence.getStart());
 787               if (oldstrt != alseqs[alsq].getStart())
 788               {
 789                 alseqs[alsq].setEnd(ngAlsq.length()
 790                         + alseqs[alsq].getStart() - 1);
 791                 modified = true;
 792               }
 793             }
 794           }
 795           // TODO: search for all other references to this dataset sequence, and
 796           // update start/end
 797           // TODO: update all AlCodonMappings which involve this alignment
 798           // sequence (e.g. Q30167 cdna translation from exon2 product (vamsas
 799           // demo)
 800         }
 801         // and remove it from the rest
 802         // TODO: decide if we should remove annotated sequence from set
 803         sdataset.remove(sequence);
 804         // TODO: should we make a note of sequences that have received new DB
 805         // ids, so we can query all enabled DAS servers for them ?
 806       }
 807     }
 808     return modified;
 809   }
 810
 811   /**
 812    * Adds the message to the list unless it already contains it
 813    *
 814    * @param messageList
 815    * @param msg
 816    */
 817   void addWarningMessage(List<String> messageList, String msg)
 818   {
 819     if (!messageList.contains(msg))
 820     {
 821       messageList.add(msg);
 822     }
 823   }
 824
 825   /**
 826    * loop thru and collect additional sequences in Map.
 827    *
 828    * @param sequencesArray
 829    * @return
 830    */
 831   private SequenceI[] recoverDbSequences(SequenceI[] sequencesArray)
 832   {
 833     Vector<SequenceI> nseq = new Vector<SequenceI>();
 834     for (int i = 0; sequencesArray != null && i < sequencesArray.length; i++)
 835     {
 836       nseq.addElement(sequencesArray[i]);
 837       DBRefEntry[] dbr = sequencesArray[i].getDBRefs();
 838       Mapping map = null;
 839       for (int r = 0; (dbr != null) && r < dbr.length; r++)
 840       {
 841         if ((map = dbr[r].getMap()) != null)
 842         {
 843           if (map.getTo() != null && !nseq.contains(map.getTo()))
 844           {
 845             nseq.addElement(map.getTo());
 846           }
 847         }
 848       }
 849     }
 850     if (nseq.size() > 0)
 851     {
 852       sequencesArray = new SequenceI[nseq.size()];
 853       nseq.toArray(sequencesArray);
 854     }
 855     return sequencesArray;
 856   }
 857 }