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
 387    *
 388    * @param seq
 389    * @param index
 390    *          position in seq
 391    * @param results
 392    *          where highlighted regions go
 393    */
 394   public void markMappedRegion(SequenceI seq, int index,
 395           SearchResultsI results)
 396   {
 397     SequenceI ds = seq.getDatasetSequence();
 398     for (SequenceToSequenceMapping ssm : mappings)
 399     {
 400       ssm.markMappedRegion(ds, index, results);
 401     }
 402   }
 403
 404   /**
 405    * Convenience method to return the first aligned sequence in the given
 406    * alignment whose dataset has a mapping with the given (aligned or dataset)
 407    * sequence.
 408    *
 409    * @param seq
 410    *
 411    * @param al
 412    * @return
 413    */
 414   public SequenceI findAlignedSequence(SequenceI seq, AlignmentI al)
 415   {
 416     /*
 417      * Search mapped protein ('to') sequences first.
 418      */
 419     for (SequenceToSequenceMapping ssm : mappings)
 420     {
 421       if (ssm.fromSeq == seq || ssm.fromSeq == seq.getDatasetSequence())
 422       {
 423         for (SequenceI sourceAligned : al.getSequences())
 424         {
 425           if (ssm.mapping.to == sourceAligned.getDatasetSequence()
 426                   || ssm.mapping.to == sourceAligned)
 427           {
 428             return sourceAligned;
 429           }
 430         }
 431       }
 432     }
 433
 434     /*
 435      * Then try mapped dna sequences.
 436      */
 437     for (SequenceToSequenceMapping ssm : mappings)
 438     {
 439       if (ssm.mapping.to == seq
 440               || ssm.mapping.to == seq.getDatasetSequence())
 441       {
 442         for (SequenceI sourceAligned : al.getSequences())
 443         {
 444           if (ssm.fromSeq == sourceAligned.getDatasetSequence())
 445           {
 446             return sourceAligned;
 447           }
 448         }
 449       }
 450     }
 451
 452     return null;
 453   }
 454
 455   /**
 456    * Returns the region in the target sequence's dataset that is mapped to the
 457    * given position (base 1) in the query sequence's dataset. The region is a
 458    * set of start/end position pairs.
 459    *
 460    * @param target
 461    * @param query
 462    * @param queryPos
 463    * @return
 464    */
 465   public int[] getMappedRegion(SequenceI target, SequenceI query,
 466           int queryPos)
 467   {
 468     SequenceI targetDs = target.getDatasetSequence() == null ? target
 469             : target.getDatasetSequence();
 470     SequenceI queryDs = query.getDatasetSequence() == null ? query
 471             : query.getDatasetSequence();
 472     if (targetDs == null || queryDs == null /*|| dnaToProt == null*/)
 473     {
 474       return null;
 475     }
 476     for (SequenceToSequenceMapping ssm : mappings)
 477     {
 478       /*
 479        * try mapping from target to query
 480        */
 481       if (ssm.fromSeq == targetDs && ssm.mapping.to == queryDs)
 482       {
 483         int[] codon = ssm.mapping.map.locateInFrom(queryPos, queryPos);
 484         if (codon != null)
 485         {
 486           return codon;
 487         }
 488       }
 489       /*
 490        * else try mapping from query to target
 491        */
 492       else if (ssm.fromSeq == queryDs && ssm.mapping.to == targetDs)
 493       {
 494         int[] codon = ssm.mapping.map.locateInTo(queryPos, queryPos);
 495         if (codon != null)
 496         {
 497           return codon;
 498         }
 499       }
 500     }
 501     return null;
 502   }
 503
 504   /**
 505    * Returns the mapped DNA codons for the given position in a protein sequence,
 506    * or null if no mapping is found. Returns a list of (e.g.) ['g', 'c', 't']
 507    * codons. There may be more than one codon mapped to the protein if (for
 508    * example), there are mappings to cDNA variants.
 509    *
 510    * @param protein
 511    *          the peptide dataset sequence
 512    * @param aaPos
 513    *          residue position (base 1) in the peptide sequence
 514    * @return
 515    */
 516   public List<char[]> getMappedCodons(SequenceI protein, int aaPos)
 517   {
 518     MapList ml = null;
 519     SequenceI dnaSeq = null;
 520     List<char[]> result = new ArrayList<>();
 521
 522     for (SequenceToSequenceMapping ssm : mappings)
 523     {
 524       if (ssm.mapping.to == protein
 525               && ssm.mapping.getMap().getFromRatio() == 3)
 526       {
 527         ml = ssm.mapping.map;
 528         dnaSeq = ssm.fromSeq;
 529
 530         int[] codonPos = ml.locateInFrom(aaPos, aaPos);
 531         if (codonPos == null)
 532         {
 533           return null;
 534         }
 535
 536         /*
 537          * Read off the mapped nucleotides (converting to position base 0)
 538          */
 539         codonPos = MappingUtils.flattenRanges(codonPos);
 540         int start = dnaSeq.getStart();
 541         char c1 = dnaSeq.getCharAt(codonPos[0] - start);
 542         char c2 = dnaSeq.getCharAt(codonPos[1] - start);
 543         char c3 = dnaSeq.getCharAt(codonPos[2] - start);
 544         result.add(new char[] { c1, c2, c3 });
 545       }
 546     }
 547     return result.isEmpty() ? null : result;
 548   }
 549
 550   /**
 551    * Returns any mappings found which are from the given sequence, and to
 552    * distinct sequences.
 553    *
 554    * @param seq
 555    * @return
 556    */
 557   public List<Mapping> getMappingsFromSequence(SequenceI seq)
 558   {
 559     List<Mapping> result = new ArrayList<>();
 560     List<SequenceI> related = new ArrayList<>();
 561     SequenceI seqDs = seq.getDatasetSequence();
 562     seqDs = seqDs != null ? seqDs : seq;
 563
 564     for (SequenceToSequenceMapping ssm : mappings)
 565     {
 566       final Mapping mapping = ssm.mapping;
 567       if (ssm.fromSeq == seqDs)
 568       {
 569         if (!related.contains(mapping.to))
 570         {
 571           result.add(mapping);
 572           related.add(mapping.to);
 573         }
 574       }
 575     }
 576     return result;
 577   }
 578
 579   /**
 580    * Test whether the given sequence is substitutable for one or more dummy
 581    * sequences in this mapping
 582    *
 583    * @param map
 584    * @param seq
 585    * @return
 586    */
 587   public boolean isRealisableWith(SequenceI seq)
 588   {
 589     return realiseWith(seq, false) > 0;
 590   }
 591
 592   /**
 593    * Replace any matchable mapped dummy sequences with the given real one.
 594    * Returns the count of sequence mappings instantiated.
 595    *
 596    * @param seq
 597    * @return
 598    */
 599   public int realiseWith(SequenceI seq)
 600   {
 601     return realiseWith(seq, true);
 602   }
 603
 604   /**
 605    * Returns the number of mapped dummy sequences that could be replaced with
 606    * the given real sequence.
 607    *
 608    * @param seq
 609    *          a dataset sequence
 610    * @param doUpdate
 611    *          if true, performs replacements, else only counts
 612    * @return
 613    */
 614   protected int realiseWith(SequenceI seq, boolean doUpdate)
 615   {
 616     SequenceI ds = seq.getDatasetSequence() != null
 617             ? seq.getDatasetSequence()
 618             : seq;
 619     int count = 0;
 620
 621     /*
 622      * check for replaceable DNA ('map from') sequences
 623      */
 624     for (SequenceToSequenceMapping ssm : mappings)
 625     {
 626       SequenceI dna = ssm.fromSeq;
 627       if (dna instanceof SequenceDummy
 628               && dna.getName().equals(ds.getName()))
 629       {
 630         Mapping mapping = ssm.mapping;
 631         int mapStart = mapping.getMap().getFromLowest();
 632         int mapEnd = mapping.getMap().getFromHighest();
 633         boolean mappable = couldRealiseSequence(dna, ds, mapStart, mapEnd);
 634         if (mappable)
 635         {
 636           count++;
 637           if (doUpdate)
 638           {
 639             // TODO: new method ? ds.realise(dna);
 640             // might want to copy database refs as well
 641             ds.setSequenceFeatures(dna.getSequenceFeatures());
 642             // dnaSeqs[i] = ds;
 643             ssm.fromSeq = ds;
 644             System.out.println("Realised mapped sequence " + ds.getName());
 645           }
 646         }
 647       }
 648
 649       /*
 650        * check for replaceable protein ('map to') sequences
 651        */
 652       Mapping mapping = ssm.mapping;
 653       SequenceI prot = mapping.getTo();
 654       int mapStart = mapping.getMap().getToLowest();
 655       int mapEnd = mapping.getMap().getToHighest();
 656       boolean mappable = couldRealiseSequence(prot, ds, mapStart, mapEnd);
 657       if (mappable)
 658       {
 659         count++;
 660         if (doUpdate)
 661         {
 662           // TODO: new method ? ds.realise(dna);
 663           // might want to copy database refs as well
 664           ds.setSequenceFeatures(dna.getSequenceFeatures());
 665           ssm.mapping.setTo(ds);
 666         }
 667       }
 668     }
 669     return count;
 670   }
 671
 672   /**
 673    * Helper method to test whether a 'real' sequence could replace a 'dummy'
 674    * sequence in the map. The criteria are that they have the same name, and
 675    * that the mapped region overlaps the candidate sequence.
 676    *
 677    * @param existing
 678    * @param replacement
 679    * @param mapStart
 680    * @param mapEnd
 681    * @return
 682    */
 683   protected static boolean couldRealiseSequence(SequenceI existing,
 684           SequenceI replacement, int mapStart, int mapEnd)
 685   {
 686     if (existing instanceof SequenceDummy
 687             && !(replacement instanceof SequenceDummy)
 688             && existing.getName().equals(replacement.getName()))
 689     {
 690       int start = replacement.getStart();
 691       int end = replacement.getEnd();
 692       boolean mappingOverlapsSequence = (mapStart >= start
 693               && mapStart <= end) || (mapEnd >= start && mapEnd <= end);
 694       if (mappingOverlapsSequence)
 695       {
 696         return true;
 697       }
 698     }
 699     return false;
 700   }
 701
 702   /**
 703    * Change any mapping to the given sequence to be to its dataset sequence
 704    * instead. For use when mappings are created before their referenced
 705    * sequences are instantiated, for example when parsing GFF data.
 706    *
 707    * @param seq
 708    */
 709   public void updateToDataset(SequenceI seq)
 710   {
 711     if (seq == null || seq.getDatasetSequence() == null)
 712     {
 713       return;
 714     }
 715     SequenceI ds = seq.getDatasetSequence();
 716
 717     for (SequenceToSequenceMapping ssm : mappings)
 718     /*
 719      * 'from' sequences
 720      */
 721     {
 722       if (ssm.fromSeq == seq)
 723       {
 724         ssm.fromSeq = ds;
 725       }
 726
 727       /*
 728        * 'to' sequences
 729        */
 730       if (ssm.mapping.to == seq)
 731       {
 732         ssm.mapping.to = ds;
 733       }
 734     }
 735   }
 736
 737   /**
 738    * Answers true if this object contains no mappings
 739    *
 740    * @return
 741    */
 742   public boolean isEmpty()
 743   {
 744     return mappings.isEmpty();
 745   }
 746
 747   /**
 748    * Method for debug / inspection purposes only, may change in future
 749    */
 750   @Override
 751   public String toString()
 752   {
 753     return mappings == null ? "null" : mappings.toString();
 754   }
 755
 756   /**
 757    * Returns the first mapping found that is between 'fromSeq' and 'toSeq', or
 758    * null if none found
 759    *
 760    * @param fromSeq
 761    *          aligned or dataset sequence
 762    * @param toSeq
 763    *          aligned or dataset sequence
 764    * @return
 765    */
 766   public Mapping getMappingBetween(SequenceI fromSeq, SequenceI toSeq)
 767   {
 768     SequenceI dssFrom = fromSeq.getDatasetSequence() == null ? fromSeq
 769             : fromSeq.getDatasetSequence();
 770     SequenceI dssTo = toSeq.getDatasetSequence() == null ? toSeq
 771             : toSeq.getDatasetSequence();
 772
 773     for (SequenceToSequenceMapping mapping : mappings)
 774     {
 775       SequenceI from = mapping.fromSeq;
 776       SequenceI to = mapping.mapping.to;
 777       if ((from == dssFrom && to == dssTo)
 778               || (from == dssTo && to == dssFrom))
 779       {
 780         return mapping.mapping;
 781       }
 782     }
 783     return null;
 784   }
 785
 786   /**
 787    * Returns a hashcode derived from the list of sequence mappings
 788    *
 789    * @see SequenceToSequenceMapping#hashCode()
 790    * @see AbstractList#hashCode()
 791    */
 792   @Override
 793   public int hashCode()
 794   {
 795     return this.mappings.hashCode();
 796   }
 797
 798   /**
 799    * Two AlignedCodonFrame objects are equal if they hold the same ordered list
 800    * of mappings
 801    *
 802    * @see SequenceToSequenceMapping#equals
 803    */
 804   @Override
 805   public boolean equals(Object obj)
 806   {
 807     if (!(obj instanceof AlignedCodonFrame))
 808     {
 809       return false;
 810     }
 811     return this.mappings.equals(((AlignedCodonFrame) obj).mappings);
 812   }
 813
 814   public List<SequenceToSequenceMapping> getMappings()
 815   {
 816     return mappings;
 817   }
 818
 819   /**
 820    * Returns the first mapping found which is between the two given sequences,
 821    * and covers the full extent of both.
 822    *
 823    * @param seq1
 824    * @param seq2
 825    * @return
 826    */
 827   public SequenceToSequenceMapping getCoveringMapping(SequenceI seq1,
 828           SequenceI seq2)
 829   {
 830     for (SequenceToSequenceMapping mapping : mappings)
 831     {
 832       if (mapping.covers(seq2) && mapping.covers(seq1))
 833       {
 834         return mapping;
 835       }
 836     }
 837     return null;
 838   }
 839
 840   /**
 841    * Returns the first mapping found which is between the given sequence and
 842    * another, is a triplet mapping (3:1 or 1:3), and covers the full extent of
 843    * both sequences involved.
 844    *
 845    * @param seq
 846    * @return
 847    */
 848   public SequenceToSequenceMapping getCoveringCodonMapping(SequenceI seq)
 849   {
 850     for (SequenceToSequenceMapping mapping : mappings)
 851     {
 852       if (mapping.getMapping().getMap().isTripletMap()
 853               && mapping.covers(seq))
 854       {
 855         if (mapping.fromSeq == seq
 856                 && mapping.covers(mapping.getMapping().getTo()))
 857         {
 858           return mapping;
 859         }
 860         else if (mapping.getMapping().getTo() == seq
 861                 && mapping.covers(mapping.fromSeq))
 862         {
 863           return mapping;
 864         }
 865       }
 866     }
 867     return null;
 868   }
 869 }