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