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