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