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