src/jalview/datamodel/AlignedCodonFrame.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.datamodel;
  22
  23 import java.util.AbstractList;
  24 import java.util.ArrayList;
  25 import java.util.List;
  26
  27 import jalview.util.MapList;
  28 import jalview.util.MappingUtils;
  29
  30 /**
  31  * Stores mapping between the columns of a protein alignment and a DNA alignment
  32  * and a list of individual codon to amino acid mappings between sequences.
  33  */
  34 public class AlignedCodonFrame
  35 {
  36
  37   /*
  38    * Data bean to hold mappings from one sequence to another
  39    */
  40   public class SequenceToSequenceMapping
  41   {
  42     private SequenceI fromSeq;
  43
  44     private Mapping mapping;
  45
  46     SequenceToSequenceMapping(SequenceI from, Mapping map)
  47     {
  48       this.fromSeq = from;
  49       this.mapping = map;
  50     }
  51
  52     /**
  53      * Readable representation for debugging only, not guaranteed not to change
  54      */
  55     @Override
  56     public String toString()
  57     {
  58       return String.format("From %s %s", fromSeq.getName(),
  59               mapping.toString());
  60     }
  61
  62     /**
  63      * Returns a hashCode derived from the hashcodes of the mappings and fromSeq
  64      *
  65      * @see SequenceToSequenceMapping#hashCode()
  66      */
  67     @Override
  68     public int hashCode()
  69     {
  70       return (fromSeq == null ? 0 : fromSeq.hashCode() * 31)
  71               + mapping.hashCode();
  72     }
  73
  74     /**
  75      * Answers true if the objects hold the same mapping between the same two
  76      * sequences
  77      *
  78      * @see Mapping#equals
  79      */
  80     @Override
  81     public boolean equals(Object obj)
  82     {
  83       if (!(obj instanceof SequenceToSequenceMapping))
  84       {
  85         return false;
  86       }
  87       SequenceToSequenceMapping that = (SequenceToSequenceMapping) obj;
  88       if (this.mapping == null)
  89       {
  90         return that.mapping == null;
  91       }
  92       // TODO: can simplify by asserting fromSeq is a dataset sequence
  93       return (this.fromSeq == that.fromSeq
  94               || (this.fromSeq != null && that.fromSeq != null
  95                       && this.fromSeq.getDatasetSequence() != null
  96                       && this.fromSeq.getDatasetSequence() == that.fromSeq
  97                               .getDatasetSequence()))
  98               && this.mapping.equals(that.mapping);
  99     }
 100
 101     public SequenceI getFromSeq()
 102     {
 103       return fromSeq;
 104     }
 105
 106     public Mapping getMapping()
 107     {
 108       return mapping;
 109     }
 110
 111     /**
 112      * Returns true if the mapping covers the full length of the given sequence.
 113      * This allows us to distinguish the CDS that codes for a protein from
 114      * another overlapping CDS in the parent dna sequence.
 115      *
 116      * @param seq
 117      * @return
 118      */
 119     public boolean covers(SequenceI seq)
 120     {
 121       return covers(seq,false,false);
 122     }
 123     /**
 124      *
 125      * @param seq
 126      * @param localCover - when true - compare extent of seq's dataset sequence rather than the local extent
 127      * @param either - when true coverage is required for either seq or the mapped sequence
 128      * @return true if mapping covers full length of given sequence (or the other if either==true)
 129      */
 130     public boolean covers(SequenceI seq, boolean localCover,boolean either)
 131     {
 132       List<int[]> mappedRanges = null,otherRanges=null;
 133       MapList mapList = mapping.getMap();
 134       int mstart=seq.getStart(),mend=seq.getEnd(),ostart,oend;
 135               ;
 136       if (fromSeq == seq || fromSeq == seq.getDatasetSequence())
 137       {
 138         if (localCover && fromSeq !=seq)
 139         {
 140           mstart=fromSeq.getStart();
 141           mend=fromSeq.getEnd();
 142         }
 143         mappedRanges = mapList.getFromRanges();
 144         otherRanges=mapList.getToRanges();
 145         ostart=mapping.to.getStart();
 146         oend=mapping.to.getEnd();
 147       }
 148       else if (mapping.to == seq || mapping.to == seq.getDatasetSequence())
 149       {
 150         if (localCover && mapping.to !=seq)
 151         {
 152           mstart=mapping.to.getStart();
 153           mend=mapping.to.getEnd();
 154         }
 155         mappedRanges = mapList.getToRanges();
 156         otherRanges=mapList.getFromRanges();
 157         ostart=fromSeq.getStart();
 158         oend=fromSeq.getEnd();
 159       }
 160       else
 161       {
 162         return false;
 163       }
 164
 165       /*
 166        * check that each mapped range lies within the sequence range
 167        * (necessary for circular CDS - example EMBL:J03321:AAA91567)
 168        * and mapped length covers (at least) sequence length
 169        */
 170       int length = countRange(mappedRanges,mstart,mend);
 171
 172       if (length != -1)
 173       {
 174         // add 3 to mapped length to allow for a mapped stop codon
 175         if (length + 3 >= (mend - mstart + 1))
 176         {
 177           return true;
 178         }
 179       }
 180       if (either)
 181       {
 182         // also check coverage of the other range
 183         length = countRange(otherRanges, ostart, oend);
 184         if (length != -1)
 185         {
 186           if (length + 1 >= (oend - ostart + 1))
 187           {
 188             return true;
 189           }
 190         }
 191       }
 192       return false;
 193     }
 194     private int countRange(List<int[]> mappedRanges,int mstart,int mend)
 195     {
 196       int length=0;
 197       for (int[] range : mappedRanges)
 198       {
 199         int from = Math.min(range[0], range[1]);
 200         int to = Math.max(range[0], range[1]);
 201         if (from < mstart || to > mend)
 202         {
 203           return -1;
 204         }
 205         length += (to - from + 1);
 206       }
 207       return length;
 208     }
 209
 210     /**
 211      * Adds any regions mapped to or from position {@code pos} in sequence
 212      * {@code seq} to the given search results
 213      * Note: recommend first using the .covers(,true,true) to ensure mapping covers both sequences
 214      * @param seq
 215      * @param pos
 216      * @param sr
 217      */
 218     public void markMappedRegion(SequenceI seq, int pos, SearchResultsI sr)
 219     {
 220       int[] codon = null;
 221       SequenceI mappedSeq = null;
 222       SequenceI ds = seq.getDatasetSequence();
 223       if (ds == null)
 224       {
 225         ds = seq;
 226       }
 227
 228       if (this.fromSeq == seq || this.fromSeq == ds)
 229       {
 230         codon = this.mapping.map.locateInTo(pos, pos);
 231         mappedSeq = this.mapping.to;
 232       }
 233       else if (this.mapping.to == seq || this.mapping.to == ds)
 234       {
 235         codon = this.mapping.map.locateInFrom(pos, pos);
 236         mappedSeq = this.fromSeq;
 237       }
 238
 239       if (codon != null)
 240       {
 241         for (int i = 0; i < codon.length; i += 2)
 242         {
 243           sr.addResult(mappedSeq, codon[i], codon[i + 1]);
 244         }
 245       }
 246     }
 247   }
 248
 249   private List<SequenceToSequenceMapping> mappings;
 250
 251   /**
 252    * Constructor
 253    */
 254   public AlignedCodonFrame()
 255   {
 256     mappings = new ArrayList<>();
 257   }
 258
 259   /**
 260    * Adds a mapping between the dataset sequences for the associated dna and
 261    * protein sequence objects
 262    *
 263    * @param dnaseq
 264    * @param aaseq
 265    * @param map
 266    */
 267   public void addMap(SequenceI dnaseq, SequenceI aaseq, MapList map)
 268   {
 269     addMap(dnaseq, aaseq, map, null);
 270   }
 271
 272   /**
 273    * Adds a mapping between the dataset sequences for the associated dna and
 274    * protein sequence objects
 275    *
 276    * @param dnaseq
 277    * @param aaseq
 278    * @param map
 279    * @param mapFromId
 280    */
 281   public void addMap(SequenceI dnaseq, SequenceI aaseq, MapList map,
 282           String mapFromId)
 283   {
 284     // JBPNote DEBUG! THIS !
 285     // dnaseq.transferAnnotation(aaseq, mp);
 286     // aaseq.transferAnnotation(dnaseq, new Mapping(map.getInverse()));
 287
 288     SequenceI fromSeq = (dnaseq.getDatasetSequence() == null) ? dnaseq
 289             : dnaseq.getDatasetSequence();
 290     SequenceI toSeq = (aaseq.getDatasetSequence() == null) ? aaseq
 291             : aaseq.getDatasetSequence();
 292
 293     /*
 294      * if we already hold a mapping between these sequences, just add to it
 295      * note that 'adding' a duplicate map does nothing; this protects against
 296      * creating duplicate mappings in AlignedCodonFrame
 297      */
 298     for (SequenceToSequenceMapping ssm : mappings)
 299     {
 300       if (ssm.fromSeq == fromSeq && ssm.mapping.to == toSeq)
 301       {
 302         ssm.mapping.map.addMapList(map);
 303         return;
 304       }
 305     }
 306
 307     /*
 308      * otherwise, add a new sequence mapping
 309      */
 310     Mapping mp = new Mapping(toSeq, map);
 311     mp.setMappedFromId(mapFromId);
 312     mappings.add(new SequenceToSequenceMapping(fromSeq, mp));
 313   }
 314
 315   public SequenceI[] getdnaSeqs()
 316   {
 317     // TODO return a list instead?
 318     // return dnaSeqs;
 319     List<SequenceI> seqs = new ArrayList<>();
 320     for (SequenceToSequenceMapping ssm : mappings)
 321     {
 322       seqs.add(ssm.fromSeq);
 323     }
 324     return seqs.toArray(new SequenceI[seqs.size()]);
 325   }
 326
 327   public SequenceI[] getAaSeqs()
 328   {
 329     // TODO not used - remove?
 330     List<SequenceI> seqs = new ArrayList<>();
 331     for (SequenceToSequenceMapping ssm : mappings)
 332     {
 333       seqs.add(ssm.mapping.to);
 334     }
 335     return seqs.toArray(new SequenceI[seqs.size()]);
 336   }
 337
 338   public MapList[] getdnaToProt()
 339   {
 340     List<MapList> maps = new ArrayList<>();
 341     for (SequenceToSequenceMapping ssm : mappings)
 342     {
 343       maps.add(ssm.mapping.map);
 344     }
 345     return maps.toArray(new MapList[maps.size()]);
 346   }
 347
 348   public Mapping[] getProtMappings()
 349   {
 350     List<Mapping> maps = new ArrayList<>();
 351     for (SequenceToSequenceMapping ssm : mappings)
 352     {
 353       maps.add(ssm.mapping);
 354     }
 355     return maps.toArray(new Mapping[maps.size()]);
 356   }
 357
 358   /**
 359    * Returns the first mapping found which is to or from the given sequence, or
 360    * null if none is found
 361    *
 362    * @param seq
 363    * @return
 364    */
 365   public Mapping getMappingForSequence(SequenceI seq)
 366   {
 367     SequenceI seqDs = seq.getDatasetSequence();
 368     seqDs = seqDs != null ? seqDs : seq;
 369
 370     for (SequenceToSequenceMapping ssm : mappings)
 371     {
 372       if (ssm.fromSeq == seqDs || ssm.mapping.to == seqDs)
 373       {
 374         return ssm.mapping;
 375       }
 376     }
 377     return null;
 378   }
 379
 380   /**
 381    * Return the corresponding aligned or dataset aa sequence for given dna
 382    * sequence, null if not found.
 383    *
 384    * @param sequenceRef
 385    * @return
 386    */
 387   public SequenceI getAaForDnaSeq(SequenceI dnaSeqRef)
 388   {
 389     SequenceI dnads = dnaSeqRef.getDatasetSequence();
 390     for (SequenceToSequenceMapping ssm : mappings)
 391     {
 392       if (ssm.fromSeq == dnaSeqRef || ssm.fromSeq == dnads)
 393       {
 394         return ssm.mapping.to;
 395       }
 396     }
 397     return null;
 398   }
 399
 400   /**
 401    * Return the corresponding aligned or dataset dna sequence for given amino
 402    * acid sequence, or null if not found. returns the sequence from the first
 403    * mapping found that involves the protein sequence.
 404    *
 405    * @param aaSeqRef
 406    * @return
 407    */
 408   public SequenceI getDnaForAaSeq(SequenceI aaSeqRef)
 409   {
 410     SequenceI aads = aaSeqRef.getDatasetSequence();
 411     for (SequenceToSequenceMapping ssm : mappings)
 412     {
 413       if (ssm.mapping.to == aaSeqRef || ssm.mapping.to == aads)
 414       {
 415         return ssm.fromSeq;
 416       }
 417     }
 418     return null;
 419   }
 420
 421   /**
 422    * test to see if codon frame involves seq in any way
 423    *
 424    * @param seq
 425    *          a nucleotide or protein sequence
 426    * @return true if a mapping exists to or from this sequence to any translated
 427    *         sequence
 428    */
 429   public boolean involvesSequence(SequenceI seq)
 430   {
 431     return getAaForDnaSeq(seq) != null || getDnaForAaSeq(seq) != null;
 432   }
 433
 434   /**
 435    * Add search results for regions in other sequences that translate or are
 436    * translated from a particular position in seq (which may be an aligned or
 437    * dataset sequence)
 438    *
 439    * @param seq
 440    * @param index
 441    *          position in seq
 442    * @param results
 443    *          where highlighted regions go
 444    */
 445   public void markMappedRegion(SequenceI seq, int index,
 446           SearchResultsI results)
 447   {
 448     SequenceI ds = seq.getDatasetSequence();
 449     if (ds == null)
 450     {
 451       ds = seq;
 452     }
 453     for (SequenceToSequenceMapping ssm : mappings)
 454     {
 455       if (ssm.covers(seq,true,true)) {
 456         ssm.markMappedRegion(ds, index, results);
 457       }
 458     }
 459   }
 460
 461   /**
 462    * Convenience method to return the first aligned sequence in the given
 463    * alignment whose dataset has a mapping with the given (aligned or dataset)
 464    * sequence.
 465    *
 466    * @param seq
 467    *
 468    * @param al
 469    * @return
 470    */
 471   public SequenceI findAlignedSequence(SequenceI seq, AlignmentI al)
 472   {
 473     /*
 474      * Search mapped protein ('to') sequences first.
 475      */
 476     for (SequenceToSequenceMapping ssm : mappings)
 477     {
 478       if (ssm.fromSeq == seq || ssm.fromSeq == seq.getDatasetSequence())
 479       {
 480         for (SequenceI sourceAligned : al.getSequences())
 481         {
 482           if (ssm.mapping.to == sourceAligned.getDatasetSequence()
 483                   || ssm.mapping.to == sourceAligned)
 484           {
 485             return sourceAligned;
 486           }
 487         }
 488       }
 489     }
 490
 491     /*
 492      * Then try mapped dna sequences.
 493      */
 494     for (SequenceToSequenceMapping ssm : mappings)
 495     {
 496       if (ssm.mapping.to == seq
 497               || ssm.mapping.to == seq.getDatasetSequence())
 498       {
 499         for (SequenceI sourceAligned : al.getSequences())
 500         {
 501           if (ssm.fromSeq == sourceAligned.getDatasetSequence())
 502           {
 503             return sourceAligned;
 504           }
 505         }
 506       }
 507     }
 508
 509     return null;
 510   }
 511
 512   /**
 513    * Returns the region in the target sequence's dataset that is mapped to the
 514    * given position (base 1) in the query sequence's dataset. The region is a
 515    * set of start/end position pairs.
 516    *
 517    * @param target
 518    * @param query
 519    * @param queryPos
 520    * @return
 521    */
 522   public int[] getMappedRegion(SequenceI target, SequenceI query,
 523           int queryPos)
 524   {
 525     SequenceI targetDs = target.getDatasetSequence() == null ? target
 526             : target.getDatasetSequence();
 527     SequenceI queryDs = query.getDatasetSequence() == null ? query
 528             : query.getDatasetSequence();
 529     if (targetDs == null || queryDs == null /*|| dnaToProt == null*/)
 530     {
 531       return null;
 532     }
 533     for (SequenceToSequenceMapping ssm : mappings)
 534     {
 535       /*
 536        * try mapping from target to query
 537        */
 538       if (ssm.fromSeq == targetDs && ssm.mapping.to == queryDs)
 539       {
 540         int[] codon = ssm.mapping.map.locateInFrom(queryPos, queryPos);
 541         if (codon != null)
 542         {
 543           return codon;
 544         }
 545       }
 546       /*
 547        * else try mapping from query to target
 548        */
 549       else if (ssm.fromSeq == queryDs && ssm.mapping.to == targetDs)
 550       {
 551         int[] codon = ssm.mapping.map.locateInTo(queryPos, queryPos);
 552         if (codon != null)
 553         {
 554           return codon;
 555         }
 556       }
 557     }
 558     return null;
 559   }
 560
 561   /**
 562    * Returns the mapped DNA codons for the given position in a protein sequence,
 563    * or null if no mapping is found. Returns a list of (e.g.) ['g', 'c', 't']
 564    * codons. There may be more than one codon mapped to the protein if (for
 565    * example), there are mappings to cDNA variants.
 566    *
 567    * @param protein
 568    *          the peptide dataset sequence
 569    * @param aaPos
 570    *          residue position (base 1) in the peptide sequence
 571    * @return
 572    */
 573   public List<char[]> getMappedCodons(SequenceI protein, int aaPos)
 574   {
 575     MapList ml = null;
 576     SequenceI dnaSeq = null;
 577     List<char[]> result = new ArrayList<>();
 578
 579     for (SequenceToSequenceMapping ssm : mappings)
 580     {
 581       if (ssm.mapping.to == protein
 582               && ssm.mapping.getMap().getFromRatio() == 3)
 583       {
 584         ml = ssm.mapping.map;
 585         dnaSeq = ssm.fromSeq;
 586
 587         int[] codonPos = ml.locateInFrom(aaPos, aaPos);
 588         if (codonPos == null)
 589         {
 590           return null;
 591         }
 592
 593         /*
 594          * Read off the mapped nucleotides (converting to position base 0)
 595          */
 596         codonPos = MappingUtils.flattenRanges(codonPos);
 597         int start = dnaSeq.getStart();
 598         char c1 = dnaSeq.getCharAt(codonPos[0] - start);
 599         char c2 = dnaSeq.getCharAt(codonPos[1] - start);
 600         char c3 = dnaSeq.getCharAt(codonPos[2] - start);
 601         result.add(new char[] { c1, c2, c3 });
 602       }
 603     }
 604     return result.isEmpty() ? null : result;
 605   }
 606
 607   /**
 608    * Returns any mappings found which are from the given sequence, and to
 609    * distinct sequences.
 610    *
 611    * @param seq
 612    * @return
 613    */
 614   public List<Mapping> getMappingsFromSequence(SequenceI seq)
 615   {
 616     List<Mapping> result = new ArrayList<>();
 617     List<SequenceI> related = new ArrayList<>();
 618     SequenceI seqDs = seq.getDatasetSequence();
 619     seqDs = seqDs != null ? seqDs : seq;
 620
 621     for (SequenceToSequenceMapping ssm : mappings)
 622     {
 623       final Mapping mapping = ssm.mapping;
 624       if (ssm.fromSeq == seqDs)
 625       {
 626         if (!related.contains(mapping.to))
 627         {
 628           result.add(mapping);
 629           related.add(mapping.to);
 630         }
 631       }
 632     }
 633     return result;
 634   }
 635
 636   /**
 637    * Test whether the given sequence is substitutable for one or more dummy
 638    * sequences in this mapping
 639    *
 640    * @param map
 641    * @param seq
 642    * @return
 643    */
 644   public boolean isRealisableWith(SequenceI seq)
 645   {
 646     return realiseWith(seq, false) > 0;
 647   }
 648
 649   /**
 650    * Replace any matchable mapped dummy sequences with the given real one.
 651    * Returns the count of sequence mappings instantiated.
 652    *
 653    * @param seq
 654    * @return
 655    */
 656   public int realiseWith(SequenceI seq)
 657   {
 658     return realiseWith(seq, true);
 659   }
 660
 661   /**
 662    * Returns the number of mapped dummy sequences that could be replaced with
 663    * the given real sequence.
 664    *
 665    * @param seq
 666    *          a dataset sequence
 667    * @param doUpdate
 668    *          if true, performs replacements, else only counts
 669    * @return
 670    */
 671   protected int realiseWith(SequenceI seq, boolean doUpdate)
 672   {
 673     SequenceI ds = seq.getDatasetSequence() != null
 674             ? seq.getDatasetSequence()
 675             : seq;
 676     int count = 0;
 677
 678     /*
 679      * check for replaceable DNA ('map from') sequences
 680      */
 681     for (SequenceToSequenceMapping ssm : mappings)
 682     {
 683       SequenceI dna = ssm.fromSeq;
 684       if (dna instanceof SequenceDummy
 685               && dna.getName().equals(ds.getName()))
 686       {
 687         Mapping mapping = ssm.mapping;
 688         int mapStart = mapping.getMap().getFromLowest();
 689         int mapEnd = mapping.getMap().getFromHighest();
 690         boolean mappable = couldRealiseSequence(dna, ds, mapStart, mapEnd);
 691         if (mappable)
 692         {
 693           count++;
 694           if (doUpdate)
 695           {
 696             // TODO: new method ? ds.realise(dna);
 697             // might want to copy database refs as well
 698             ds.setSequenceFeatures(dna.getSequenceFeatures());
 699             // dnaSeqs[i] = ds;
 700             ssm.fromSeq = ds;
 701             System.out.println("Realised mapped sequence " + ds.getName());
 702           }
 703         }
 704       }
 705
 706       /*
 707        * check for replaceable protein ('map to') sequences
 708        */
 709       Mapping mapping = ssm.mapping;
 710       SequenceI prot = mapping.getTo();
 711       int mapStart = mapping.getMap().getToLowest();
 712       int mapEnd = mapping.getMap().getToHighest();
 713       boolean mappable = couldRealiseSequence(prot, ds, mapStart, mapEnd);
 714       if (mappable)
 715       {
 716         count++;
 717         if (doUpdate)
 718         {
 719           // TODO: new method ? ds.realise(dna);
 720           // might want to copy database refs as well
 721           ds.setSequenceFeatures(dna.getSequenceFeatures());
 722           ssm.mapping.setTo(ds);
 723         }
 724       }
 725     }
 726     return count;
 727   }
 728
 729   /**
 730    * Helper method to test whether a 'real' sequence could replace a 'dummy'
 731    * sequence in the map. The criteria are that they have the same name, and
 732    * that the mapped region overlaps the candidate sequence.
 733    *
 734    * @param existing
 735    * @param replacement
 736    * @param mapStart
 737    * @param mapEnd
 738    * @return
 739    */
 740   protected static boolean couldRealiseSequence(SequenceI existing,
 741           SequenceI replacement, int mapStart, int mapEnd)
 742   {
 743     if (existing instanceof SequenceDummy
 744             && !(replacement instanceof SequenceDummy)
 745             && existing.getName().equals(replacement.getName()))
 746     {
 747       int start = replacement.getStart();
 748       int end = replacement.getEnd();
 749       boolean mappingOverlapsSequence = (mapStart >= start
 750               && mapStart <= end) || (mapEnd >= start && mapEnd <= end);
 751       if (mappingOverlapsSequence)
 752       {
 753         return true;
 754       }
 755     }
 756     return false;
 757   }
 758
 759   /**
 760    * Change any mapping to the given sequence to be to its dataset sequence
 761    * instead. For use when mappings are created before their referenced
 762    * sequences are instantiated, for example when parsing GFF data.
 763    *
 764    * @param seq
 765    */
 766   public void updateToDataset(SequenceI seq)
 767   {
 768     if (seq == null || seq.getDatasetSequence() == null)
 769     {
 770       return;
 771     }
 772     SequenceI ds = seq.getDatasetSequence();
 773
 774     for (SequenceToSequenceMapping ssm : mappings)
 775     /*
 776      * 'from' sequences
 777      */
 778     {
 779       if (ssm.fromSeq == seq)
 780       {
 781         ssm.fromSeq = ds;
 782       }
 783
 784       /*
 785        * 'to' sequences
 786        */
 787       if (ssm.mapping.to == seq)
 788       {
 789         ssm.mapping.to = ds;
 790       }
 791     }
 792   }
 793
 794   /**
 795    * Answers true if this object contains no mappings
 796    *
 797    * @return
 798    */
 799   public boolean isEmpty()
 800   {
 801     return mappings.isEmpty();
 802   }
 803
 804   /**
 805    * Method for debug / inspection purposes only, may change in future
 806    */
 807   @Override
 808   public String toString()
 809   {
 810     return mappings == null ? "null" : mappings.toString();
 811   }
 812
 813   /**
 814    * Returns the first mapping found that is between 'fromSeq' and 'toSeq', or
 815    * null if none found
 816    *
 817    * @param fromSeq
 818    *          aligned or dataset sequence
 819    * @param toSeq
 820    *          aligned or dataset sequence
 821    * @return
 822    */
 823   public Mapping getMappingBetween(SequenceI fromSeq, SequenceI toSeq)
 824   {
 825     SequenceI dssFrom = fromSeq.getDatasetSequence() == null ? fromSeq
 826             : fromSeq.getDatasetSequence();
 827     SequenceI dssTo = toSeq.getDatasetSequence() == null ? toSeq
 828             : toSeq.getDatasetSequence();
 829
 830     for (SequenceToSequenceMapping mapping : mappings)
 831     {
 832       SequenceI from = mapping.fromSeq;
 833       SequenceI to = mapping.mapping.to;
 834       if ((from == dssFrom && to == dssTo)
 835               || (from == dssTo && to == dssFrom))
 836       {
 837         return mapping.mapping;
 838       }
 839     }
 840     return null;
 841   }
 842
 843   /**
 844    * Returns a hashcode derived from the list of sequence mappings
 845    *
 846    * @see SequenceToSequenceMapping#hashCode()
 847    * @see AbstractList#hashCode()
 848    */
 849   @Override
 850   public int hashCode()
 851   {
 852     return this.mappings.hashCode();
 853   }
 854
 855   /**
 856    * Two AlignedCodonFrame objects are equal if they hold the same ordered list
 857    * of mappings
 858    *
 859    * @see SequenceToSequenceMapping#equals
 860    */
 861   @Override
 862   public boolean equals(Object obj)
 863   {
 864     if (!(obj instanceof AlignedCodonFrame))
 865     {
 866       return false;
 867     }
 868     return this.mappings.equals(((AlignedCodonFrame) obj).mappings);
 869   }
 870
 871   public List<SequenceToSequenceMapping> getMappings()
 872   {
 873     return mappings;
 874   }
 875
 876   /**
 877    * Returns the first mapping found which is between the two given sequences,
 878    * and covers the full extent of both.
 879    *
 880    * @param seq1
 881    * @param seq2
 882    * @return
 883    */
 884   public SequenceToSequenceMapping getCoveringMapping(SequenceI seq1,
 885           SequenceI seq2)
 886   {
 887     for (SequenceToSequenceMapping mapping : mappings)
 888     {
 889       if (mapping.covers(seq2) && mapping.covers(seq1))
 890       {
 891         return mapping;
 892       }
 893     }
 894     return null;
 895   }
 896
 897   /**
 898    * Returns the first mapping found which is between the given dataset sequence
 899    * and another, is a triplet mapping (3:1 or 1:3), and covers the full extent
 900    * of both sequences involved
 901    *
 902    * @param seq
 903    * @return
 904    */
 905   public SequenceToSequenceMapping getCoveringCodonMapping(SequenceI seq)
 906   {
 907     for (SequenceToSequenceMapping mapping : mappings)
 908     {
 909       if (mapping.getMapping().getMap().isTripletMap()
 910               && mapping.covers(seq))
 911       {
 912         if (mapping.fromSeq == seq
 913                 && mapping.covers(mapping.getMapping().getTo()))
 914         {
 915           return mapping;
 916         }
 917         else if (mapping.getMapping().getTo() == seq
 918                 && mapping.covers(mapping.fromSeq))
 919         {
 920           return mapping;
 921         }
 922       }
 923     }
 924     return null;
 925   }
 926 }