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     removeAlreadyRetrievedSeqs(sourceRefs, fromDna);
 405     if (sourceRefs.size() == 0)
 406     {
 407       // no more work to do! We already had all requested sequence records in
 408       // the dataset.
 409       return;
 410     }
 411     try
 412     {
 413       retrieved = sftch.getSequences(sourceRefs, !fromDna);
 414     } catch (Exception e)
 415     {
 416       System.err
 417               .println("Problem whilst retrieving cross references for Sequence : "
 418                       + seq.getName());
 419       e.printStackTrace();
 420     }
 421
 422     if (retrieved != null)
 423     {
 424       updateDbrefMappings(seq, xrfs, retrieved, cf, fromDna);
 425       for (SequenceI retrievedSequence : retrieved)
 426       {
 427         // dataset gets contaminated ccwith non-ds sequences. why ??!
 428         // try: Ensembl -> Nuc->Ensembl, Nuc->Uniprot-->Protein->EMBL->
 429         SequenceI retrievedDss = retrievedSequence.getDatasetSequence() == null ? retrievedSequence
 430                 : retrievedSequence.getDatasetSequence();
 431         importCrossRefSeq(cf, dss, retrievedDss);
 432         rseqs.add(retrievedDss);
 433         if (dataset.findIndex(retrievedDss) == -1)
 434         {
 435           dataset.addSequence(retrievedDss);
 436           matcher.add(retrievedDss);
 437         }
 438       }
 439     }
 440   }
 441
 442   /**
 443    * Search dataset for sequences with a primary reference contained in
 444    * sourceRefs.
 445    *
 446    * @param sourceRefs
 447    *          - list of references to filter.
 448    * @param fromDna
 449    *          - type of sequence to search for matching primary reference.
 450    */
 451   private void removeAlreadyRetrievedSeqs(List<DBRefEntry> sourceRefs,
 452           boolean fromDna)
 453   {
 454     DBRefEntry[] dbrSourceSet = sourceRefs.toArray(new DBRefEntry[0]);
 455     for (SequenceI sq : dataset.getSequences())
 456     {
 457       boolean dupeFound = false;
 458       // !fromDna means we are looking only for nucleotide sequences, not
 459       // protein
 460       if (sq.isProtein() == fromDna)
 461       {
 462         for (DBRefEntry dbr : sq.getPrimaryDBRefs())
 463         {
 464           for (DBRefEntry found : DBRefUtils.searchRefs(dbrSourceSet, dbr))
 465           {
 466             sourceRefs.remove(found);
 467             dupeFound = true;
 468           }
 469         }
 470       }
 471       if (dupeFound)
 472       {
 473         // rebuild the search array from the filtered sourceRefs list
 474         dbrSourceSet = sourceRefs.toArray(new DBRefEntry[0]);
 475       }
 476     }
 477   }
 478
 479   /**
 480    * process sequence retrieved via a dbref on source sequence to resolve and
 481    * transfer data
 482    *
 483    * @param cf
 484    * @param sourceSequence
 485    * @param retrievedSequence
 486    * @return true if retrieveSequence was imported
 487    */
 488   private boolean importCrossRefSeq(AlignedCodonFrame cf,
 489           SequenceI sourceSequence, SequenceI retrievedSequence)
 490   {
 491     /**
 492      * set when retrievedSequence has been verified as a crossreference for
 493      * sourceSequence
 494      */
 495     boolean imported = false;
 496     DBRefEntry[] dbr = retrievedSequence.getDBRefs();
 497     List<SequenceI> newDsSeqs = new ArrayList<SequenceI>();
 498     if (dbr != null)
 499     {
 500       for (DBRefEntry dbref : dbr)
 501       {
 502         SequenceI matched = findInDataset(dbref);
 503         if (matched == sourceSequence)
 504         {
 505           // verified retrieved and source sequence cross-reference each other
 506           imported = true;
 507         }
 508         // find any entry where we should put in the sequence being
 509         // cross-referenced into the map
 510         Mapping map = dbref.getMap();
 511         if (map != null)
 512         {
 513           if (map.getTo() != null && map.getMap() != null)
 514           {
 515             if (map.getTo() == sourceSequence)
 516             {
 517               // already called to import once, and most likely this sequence
 518               // already imported !
 519               continue;
 520             }
 521             if (matched == null)
 522             {
 523               /*
 524                * sequence is new to dataset, so save a reference so it can be added.
 525                */
 526               newDsSeqs.add(map.getTo());
 527               continue;
 528             }
 529
 530             /*
 531              * there was a matching sequence in dataset, so now, check to see if we can update the map.getTo() sequence to the existing one.
 532              */
 533
 534             try
 535             {
 536               // compare ms with dss and replace with dss in mapping
 537               // if map is congruent
 538               SequenceI ms = map.getTo();
 539               // TODO findInDataset requires exact sequence match but
 540               // 'congruent' test is only for the mapped part
 541               // maybe not a problem in practice since only ENA provide a
 542               // mapping and it is to the full protein translation of CDS
 543               // matcher.findIdMatch(map.getTo());
 544               // TODO addendum: if matched is shorter than getTo, this will fail
 545               // - when it should really succeed.
 546               int sf = map.getMap().getToLowest();
 547               int st = map.getMap().getToHighest();
 548               SequenceI mappedrg = ms.getSubSequence(sf, st);
 549               if (mappedrg.getLength() > 0
 550                       && ms.getSequenceAsString().equals(
 551                               matched.getSequenceAsString()))
 552               {
 553                 /*
 554                  * sequences were a match,
 555                  */
 556                 String msg = "Mapping updated from " + ms.getName()
 557                         + " to retrieved crossreference "
 558                         + matched.getName();
 559                 System.out.println(msg);
 560
 561                 DBRefEntry[] toRefs = map.getTo().getDBRefs();
 562                 if (toRefs != null)
 563                 {
 564                   /*
 565                    * transfer database refs
 566                    */
 567                   for (DBRefEntry ref : toRefs)
 568                   {
 569                     matched.addDBRef(ref); // add or update mapping
 570                   }
 571                 }
 572                 map.setTo(matched);
 573
 574                 /*
 575                  * give the reverse reference the inverse mapping
 576                  * (if it doesn't have one already)
 577                  */
 578                 setReverseMapping(matched, dbref, cf);
 579
 580                 /*
 581                  * copy sequence features as well, avoiding
 582                  * duplication (e.g. same variation from two
 583                  * transcripts)
 584                  */
 585                 SequenceFeature[] sfs = ms.getSequenceFeatures();
 586                 if (sfs != null)
 587                 {
 588                   for (SequenceFeature feat : sfs)
 589                   {
 590                     /*
 591                      * make a flyweight feature object which ignores Parent
 592                      * attribute in equality test; this avoids creating many
 593                      * otherwise duplicate exon features on genomic sequence
 594                      */
 595                     SequenceFeature newFeature = new SequenceFeature(
 596                             feat)
 597                     {
 598                       @Override
 599                       public boolean equals(Object o)
 600                       {
 601                         return super.equals(o, true);
 602                       }
 603                     };
 604                     matched.addSequenceFeature(newFeature);
 605                   }
 606                 }
 607
 608               }
 609               cf.addMap(retrievedSequence, map.getTo(), map.getMap());
 610             } catch (Exception e)
 611             {
 612               System.err
 613                       .println("Exception when consolidating Mapped sequence set...");
 614               e.printStackTrace(System.err);
 615             }
 616           }
 617         }
 618       }
 619     }
 620     if (imported)
 621     {
 622       retrievedSequence.updatePDBIds();
 623       rseqs.add(retrievedSequence);
 624       if (dataset.findIndex(retrievedSequence) == -1)
 625       {
 626         dataset.addSequence(retrievedSequence);
 627         matcher.add(retrievedSequence);
 628       }
 629       for (SequenceI newToSeq : newDsSeqs)
 630       {
 631
 632         if (dataset.findIndex(newToSeq) == -1)
 633         {
 634           dataset.addSequence(newToSeq);
 635           matcher.add(newToSeq);
 636         }
 637       }
 638     }
 639     return imported;
 640   }
 641   /**
 642    * Sets the inverse sequence mapping in the corresponding dbref of the mapped
 643    * to sequence (if any). This is used after fetching a cross-referenced
 644    * sequence, if the fetched sequence has a mapping to the original sequence,
 645    * to set the mapping in the original sequence's dbref.
 646    *
 647    * @param mapFrom
 648    *          the sequence mapped from
 649    * @param dbref
 650    * @param mappings
 651    */
 652   void setReverseMapping(SequenceI mapFrom, DBRefEntry dbref,
 653           AlignedCodonFrame mappings)
 654   {
 655     SequenceI mapTo = dbref.getMap().getTo();
 656     if (mapTo == null)
 657     {
 658       return;
 659     }
 660     DBRefEntry[] dbrefs = mapTo.getDBRefs();
 661     if (dbrefs == null)
 662     {
 663       return;
 664     }
 665     for (DBRefEntry toRef : dbrefs)
 666     {
 667       if (toRef.hasMap() && mapFrom == toRef.getMap().getTo())
 668       {
 669         /*
 670          * found the reverse dbref; update its mapping if null
 671          */
 672         if (toRef.getMap().getMap() == null)
 673         {
 674           MapList inverse = dbref.getMap().getMap().getInverse();
 675           toRef.getMap().setMap(inverse);
 676           mappings.addMap(mapTo, mapFrom, inverse);
 677         }
 678       }
 679     }
 680   }
 681
 682   /**
 683    * Returns null or the first sequence in the dataset which is identical to
 684    * xref.mapTo, and has a) a primary dbref matching xref, or if none found, the
 685    * first one with an ID source|xrefacc
 686    *
 687    * @param xref
 688    *          with map and mapped-to sequence
 689    * @return
 690    */
 691   SequenceI findInDataset(DBRefEntry xref)
 692   {
 693     if (xref == null || !xref.hasMap() || xref.getMap().getTo() == null)
 694     {
 695       return null;
 696     }
 697     SequenceI mapsTo = xref.getMap().getTo();
 698     String name = xref.getAccessionId();
 699     String name2 = xref.getSource() + "|" + name;
 700     SequenceI dss = mapsTo.getDatasetSequence() == null ? mapsTo : mapsTo
 701             .getDatasetSequence();
 702     // first check ds if ds is directly referenced
 703     if (dataset.findIndex(dss) > -1)
 704     {
 705       return dss;
 706     }
 707     DBRefEntry template = new DBRefEntry(xref.getSource(), null,
 708             xref.getAccessionId());
 709     /**
 710      * remember the first ID match - in case we don't find a match to template
 711      */
 712     SequenceI firstIdMatch = null;
 713     for (SequenceI seq : dataset.getSequences())
 714     {
 715       // first check primary refs.
 716       List<DBRefEntry> match = DBRefUtils.searchRefs(seq.getPrimaryDBRefs()
 717               .toArray(new DBRefEntry[0]), template);
 718       if (match != null && match.size() == 1 && sameSequence(seq, dss))
 719       {
 720         return seq;
 721       }
 722       /*
 723        * clumsy alternative to using SequenceIdMatcher which currently
 724        * returns sequences with a dbref to the matched accession id
 725        * which we don't want
 726        */
 727       if (firstIdMatch == null
 728               && (name.equals(seq.getName()) || seq.getName().startsWith(
 729                       name2)))
 730       {
 731         if (sameSequence(seq, dss))
 732         {
 733           firstIdMatch = seq;
 734         }
 735       }
 736     }
 737     return firstIdMatch;
 738   }
 739
 740   /**
 741    * Answers true if seq1 and seq2 contain exactly the same characters (ignoring
 742    * case), else false. This method compares the lengths, then each character in
 743    * turn, in order to 'fail fast'. For case-sensitive comparison, it would be
 744    * possible to use Arrays.equals(seq1.getSequence(), seq2.getSequence()).
 745    *
 746    * @param seq1
 747    * @param seq2
 748    * @return
 749    */
 750   // TODO move to Sequence / SequenceI
 751   static boolean sameSequence(SequenceI seq1, SequenceI seq2)
 752   {
 753     if (seq1 == seq2)
 754     {
 755       return true;
 756     }
 757     if (seq1 == null || seq2 == null)
 758     {
 759       return false;
 760     }
 761     char[] c1 = seq1.getSequence();
 762     char[] c2 = seq2.getSequence();
 763     if (c1.length != c2.length)
 764     {
 765       return false;
 766     }
 767     for (int i = 0; i < c1.length; i++)
 768     {
 769       int diff = c1[i] - c2[i];
 770       /*
 771        * same char or differ in case only ('a'-'A' == 32)
 772        */
 773       if (diff != 0 && diff != 32 && diff != -32)
 774       {
 775         return false;
 776       }
 777     }
 778     return true;
 779   }
 780
 781   /**
 782    * Updates any empty mappings in the cross-references with one to a compatible
 783    * retrieved sequence if found, and adds any new mappings to the
 784    * AlignedCodonFrame
 785    *
 786    * @param mapFrom
 787    * @param xrefs
 788    * @param retrieved
 789    * @param acf
 790    */
 791   void updateDbrefMappings(SequenceI mapFrom, DBRefEntry[] xrefs,
 792           SequenceI[] retrieved, AlignedCodonFrame acf, boolean fromDna)
 793   {
 794     SequenceIdMatcher idMatcher = new SequenceIdMatcher(retrieved);
 795     for (DBRefEntry xref : xrefs)
 796     {
 797       if (!xref.hasMap())
 798       {
 799         String targetSeqName = xref.getSource() + "|"
 800                 + xref.getAccessionId();
 801         SequenceI[] matches = idMatcher.findAllIdMatches(targetSeqName);
 802         if (matches == null)
 803         {
 804           return;
 805         }
 806         for (SequenceI seq : matches)
 807         {
 808           constructMapping(mapFrom, seq, xref, acf, fromDna);
 809         }
 810       }
 811     }
 812   }
 813
 814   /**
 815    * Tries to make a mapping between sequences. If successful, adds the mapping
 816    * to the dbref and the mappings collection and answers true, otherwise
 817    * answers false. The following methods of making are mapping are tried in
 818    * turn:
 819    * <ul>
 820    * <li>if 'mapTo' holds a mapping to 'mapFrom', take the inverse; this is, for
 821    * example, the case after fetching EMBL cross-references for a Uniprot
 822    * sequence</li>
 823    * <li>else check if the dna translates exactly to the protein (give or take
 824    * start and stop codons></li>
 825    * <li>else try to map based on CDS features on the dna sequence</li>
 826    * </ul>
 827    *
 828    * @param mapFrom
 829    * @param mapTo
 830    * @param xref
 831    * @param mappings
 832    * @return
 833    */
 834   boolean constructMapping(SequenceI mapFrom, SequenceI mapTo,
 835           DBRefEntry xref, AlignedCodonFrame mappings, boolean fromDna)
 836   {
 837     MapList mapping = null;
 838     SequenceI dsmapFrom = mapFrom.getDatasetSequence() == null ? mapFrom
 839             : mapFrom.getDatasetSequence();
 840     SequenceI dsmapTo = mapTo.getDatasetSequence() == null ? mapTo
 841             : mapTo.getDatasetSequence();
 842     /*
 843      * look for a reverse mapping, if found make its inverse.
 844      * Note - we do this on dataset sequences only.
 845      */
 846     if (dsmapTo.getDBRefs() != null)
 847     {
 848       for (DBRefEntry dbref : dsmapTo.getDBRefs())
 849       {
 850         String name = dbref.getSource() + "|" + dbref.getAccessionId();
 851         if (dbref.hasMap() && dsmapFrom.getName().startsWith(name))
 852         {
 853           /*
 854            * looks like we've found a map from 'mapTo' to 'mapFrom'
 855            * - invert it to make the mapping the other way
 856            */
 857           MapList reverse = dbref.getMap().getMap().getInverse();
 858           xref.setMap(new Mapping(dsmapTo, reverse));
 859           mappings.addMap(mapFrom, dsmapTo, reverse);
 860           return true;
 861         }
 862       }
 863     }
 864
 865     if (fromDna)
 866     {
 867       mapping = AlignmentUtils.mapCdnaToProtein(mapTo, mapFrom);
 868     }
 869     else
 870     {
 871       mapping = AlignmentUtils.mapCdnaToProtein(mapFrom, mapTo);
 872       if (mapping != null)
 873       {
 874         mapping = mapping.getInverse();
 875       }
 876     }
 877     if (mapping == null)
 878     {
 879       return false;
 880     }
 881     xref.setMap(new Mapping(mapTo, mapping));
 882
 883     /*
 884      * and add a reverse DbRef with the inverse mapping
 885      */
 886     if (mapFrom.getDatasetSequence() != null && false)
 887     // && mapFrom.getDatasetSequence().getSourceDBRef() != null)
 888     {
 889       // possible need to search primary references... except, why doesn't xref
 890       // == getSourceDBRef ??
 891       // DBRefEntry dbref = new DBRefEntry(mapFrom.getDatasetSequence()
 892       // .getSourceDBRef());
 893       // dbref.setMap(new Mapping(mapFrom.getDatasetSequence(), mapping
 894       // .getInverse()));
 895       // mapTo.addDBRef(dbref);
 896     }
 897
 898     if (fromDna)
 899     {
 900       AlignmentUtils.computeProteinFeatures(mapFrom, mapTo, mapping);
 901       mappings.addMap(mapFrom, mapTo, mapping);
 902     }
 903     else
 904     {
 905       mappings.addMap(mapTo, mapFrom, mapping.getInverse());
 906     }
 907
 908     return true;
 909   }
 910
 911   /**
 912    * find references to lrfs in the cross-reference set of each sequence in
 913    * dataset (that is not equal to sequenceI) Identifies matching DBRefEntry
 914    * based on source and accession string only - Map and Version are nulled.
 915    *
 916    * @param fromDna
 917    *          - true if context was searching from Dna sequences, false if
 918    *          context was searching from Protein sequences
 919    * @param sequenceI
 920    * @param lrfs
 921    * @param foundSeqs
 922    * @return true if matches were found.
 923    */
 924   private boolean searchDatasetXrefs(boolean fromDna, SequenceI sequenceI,
 925           DBRefEntry[] lrfs, List<SequenceI> foundSeqs, AlignedCodonFrame cf)
 926   {
 927     boolean found = false;
 928     if (lrfs == null)
 929     {
 930       return false;
 931     }
 932     for (int i = 0; i < lrfs.length; i++)
 933     {
 934       DBRefEntry xref = new DBRefEntry(lrfs[i]);
 935       // add in wildcards
 936       xref.setVersion(null);
 937       xref.setMap(null);
 938       found |= searchDataset(fromDna, sequenceI, xref, foundSeqs, cf, false);
 939     }
 940     return found;
 941   }
 942
 943   /**
 944    * Searches dataset for DBRefEntrys matching the given one (xrf) and adds the
 945    * associated sequence to rseqs
 946    *
 947    * @param fromDna
 948    *          true if context was searching for refs *from* dna sequence, false
 949    *          if context was searching for refs *from* protein sequence
 950    * @param fromSeq
 951    *          a sequence to ignore (start point of search)
 952    * @param xrf
 953    *          a cross-reference to try to match
 954    * @param foundSeqs
 955    *          result list to add to
 956    * @param mappings
 957    *          a set of sequence mappings to add to
 958    * @param direct
 959    *          - indicates the type of relationship between returned sequences,
 960    *          xrf, and sequenceI that is required.
 961    *          <ul>
 962    *          <li>direct implies xrf is a primary reference for sequenceI AND
 963    *          the sequences to be located (eg a uniprot ID for a protein
 964    *          sequence, and a uniprot ref on a transcript sequence).</li>
 965    *          <li>indirect means xrf is a cross reference with respect to
 966    *          sequenceI or all the returned sequences (eg a genomic reference
 967    *          associated with a locus and one or more transcripts)</li>
 968    *          </ul>
 969    * @return true if relationship found and sequence added.
 970    */
 971   boolean searchDataset(boolean fromDna, SequenceI fromSeq, DBRefEntry xrf,
 972           List<SequenceI> foundSeqs, AlignedCodonFrame mappings,
 973           boolean direct)
 974   {
 975     boolean found = false;
 976     if (dataset == null)
 977     {
 978       return false;
 979     }
 980     if (dataset.getSequences() == null)
 981     {
 982       System.err.println("Empty dataset sequence set - NO VECTOR");
 983       return false;
 984     }
 985     List<SequenceI> ds;
 986     synchronized (ds = dataset.getSequences())
 987     {
 988       for (SequenceI nxt : ds)
 989       {
 990         if (nxt != null)
 991         {
 992           if (nxt.getDatasetSequence() != null)
 993           {
 994             System.err
 995                     .println("Implementation warning: CrossRef initialised with a dataset alignment with non-dataset sequences in it! ("
 996                             + nxt.getDisplayId(true)
 997                             + " has ds reference "
 998                             + nxt.getDatasetSequence().getDisplayId(true)
 999                             + ")");
1000           }
1001           if (nxt == fromSeq || nxt == fromSeq.getDatasetSequence())
1002           {
1003             continue;
1004           }
1005           /*
1006            * only look at same molecule type if 'direct', or
1007            * complementary type if !direct
1008            */
1009           {
1010             boolean isDna = !nxt.isProtein();
1011             if (direct ? (isDna != fromDna) : (isDna == fromDna))
1012             {
1013               // skip this sequence because it is wrong molecule type
1014               continue;
1015             }
1016           }
1017
1018           // look for direct or indirect references in common
1019           DBRefEntry[] poss = nxt.getDBRefs();
1020           List<DBRefEntry> cands = null;
1021
1022           // todo: indirect specifies we select either direct references to nxt
1023           // that match xrf which is indirect to sequenceI, or indirect
1024           // references to nxt that match xrf which is direct to sequenceI
1025           cands = DBRefUtils.searchRefs(poss, xrf);
1026           // else
1027           // {
1028           // poss = DBRefUtils.selectDbRefs(nxt.isProtein()!fromDna, poss);
1029           // cands = DBRefUtils.searchRefs(poss, xrf);
1030           // }
1031           if (!cands.isEmpty())
1032           {
1033             if (foundSeqs.contains(nxt))
1034             {
1035               continue;
1036             }
1037             found = true;
1038             foundSeqs.add(nxt);
1039             if (mappings != null && !direct)
1040             {
1041               /*
1042                * if the matched sequence has mapped dbrefs to
1043                * protein product / cdna, add equivalent mappings to
1044                * our source sequence
1045                */
1046               for (DBRefEntry candidate : cands)
1047               {
1048                 Mapping mapping = candidate.getMap();
1049                 if (mapping != null)
1050                 {
1051                   MapList map = mapping.getMap();
1052                   if (mapping.getTo() != null
1053                           && map.getFromRatio() != map.getToRatio())
1054                   {
1055                     /*
1056                      * add a mapping, as from dna to peptide sequence
1057                      */
1058                     if (map.getFromRatio() == 3)
1059                     {
1060                       mappings.addMap(nxt, fromSeq, map);
1061                     }
1062                     else
1063                     {
1064                       mappings.addMap(nxt, fromSeq, map.getInverse());
1065                     }
1066                   }
1067                 }
1068               }
1069             }
1070           }
1071         }
1072       }
1073     }
1074     return found;
1075   }
1076 }