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