src/jalview/datamodel/AlignedCodonFrame.java

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