src/jalview/analysis/CrossRef.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.analysis;
  22
  23 import jalview.datamodel.AlignedCodonFrame;
  24 import jalview.datamodel.Alignment;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.DBRefEntry;
  27 import jalview.datamodel.Mapping;
  28 import jalview.datamodel.Sequence;
  29 import jalview.datamodel.SequenceFeature;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.util.DBRefUtils;
  32 import jalview.util.MapList;
  33 import jalview.ws.SequenceFetcherFactory;
  34 import jalview.ws.seqfetcher.ASequenceFetcher;
  35
  36 import java.util.ArrayList;
  37 import java.util.Iterator;
  38 import java.util.List;
  39
  40 /**
  41  * Functions for cross-referencing sequence databases.
  42  *
  43  * @author JimP
  44  *
  45  */
  46 public class CrossRef
  47 {
  48   /*
  49    * the dataset of the alignment for which we are searching for
  50    * cross-references; in some cases we may resolve xrefs by
  51    * searching in the dataset
  52    */
  53   private AlignmentI dataset;
  54
  55   /*
  56    * the sequences for which we are seeking cross-references
  57    */
  58   private SequenceI[] fromSeqs;
  59
  60   /**
  61    * matcher built from dataset
  62    */
  63   SequenceIdMatcher matcher;
  64
  65   /**
  66    * sequences found by cross-ref searches to fromSeqs
  67    */
  68   List<SequenceI> rseqs;
  69
  70   /**
  71    * Constructor
  72    *
  73    * @param seqs
  74    *          the sequences for which we are seeking cross-references
  75    * @param ds
  76    *          the containing alignment dataset (may be searched to resolve
  77    *          cross-references)
  78    */
  79   public CrossRef(SequenceI[] seqs, AlignmentI ds)
  80   {
  81     fromSeqs = seqs;
  82     dataset = ds.getDataset() == null ? ds : ds.getDataset();
  83   }
  84
  85   /**
  86    * Returns a list of distinct database sources for which sequences have either
  87    * <ul>
  88    * <li>a (dna-to-protein or protein-to-dna) cross-reference</li>
  89    * <li>an indirect cross-reference - a (dna-to-protein or protein-to-dna)
  90    * reference from another sequence in the dataset which has a cross-reference
  91    * to a direct DBRefEntry on the given sequence</li>
  92    * </ul>
  93    *
  94    * @param dna
  95    *          - when true, cross-references *from* dna returned. When false,
  96    *          cross-references *from* protein are returned
  97    * @return
  98    */
  99   public List<String> findXrefSourcesForSequences(boolean dna)
 100   {
 101     List<String> sources = new ArrayList<String>();
 102     for (SequenceI seq : fromSeqs)
 103     {
 104       if (seq != null)
 105       {
 106         findXrefSourcesForSequence(seq, dna, sources);
 107       }
 108     }
 109     return sources;
 110   }
 111
 112   /**
 113    * Returns a list of distinct database sources for which a sequence has either
 114    * <ul>
 115    * <li>a (dna-to-protein or protein-to-dna) cross-reference</li>
 116    * <li>an indirect cross-reference - a (dna-to-protein or protein-to-dna)
 117    * reference from another sequence in the dataset which has a cross-reference
 118    * to a direct DBRefEntry on the given sequence</li>
 119    * </ul>
 120    *
 121    * @param seq
 122    *          the sequence whose dbrefs we are searching against
 123    * @param fromDna
 124    *          when true, context is DNA - so sources identifying protein
 125    *          products will be returned.
 126    * @param sources
 127    *          a list of sources to add matches to
 128    */
 129   void findXrefSourcesForSequence(SequenceI seq, boolean fromDna,
 130           List<String> sources)
 131   {
 132     /*
 133      * first find seq's xrefs (dna-to-peptide or peptide-to-dna)
 134      */
 135     DBRefEntry[] rfs = DBRefUtils.selectDbRefs(!fromDna, seq.getDBRefs());
 136     addXrefsToSources(rfs, sources);
 137     if (dataset != null)
 138     {
 139       /*
 140        * find sequence's direct (dna-to-dna, peptide-to-peptide) xrefs
 141        */
 142       DBRefEntry[] lrfs = DBRefUtils.selectDbRefs(fromDna, seq.getDBRefs());
 143       List<SequenceI> foundSeqs = new ArrayList<SequenceI>();
 144
 145       /*
 146        * find sequences in the alignment which xref one of these DBRefs
 147        * i.e. is xref-ed to a common sequence identifier
 148        */
 149       searchDatasetXrefs(fromDna, seq, lrfs, foundSeqs, null);
 150
 151       /*
 152        * add those sequences' (dna-to-peptide or peptide-to-dna) dbref sources
 153        */
 154       for (SequenceI rs : foundSeqs)
 155       {
 156         DBRefEntry[] xrs = DBRefUtils
 157                 .selectDbRefs(!fromDna, rs.getDBRefs());
 158         addXrefsToSources(xrs, sources);
 159       }
 160     }
 161   }
 162
 163   /**
 164    * Helper method that adds the source identifiers of some cross-references to
 165    * a (non-redundant) list of database sources
 166    *
 167    * @param xrefs
 168    * @param sources
 169    */
 170   void addXrefsToSources(DBRefEntry[] xrefs, List<String> sources)
 171   {
 172     if (xrefs != null)
 173     {
 174       for (DBRefEntry ref : xrefs)
 175       {
 176         /*
 177          * avoid duplication e.g. ENSEMBL and Ensembl
 178          */
 179         String source = DBRefUtils.getCanonicalName(ref.getSource());
 180         if (!sources.contains(source))
 181         {
 182           sources.add(source);
 183         }
 184       }
 185     }
 186   }
 187
 188   /**
 189    * Attempts to find cross-references from the sequences provided in the
 190    * constructor to the given source database. Cross-references may be found
 191    * <ul>
 192    * <li>in dbrefs on the sequence which hold a mapping to a sequence
 193    * <ul>
 194    * <li>provided with a fetched sequence (e.g. ENA translation), or</li>
 195    * <li>populated previously after getting cross-references</li>
 196    * </ul>
 197    * <li>as other sequences in the alignment which share a dbref identifier with
 198    * the sequence</li>
 199    * <li>by fetching from the remote database</li>
 200    * </ul>
 201    * The cross-referenced sequences, and mappings to them, are added to the
 202    * alignment dataset.
 203    *
 204    * @param source
 205    * @return cross-referenced sequences (as dataset sequences)
 206    */
 207   public Alignment findXrefSequences(String source, boolean fromDna)
 208   {
 209
 210     rseqs = new ArrayList<SequenceI>();
 211     AlignedCodonFrame cf = new AlignedCodonFrame();
 212     matcher = new SequenceIdMatcher(
 213             dataset.getSequences());
 214
 215     for (SequenceI seq : fromSeqs)
 216     {
 217       SequenceI dss = seq;
 218       while (dss.getDatasetSequence() != null)
 219       {
 220         dss = dss.getDatasetSequence();
 221       }
 222       boolean found = false;
 223       DBRefEntry[] xrfs = DBRefUtils
 224               .selectDbRefs(!fromDna, dss.getDBRefs());
 225       // ENST & ENSP comes in to both Protein and nucleotide, so we need to
 226       // filter them
 227       // out later.
 228       if ((xrfs == null || xrfs.length == 0) && dataset != null)
 229       {
 230         /*
 231          * found no suitable dbrefs on sequence - look for sequences in the
 232          * alignment which share a dbref with this one
 233          */
 234         DBRefEntry[] lrfs = DBRefUtils.selectDbRefs(fromDna,
 235                 seq.getDBRefs());
 236
 237         /*
 238          * find sequences (except this one!), of complementary type,
 239          *  which have a dbref to an accession id for this sequence,
 240          *  and add them to the results
 241          */
 242         found = searchDatasetXrefs(fromDna, dss, lrfs, rseqs, cf);
 243       }
 244       if (xrfs == null && !found)
 245       {
 246         /*
 247          * no dbref to source on this sequence or matched
 248          * complementary sequence in the dataset
 249          */
 250         continue;
 251       }
 252       List<DBRefEntry> sourceRefs = DBRefUtils.searchRefsForSource(xrfs,
 253               source);
 254       Iterator<DBRefEntry> refIterator = sourceRefs.iterator();
 255       // At this point, if we are retrieving Ensembl, we still don't filter out
 256       // ENST when looking for protein crossrefs.
 257       while (refIterator.hasNext())
 258       {
 259         DBRefEntry xref = refIterator.next();
 260         found = false;
 261         // we're only interested in coding cross-references, not
 262         // locus->transcript
 263         if (xref.hasMap() && xref.getMap().getMap().isTripletMap())
 264         {
 265           SequenceI mappedTo = xref.getMap().getTo();
 266           if (mappedTo != null)
 267           {
 268             /*
 269              * dbref contains the sequence it maps to; add it to the
 270              * results unless we have done so already (could happen if
 271              * fetching xrefs for sequences which have xrefs in common)
 272              * for example: UNIPROT {P0CE19, P0CE20} -> EMBL {J03321, X06707}
 273              */
 274             found = true;
 275             /*
 276              * problem: matcher.findIdMatch() is lenient - returns a sequence
 277              * with a dbref to the search arg e.g. ENST for ENSP - wrong
 278              * but findInDataset() matches ENSP when looking for Uniprot...
 279              */
 280             SequenceI matchInDataset = findInDataset(xref);
 281             if (matchInDataset != null && xref.getMap().getTo() != null
 282                     && matchInDataset != xref.getMap().getTo())
 283             {
 284               System.err
 285                       .println("Implementation problem (reopen JAL-2154): CrossRef.findInDataset seems to have recovered a different sequence than the one explicitly mapped for xref."
 286                               + "Found:"
 287                               + matchInDataset
 288                               + "\nExpected:"
 289                               + xref.getMap().getTo()
 290                               + "\nFor xref:"
 291                               + xref);
 292             }
 293             /*matcher.findIdMatch(mappedTo);*/
 294             if (matchInDataset != null)
 295             {
 296               if (!rseqs.contains(matchInDataset))
 297               {
 298                 rseqs.add(matchInDataset);
 299               }
 300               // even if rseqs contained matchInDataset - check mappings between
 301               // these seqs are added
 302               // need to try harder to only add unique mappings
 303               if (xref.getMap().getMap().isTripletMap()
 304                       && dataset.getMapping(seq, matchInDataset) == null
 305                       && cf.getMappingBetween(seq, matchInDataset) == null)
 306               {
 307                 // materialise a mapping for highlighting between these
 308                 // sequences
 309                 if (fromDna)
 310                 {
 311                   cf.addMap(dss, matchInDataset, xref.getMap().getMap(),
 312                           xref.getMap().getMappedFromId());
 313                 }
 314                 else
 315                 {
 316                   cf.addMap(matchInDataset, dss, xref.getMap().getMap()
 317                           .getInverse(), xref.getMap().getMappedFromId());
 318                 }
 319               }
 320
 321               refIterator.remove();
 322               continue;
 323             }
 324             // TODO: need to determine if this should be a deriveSequence
 325             SequenceI rsq = new Sequence(mappedTo);
 326             rseqs.add(rsq);
 327             if (xref.getMap().getMap().isTripletMap())
 328             {
 329               // get sense of map correct for adding to product alignment.
 330               if (fromDna)
 331               {
 332                 // map is from dna seq to a protein product
 333                 cf.addMap(dss, rsq, xref.getMap().getMap(), xref.getMap()
 334                         .getMappedFromId());
 335               }
 336               else
 337               {
 338                 // map should be from protein seq to its coding dna
 339                 cf.addMap(rsq, dss, xref.getMap().getMap().getInverse(),
 340                         xref.getMap().getMappedFromId());
 341               }
 342             }
 343           }
 344         }
 345
 346         if (!found)
 347         {
 348           SequenceI matchedSeq = matcher.findIdMatch(xref.getSource() + "|"
 349                   + xref.getAccessionId());
 350           // if there was a match, check it's at least the right type of
 351           // molecule!
 352           if (matchedSeq != null && matchedSeq.isProtein() == fromDna)
 353           {
 354             if (constructMapping(seq, matchedSeq, xref, cf, fromDna))
 355             {
 356               found = true;
 357             }
 358           }
 359         }
 360
 361         if (!found)
 362         {
 363           // do a bit more work - search for sequences with references matching
 364           // xrefs on this sequence.
 365           found = searchDataset(fromDna, dss, xref, rseqs, cf, false);
 366         }
 367         if (found)
 368         {
 369           refIterator.remove();
 370         }
 371       }
 372
 373       /*
 374        * fetch from source database any dbrefs we haven't resolved up to here
 375        */
 376       if (!sourceRefs.isEmpty())
 377       {
 378         retrieveCrossRef(sourceRefs, seq, xrfs, fromDna, cf);
 379       }
 380     }
 381
 382     Alignment ral = null;
 383     if (rseqs.size() > 0)
 384     {
 385       ral = new Alignment(rseqs.toArray(new SequenceI[rseqs.size()]));
 386       if (!cf.isEmpty())
 387       {
 388         dataset.addCodonFrame(cf);
 389       }
 390     }
 391     return ral;
 392   }
 393
 394   private void retrieveCrossRef(List<DBRefEntry> sourceRefs, SequenceI seq,
 395           DBRefEntry[] xrfs, boolean fromDna, AlignedCodonFrame cf)
 396   {
 397     ASequenceFetcher sftch = SequenceFetcherFactory.getSequenceFetcher();
 398     SequenceI[] retrieved = null;
 399     SequenceI dss = seq.getDatasetSequence() == null ? seq : seq
 400             .getDatasetSequence();
 401     // first filter in case we are retrieving crossrefs that have already been
 402     // retrieved. this happens for cases where a database record doesn't yield
 403     // protein products for CDS
 404     DBRefEntry[] dbrSourceSet = sourceRefs.toArray(new DBRefEntry[0]);
 405     for (SequenceI sq : dataset.getSequences())
 406     {
 407       boolean dupeFound = false;
 408       // !fromDna means we are looking only for nucleotide sequences, not
 409       // protein
 410       if (sq.isProtein() == fromDna)
 411       {
 412         for (DBRefEntry dbr : sq.getPrimaryDBRefs())
 413         {
 414           for (DBRefEntry found : DBRefUtils.searchRefs(dbrSourceSet, dbr))
 415           {
 416             sourceRefs.remove(found);
 417             dupeFound = true;
 418           }
 419         }
 420       }
 421       if (dupeFound)
 422       {
 423         dbrSourceSet = sourceRefs.toArray(new DBRefEntry[0]);
 424       }
 425     }
 426     if (sourceRefs.size() == 0)
 427     {
 428       // no more work to do! We already had all requested sequence records in
 429       // the dataset.
 430       return;
 431     }
 432     try
 433     {
 434       retrieved = sftch.getSequences(sourceRefs, !fromDna);
 435     } catch (Exception e)
 436     {
 437       System.err
 438               .println("Problem whilst retrieving cross references for Sequence : "
 439                       + seq.getName());
 440       e.printStackTrace();
 441     }
 442
 443     if (retrieved != null)
 444     {
 445       updateDbrefMappings(seq, xrfs, retrieved, cf, fromDna);
 446       for (SequenceI retrievedSequence : retrieved)
 447       {
 448         // dataset gets contaminated ccwith non-ds sequences. why ??!
 449         // try: Ensembl -> Nuc->Ensembl, Nuc->Uniprot-->Protein->EMBL->
 450         SequenceI retrievedDss = retrievedSequence.getDatasetSequence() == null ? retrievedSequence
 451                 : retrievedSequence.getDatasetSequence();
 452         DBRefEntry[] dbr = retrievedSequence.getDBRefs();
 453         if (dbr != null)
 454         {
 455           for (DBRefEntry dbref : dbr)
 456           {
 457             // find any entry where we should put in the sequence being
 458             // cross-referenced into the map
 459             Mapping map = dbref.getMap();
 460             if (map != null)
 461             {
 462               if (map.getTo() != null && map.getMap() != null)
 463               {
 464                 // TODO findInDataset requires exact sequence match but
 465                 // 'congruent' test is only for the mapped part
 466                 // maybe not a problem in practice since only ENA provide a
 467                 // mapping and it is to the full protein translation of CDS
 468                 SequenceI matched = findInDataset(dbref);
 469                 // matcher.findIdMatch(map.getTo());
 470                 if (matched != null)
 471                 {
 472                   /*
 473                    * already got an xref to this sequence; update this
 474                    * map to point to the same sequence, and add
 475                    * any new dbrefs to it
 476                    */
 477                   DBRefEntry[] toRefs = map.getTo().getDBRefs();
 478                   if (toRefs != null)
 479                   {
 480                     for (DBRefEntry ref : toRefs)
 481                     {
 482                       matched.addDBRef(ref); // add or update mapping
 483                     }
 484                   }
 485                   map.setTo(matched);
 486                 }
 487                 else
 488                 {
 489                   if (dataset.findIndex(map.getTo()) == -1)
 490                   {
 491                     dataset.addSequence(map.getTo());
 492                     matcher.add(map.getTo());
 493                   }
 494                 }
 495                 try
 496                 {
 497                   // compare ms with dss and replace with dss in mapping
 498                   // if map is congruent
 499                   SequenceI ms = map.getTo();
 500                   int sf = map.getMap().getToLowest();
 501                   int st = map.getMap().getToHighest();
 502                   SequenceI mappedrg = ms.getSubSequence(sf, st);
 503                   // SequenceI loc = dss.getSubSequence(sf, st);
 504                   if (mappedrg.getLength() > 0
 505                           && ms.getSequenceAsString().equals(
 506                                   dss.getSequenceAsString()))
 507                   // && mappedrg.getSequenceAsString().equals(
 508                   // loc.getSequenceAsString()))
 509                   {
 510                     String msg = "Mapping updated from " + ms.getName()
 511                             + " to retrieved crossreference "
 512                             + dss.getName();
 513                     System.out.println(msg);
 514                     map.setTo(dss);
 515
 516                     /*
 517                      * give the reverse reference the inverse mapping
 518                      * (if it doesn't have one already)
 519                      */
 520                     setReverseMapping(dss, dbref, cf);
 521
 522                     /*
 523                      * copy sequence features as well, avoiding
 524                      * duplication (e.g. same variation from two
 525                      * transcripts)
 526                      */
 527                     SequenceFeature[] sfs = ms.getSequenceFeatures();
 528                     if (sfs != null)
 529                     {
 530                       for (SequenceFeature feat : sfs)
 531                       {
 532                         /*
 533                          * make a flyweight feature object which ignores Parent
 534                          * attribute in equality test; this avoids creating many
 535                          * otherwise duplicate exon features on genomic sequence
 536                          */
 537                         SequenceFeature newFeature = new SequenceFeature(
 538                                 feat)
 539                         {
 540                           @Override
 541                           public boolean equals(Object o)
 542                           {
 543                             return super.equals(o, true);
 544                           }
 545                         };
 546                         dss.addSequenceFeature(newFeature);
 547                       }
 548                     }
 549                   }
 550                   cf.addMap(retrievedDss, map.getTo(), map.getMap());
 551                 } catch (Exception e)
 552                 {
 553                   System.err
 554                           .println("Exception when consolidating Mapped sequence set...");
 555                   e.printStackTrace(System.err);
 556                 }
 557               }
 558             }
 559           }
 560         }
 561         retrievedSequence.updatePDBIds();
 562         rseqs.add(retrievedDss);
 563         if (dataset.findIndex(retrievedDss) == -1)
 564         {
 565           dataset.addSequence(retrievedDss);
 566           matcher.add(retrievedDss);
 567         }
 568       }
 569     }
 570   }
 571   /**
 572    * Sets the inverse sequence mapping in the corresponding dbref of the mapped
 573    * to sequence (if any). This is used after fetching a cross-referenced
 574    * sequence, if the fetched sequence has a mapping to the original sequence,
 575    * to set the mapping in the original sequence's dbref.
 576    *
 577    * @param mapFrom
 578    *          the sequence mapped from
 579    * @param dbref
 580    * @param mappings
 581    */
 582   void setReverseMapping(SequenceI mapFrom, DBRefEntry dbref,
 583           AlignedCodonFrame mappings)
 584   {
 585     SequenceI mapTo = dbref.getMap().getTo();
 586     if (mapTo == null)
 587     {
 588       return;
 589     }
 590     DBRefEntry[] dbrefs = mapTo.getDBRefs();
 591     if (dbrefs == null)
 592     {
 593       return;
 594     }
 595     for (DBRefEntry toRef : dbrefs)
 596     {
 597       if (toRef.hasMap() && mapFrom == toRef.getMap().getTo())
 598       {
 599         /*
 600          * found the reverse dbref; update its mapping if null
 601          */
 602         if (toRef.getMap().getMap() == null)
 603         {
 604           MapList inverse = dbref.getMap().getMap().getInverse();
 605           toRef.getMap().setMap(inverse);
 606           mappings.addMap(mapTo, mapFrom, inverse);
 607         }
 608       }
 609     }
 610   }
 611
 612   /**
 613    * Returns the first identical sequence in the dataset if any, else null
 614    *
 615    * @param xref
 616    * @return
 617    */
 618   SequenceI findInDataset(DBRefEntry xref)
 619   {
 620     if (xref == null || !xref.hasMap() || xref.getMap().getTo() == null)
 621     {
 622       return null;
 623     }
 624     SequenceI mapsTo = xref.getMap().getTo();
 625     String name = xref.getAccessionId();
 626     String name2 = xref.getSource() + "|" + name;
 627     SequenceI dss = mapsTo.getDatasetSequence() == null ? mapsTo : mapsTo
 628             .getDatasetSequence();
 629     // first check ds if ds is directly referenced
 630     if (dataset.findIndex(dss) > -1)
 631     {
 632       return dss;
 633     }
 634     ;
 635     for (SequenceI seq : dataset.getSequences())
 636     {
 637       /*
 638        * clumsy alternative to using SequenceIdMatcher which currently
 639        * returns sequences with a dbref to the matched accession id
 640        * which we don't want
 641        */
 642       if (name.equals(seq.getName()) || seq.getName().startsWith(name2))
 643       {
 644         if (sameSequence(seq, dss))
 645         {
 646           return seq;
 647         }
 648       }
 649     }
 650     return null;
 651   }
 652
 653   /**
 654    * Answers true if seq1 and seq2 contain exactly the same characters (ignoring
 655    * case), else false. This method compares the lengths, then each character in
 656    * turn, in order to 'fail fast'. For case-sensitive comparison, it would be
 657    * possible to use Arrays.equals(seq1.getSequence(), seq2.getSequence()).
 658    *
 659    * @param seq1
 660    * @param seq2
 661    * @return
 662    */
 663   // TODO move to Sequence / SequenceI
 664   static boolean sameSequence(SequenceI seq1, SequenceI seq2)
 665   {
 666     if (seq1 == seq2)
 667     {
 668       return true;
 669     }
 670     if (seq1 == null || seq2 == null)
 671     {
 672       return false;
 673     }
 674     char[] c1 = seq1.getSequence();
 675     char[] c2 = seq2.getSequence();
 676     if (c1.length != c2.length)
 677     {
 678       return false;
 679     }
 680     for (int i = 0; i < c1.length; i++)
 681     {
 682       int diff = c1[i] - c2[i];
 683       /*
 684        * same char or differ in case only ('a'-'A' == 32)
 685        */
 686       if (diff != 0 && diff != 32 && diff != -32)
 687       {
 688         return false;
 689       }
 690     }
 691     return true;
 692   }
 693
 694   /**
 695    * Updates any empty mappings in the cross-references with one to a compatible
 696    * retrieved sequence if found, and adds any new mappings to the
 697    * AlignedCodonFrame
 698    *
 699    * @param mapFrom
 700    * @param xrefs
 701    * @param retrieved
 702    * @param acf
 703    */
 704   void updateDbrefMappings(SequenceI mapFrom, DBRefEntry[] xrefs,
 705           SequenceI[] retrieved, AlignedCodonFrame acf, boolean fromDna)
 706   {
 707     SequenceIdMatcher idMatcher = new SequenceIdMatcher(retrieved);
 708     for (DBRefEntry xref : xrefs)
 709     {
 710       if (!xref.hasMap())
 711       {
 712         String targetSeqName = xref.getSource() + "|"
 713                 + xref.getAccessionId();
 714         SequenceI[] matches = idMatcher.findAllIdMatches(targetSeqName);
 715         if (matches == null)
 716         {
 717           return;
 718         }
 719         for (SequenceI seq : matches)
 720         {
 721           constructMapping(mapFrom, seq, xref, acf, fromDna);
 722         }
 723       }
 724     }
 725   }
 726
 727   /**
 728    * Tries to make a mapping between sequences. If successful, adds the mapping
 729    * to the dbref and the mappings collection and answers true, otherwise
 730    * answers false. The following methods of making are mapping are tried in
 731    * turn:
 732    * <ul>
 733    * <li>if 'mapTo' holds a mapping to 'mapFrom', take the inverse; this is, for
 734    * example, the case after fetching EMBL cross-references for a Uniprot
 735    * sequence</li>
 736    * <li>else check if the dna translates exactly to the protein (give or take
 737    * start and stop codons></li>
 738    * <li>else try to map based on CDS features on the dna sequence</li>
 739    * </ul>
 740    *
 741    * @param mapFrom
 742    * @param mapTo
 743    * @param xref
 744    * @param mappings
 745    * @return
 746    */
 747   boolean constructMapping(SequenceI mapFrom, SequenceI mapTo,
 748           DBRefEntry xref, AlignedCodonFrame mappings, boolean fromDna)
 749   {
 750     MapList mapping = null;
 751     SequenceI dsmapFrom = mapFrom.getDatasetSequence() == null ? mapFrom
 752             : mapFrom.getDatasetSequence();
 753     SequenceI dsmapTo = mapTo.getDatasetSequence() == null ? mapTo
 754             : mapTo.getDatasetSequence();
 755     /*
 756      * look for a reverse mapping, if found make its inverse.
 757      * Note - we do this on dataset sequences only.
 758      */
 759     if (dsmapTo.getDBRefs() != null)
 760     {
 761       for (DBRefEntry dbref : dsmapTo.getDBRefs())
 762       {
 763         String name = dbref.getSource() + "|" + dbref.getAccessionId();
 764         if (dbref.hasMap() && dsmapFrom.getName().startsWith(name))
 765         {
 766           /*
 767            * looks like we've found a map from 'mapTo' to 'mapFrom'
 768            * - invert it to make the mapping the other way
 769            */
 770           MapList reverse = dbref.getMap().getMap().getInverse();
 771           xref.setMap(new Mapping(dsmapTo, reverse));
 772           mappings.addMap(mapFrom, dsmapTo, reverse);
 773           return true;
 774         }
 775       }
 776     }
 777
 778     if (fromDna)
 779     {
 780       mapping = AlignmentUtils.mapCdnaToProtein(mapTo, mapFrom);
 781     }
 782     else
 783     {
 784       mapping = AlignmentUtils.mapCdnaToProtein(mapFrom, mapTo);
 785       if (mapping != null)
 786       {
 787         mapping = mapping.getInverse();
 788       }
 789     }
 790     if (mapping == null)
 791     {
 792       return false;
 793     }
 794     xref.setMap(new Mapping(mapTo, mapping));
 795
 796     /*
 797      * and add a reverse DbRef with the inverse mapping
 798      */
 799     if (mapFrom.getDatasetSequence() != null && false)
 800     // && mapFrom.getDatasetSequence().getSourceDBRef() != null)
 801     {
 802       // possible need to search primary references... except, why doesn't xref
 803       // == getSourceDBRef ??
 804       // DBRefEntry dbref = new DBRefEntry(mapFrom.getDatasetSequence()
 805       // .getSourceDBRef());
 806       // dbref.setMap(new Mapping(mapFrom.getDatasetSequence(), mapping
 807       // .getInverse()));
 808       // mapTo.addDBRef(dbref);
 809     }
 810
 811     if (fromDna)
 812     {
 813       AlignmentUtils.computeProteinFeatures(mapFrom, mapTo, mapping);
 814       mappings.addMap(mapFrom, mapTo, mapping);
 815     }
 816     else
 817     {
 818       mappings.addMap(mapTo, mapFrom, mapping.getInverse());
 819     }
 820
 821     return true;
 822   }
 823
 824   /**
 825    * find references to lrfs in the cross-reference set of each sequence in
 826    * dataset (that is not equal to sequenceI) Identifies matching DBRefEntry
 827    * based on source and accession string only - Map and Version are nulled.
 828    *
 829    * @param fromDna
 830    *          - true if context was searching from Dna sequences, false if
 831    *          context was searching from Protein sequences
 832    * @param sequenceI
 833    * @param lrfs
 834    * @param foundSeqs
 835    * @return true if matches were found.
 836    */
 837   private boolean searchDatasetXrefs(boolean fromDna, SequenceI sequenceI,
 838           DBRefEntry[] lrfs, List<SequenceI> foundSeqs, AlignedCodonFrame cf)
 839   {
 840     boolean found = false;
 841     if (lrfs == null)
 842     {
 843       return false;
 844     }
 845     for (int i = 0; i < lrfs.length; i++)
 846     {
 847       DBRefEntry xref = new DBRefEntry(lrfs[i]);
 848       // add in wildcards
 849       xref.setVersion(null);
 850       xref.setMap(null);
 851       found |= searchDataset(fromDna, sequenceI, xref, foundSeqs, cf, false);
 852     }
 853     return found;
 854   }
 855
 856   /**
 857    * Searches dataset for DBRefEntrys matching the given one (xrf) and adds the
 858    * associated sequence to rseqs
 859    *
 860    * @param fromDna
 861    *          true if context was searching for refs *from* dna sequence, false
 862    *          if context was searching for refs *from* protein sequence
 863    * @param fromSeq
 864    *          a sequence to ignore (start point of search)
 865    * @param xrf
 866    *          a cross-reference to try to match
 867    * @param foundSeqs
 868    *          result list to add to
 869    * @param mappings
 870    *          a set of sequence mappings to add to
 871    * @param direct
 872    *          - indicates the type of relationship between returned sequences,
 873    *          xrf, and sequenceI that is required.
 874    *          <ul>
 875    *          <li>direct implies xrf is a primary reference for sequenceI AND
 876    *          the sequences to be located (eg a uniprot ID for a protein
 877    *          sequence, and a uniprot ref on a transcript sequence).</li>
 878    *          <li>indirect means xrf is a cross reference with respect to
 879    *          sequenceI or all the returned sequences (eg a genomic reference
 880    *          associated with a locus and one or more transcripts)</li>
 881    *          </ul>
 882    * @return true if relationship found and sequence added.
 883    */
 884   boolean searchDataset(boolean fromDna, SequenceI fromSeq, DBRefEntry xrf,
 885           List<SequenceI> foundSeqs, AlignedCodonFrame mappings,
 886           boolean direct)
 887   {
 888     boolean found = false;
 889     if (dataset == null)
 890     {
 891       return false;
 892     }
 893     if (dataset.getSequences() == null)
 894     {
 895       System.err.println("Empty dataset sequence set - NO VECTOR");
 896       return false;
 897     }
 898     List<SequenceI> ds;
 899     synchronized (ds = dataset.getSequences())
 900     {
 901       for (SequenceI nxt : ds)
 902       {
 903         if (nxt != null)
 904         {
 905           if (nxt.getDatasetSequence() != null)
 906           {
 907             System.err
 908                     .println("Implementation warning: CrossRef initialised with a dataset alignment with non-dataset sequences in it! ("
 909                             + nxt.getDisplayId(true)
 910                             + " has ds reference "
 911                             + nxt.getDatasetSequence().getDisplayId(true)
 912                             + ")");
 913           }
 914           if (nxt == fromSeq || nxt == fromSeq.getDatasetSequence())
 915           {
 916             continue;
 917           }
 918           /*
 919            * only look at same molecule type if 'direct', or
 920            * complementary type if !direct
 921            */
 922           {
 923             boolean isDna = !nxt.isProtein();
 924             if (direct ? (isDna != fromDna) : (isDna == fromDna))
 925             {
 926               // skip this sequence because it is wrong molecule type
 927               continue;
 928             }
 929           }
 930
 931           // look for direct or indirect references in common
 932           DBRefEntry[] poss = nxt.getDBRefs();
 933           List<DBRefEntry> cands = null;
 934
 935           // todo: indirect specifies we select either direct references to nxt
 936           // that match xrf which is indirect to sequenceI, or indirect
 937           // references to nxt that match xrf which is direct to sequenceI
 938           cands = DBRefUtils.searchRefs(poss, xrf);
 939           // else
 940           // {
 941           // poss = DBRefUtils.selectDbRefs(nxt.isProtein()!fromDna, poss);
 942           // cands = DBRefUtils.searchRefs(poss, xrf);
 943           // }
 944           if (!cands.isEmpty())
 945           {
 946             if (foundSeqs.contains(nxt))
 947             {
 948               continue;
 949             }
 950             found = true;
 951             foundSeqs.add(nxt);
 952             if (mappings != null && !direct)
 953             {
 954               /*
 955                * if the matched sequence has mapped dbrefs to
 956                * protein product / cdna, add equivalent mappings to
 957                * our source sequence
 958                */
 959               for (DBRefEntry candidate : cands)
 960               {
 961                 Mapping mapping = candidate.getMap();
 962                 if (mapping != null)
 963                 {
 964                   MapList map = mapping.getMap();
 965                   if (mapping.getTo() != null
 966                           && map.getFromRatio() != map.getToRatio())
 967                   {
 968                     /*
 969                      * add a mapping, as from dna to peptide sequence
 970                      */
 971                     if (map.getFromRatio() == 3)
 972                     {
 973                       mappings.addMap(nxt, fromSeq, map);
 974                     }
 975                     else
 976                     {
 977                       mappings.addMap(nxt, fromSeq, map.getInverse());
 978                     }
 979                   }
 980                 }
 981               }
 982             }
 983           }
 984         }
 985       }
 986     }
 987     return found;
 988   }
 989 }