JAL-2788 possible adjustments to sequence accesses
[jalview.git] / src / jalview / datamodel / Mapping.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.Comparison;
24 import jalview.util.MapList;
25
26 import java.util.Iterator;
27 import java.util.NoSuchElementException;
28 import java.util.Vector;
29
30 public class Mapping
31 {
32   /**
33    * An iterator that serves the aligned codon positions (with their protein
34    * products).
35    * 
36    * @author gmcarstairs
37    *
38    */
39   public class AlignedCodonIterator implements Iterator<AlignedCodon>
40   {
41     /*
42      * The gap character used in the aligned sequence
43      */
44     private final char gap;
45
46     /*
47      * The characters of the aligned sequence e.g. "-cGT-ACgTG-"
48      */
49     private final SequenceI alignedSeq;
50
51     /*
52      * the sequence start residue
53      */
54     private int start;
55
56     /*
57      * Next position (base 0) in the aligned sequence
58      */
59     private int alignedColumn = 0;
60
61     /*
62      * Count of bases up to and including alignedColumn position
63      */
64     private int alignedBases = 0;
65
66     /*
67      * [start, end] from ranges (base 1)
68      */
69     private Iterator<int[]> fromRanges;
70
71     /*
72      * [start, end] to ranges (base 1)
73      */
74     private Iterator<int[]> toRanges;
75
76     /*
77      * The current [start, end] (base 1) from range
78      */
79     private int[] currentFromRange = null;
80
81     /*
82      * The current [start, end] (base 1) to range
83      */
84     private int[] currentToRange = null;
85
86     /*
87      * The next 'from' position (base 1) to process
88      */
89     private int fromPosition = 0;
90
91     /*
92      * The next 'to' position (base 1) to process
93      */
94     private int toPosition = 0;
95
96     /**
97      * Constructor
98      * 
99      * @param seq
100      *          the aligned sequence
101      * @param gapChar
102      */
103     public AlignedCodonIterator(SequenceI seq, char gapChar)
104     {
105       this.alignedSeq = seq;
106       this.start = seq.getStart();
107       this.gap = gapChar;
108       fromRanges = map.getFromRanges().iterator();
109       toRanges = map.getToRanges().iterator();
110       if (fromRanges.hasNext())
111       {
112         currentFromRange = fromRanges.next();
113         fromPosition = currentFromRange[0];
114       }
115       if (toRanges.hasNext())
116       {
117         currentToRange = toRanges.next();
118         toPosition = currentToRange[0];
119       }
120     }
121
122     /**
123      * Returns true unless we have already traversed the whole mapping.
124      */
125     @Override
126     public boolean hasNext()
127     {
128       if (fromRanges.hasNext())
129       {
130         return true;
131       }
132       if (currentFromRange == null || fromPosition >= currentFromRange[1])
133       {
134         return false;
135       }
136       return true;
137     }
138
139     /**
140      * Returns the next codon's aligned positions, and translated value.
141      * 
142      * @throws NoSuchElementException
143      *           if hasNext() would have returned false
144      * @throws IncompleteCodonException
145      *           if not enough mapped bases are left to make up a codon
146      */
147     @Override
148     public AlignedCodon next() throws IncompleteCodonException
149     {
150       if (!hasNext())
151       {
152         throw new NoSuchElementException();
153       }
154
155       int[] codon = getNextCodon();
156       int[] alignedCodon = getAlignedCodon(codon);
157
158       String peptide = getPeptide();
159       int peptideCol = toPosition - 1 - Mapping.this.to.getStart();
160       return new AlignedCodon(alignedCodon[0], alignedCodon[1],
161               alignedCodon[2], peptide, peptideCol);
162     }
163
164     /**
165      * Retrieve the translation as the 'mapped to' position in the mapped to
166      * sequence.
167      * 
168      * @return
169      * @throws NoSuchElementException
170      *           if the 'toRange' is exhausted (nothing to map to)
171      */
172     private String getPeptide()
173     {
174       // TODO should ideally handle toRatio other than 1 as well...
175       // i.e. code like getNextCodon()
176       if (toPosition <= currentToRange[1])
177       {
178         SequenceI seq = Mapping.this.to;
179         char pep = seq.getCharAt(toPosition - seq.getStart());
180         toPosition++;
181         return String.valueOf(pep);
182       }
183       if (!toRanges.hasNext())
184       {
185         throw new NoSuchElementException(
186                 "Ran out of peptide at position " + toPosition);
187       }
188       currentToRange = toRanges.next();
189       toPosition = currentToRange[0];
190       return getPeptide();
191     }
192
193     /**
194      * Get the (base 1) dataset positions for the next codon in the mapping.
195      * 
196      * @throws IncompleteCodonException
197      *           if less than 3 remaining bases are mapped
198      */
199     private int[] getNextCodon()
200     {
201       int[] codon = new int[3];
202       int codonbase = 0;
203
204       while (codonbase < 3)
205       {
206         if (fromPosition <= currentFromRange[1])
207         {
208           /*
209            * Add next position from the current start-end range
210            */
211           codon[codonbase++] = fromPosition++;
212         }
213         else
214         {
215           /*
216            * Move to the next range - if there is one
217            */
218           if (!fromRanges.hasNext())
219           {
220             throw new IncompleteCodonException();
221           }
222           currentFromRange = fromRanges.next();
223           fromPosition = currentFromRange[0];
224         }
225       }
226       return codon;
227     }
228
229     /**
230      * Get the aligned column positions (base 0) for the given sequence
231      * positions (base 1), by counting ungapped characters in the aligned
232      * sequence.
233      * 
234      * @param codon
235      * @return
236      */
237     private int[] getAlignedCodon(int[] codon)
238     {
239       int[] aligned = new int[codon.length];
240       for (int i = 0; i < codon.length; i++)
241       {
242         aligned[i] = getAlignedColumn(codon[i]);
243       }
244       return aligned;
245     }
246
247     /**
248      * Get the aligned column position (base 0) for the given sequence position
249      * (base 1).
250      * 
251      * @param sequencePos
252      * @return
253      */
254     private int getAlignedColumn(int sequencePos)
255     {
256       /*
257        * allow for offset e.g. treat pos 8 as 2 if sequence starts at 7
258        */
259       int truePos = sequencePos - (start - 1);
260       int length = alignedSeq.getLength();
261       while (alignedBases < truePos && alignedColumn < length)
262       {
263         char c = alignedSeq.getCharAt(alignedColumn++);
264         if (c != gap && !Comparison.isGap(c))
265         {
266           alignedBases++;
267         }
268       }
269       return alignedColumn - 1;
270     }
271
272     @Override
273     public void remove()
274     {
275       // ignore
276     }
277
278   }
279
280   /*
281    * Contains the start-end pairs mapping from the associated sequence to the
282    * sequence in the database coordinate system. It also takes care of step
283    * difference between coordinate systems.
284    */
285   MapList map = null;
286
287   /*
288    * The sequence that map maps the associated sequence to (if any).
289    */
290   SequenceI to = null;
291
292   /*
293    * optional sequence id for the 'from' ranges
294    */
295   private String mappedFromId;
296
297   public Mapping(MapList map)
298   {
299     super();
300     this.map = map;
301   }
302
303   public Mapping(SequenceI to, MapList map)
304   {
305     this(map);
306     this.to = to;
307   }
308
309   /**
310    * create a new mapping from
311    * 
312    * @param to
313    *          the sequence being mapped
314    * @param exon
315    *          int[] {start,end,start,end} series on associated sequence
316    * @param is
317    *          int[] {start,end,...} ranges on the reference frame being mapped
318    *          to
319    * @param i
320    *          step size on associated sequence
321    * @param j
322    *          step size on mapped frame
323    */
324   public Mapping(SequenceI to, int[] exon, int[] is, int i, int j)
325   {
326     this(to, new MapList(exon, is, i, j));
327   }
328
329   /**
330    * create a duplicate (and independent) mapping object with the same reference
331    * to any SequenceI being mapped to.
332    * 
333    * @param map2
334    */
335   public Mapping(Mapping map2)
336   {
337     if (map2 != this && map2 != null)
338     {
339       if (map2.map != null)
340       {
341         map = new MapList(map2.map);
342       }
343       to = map2.to;
344       mappedFromId = map2.mappedFromId;
345     }
346   }
347
348   /**
349    * @return the map
350    */
351   public MapList getMap()
352   {
353     return map;
354   }
355
356   /**
357    * @param map
358    *          the map to set
359    */
360   public void setMap(MapList map)
361   {
362     this.map = map;
363   }
364
365   /**
366    * Equals that compares both the to references and MapList mappings.
367    * 
368    * @param o
369    * @return
370    * @see MapList#equals
371    */
372   @Override
373   public boolean equals(Object o)
374   {
375     if (o == null || !(o instanceof Mapping))
376     {
377       return false;
378     }
379     Mapping other = (Mapping) o;
380     if (other == this)
381     {
382       return true;
383     }
384     if (other.to != to)
385     {
386       return false;
387     }
388     if ((map != null && other.map == null)
389             || (map == null && other.map != null))
390     {
391       return false;
392     }
393     if ((map == null && other.map == null) || map.equals(other.map))
394     {
395       return true;
396     }
397     return false;
398   }
399
400   /**
401    * Returns a hashCode made from the sequence and maplist
402    */
403   @Override
404   public int hashCode()
405   {
406     int hashCode = (this.to == null ? 1 : this.to.hashCode());
407     if (this.map != null)
408     {
409       hashCode = hashCode * 31 + this.map.hashCode();
410     }
411
412     return hashCode;
413   }
414
415   /**
416    * get the 'initial' position in the associated sequence for a position in the
417    * mapped reference frame
418    * 
419    * @param mpos
420    * @return
421    */
422   public int getPosition(int mpos)
423   {
424     if (map != null)
425     {
426       int[] mp = map.shiftTo(mpos);
427       if (mp != null)
428       {
429         return mp[0];
430       }
431     }
432     return mpos;
433   }
434
435   /**
436    * gets boundary in direction of mapping
437    * 
438    * @param position
439    *          in mapped reference frame
440    * @return int{start, end} positions in associated sequence (in direction of
441    *         mapped word)
442    */
443   public int[] getWord(int mpos)
444   {
445     if (map != null)
446     {
447       return map.getToWord(mpos);
448     }
449     return null;
450   }
451
452   /**
453    * width of mapped unit in associated sequence
454    * 
455    */
456   public int getWidth()
457   {
458     if (map != null)
459     {
460       return map.getFromRatio();
461     }
462     return 1;
463   }
464
465   /**
466    * width of unit in mapped reference frame
467    * 
468    * @return
469    */
470   public int getMappedWidth()
471   {
472     if (map != null)
473     {
474       return map.getToRatio();
475     }
476     return 1;
477   }
478
479   /**
480    * get mapped position in the associated reference frame for position pos in
481    * the associated sequence.
482    * 
483    * @param pos
484    * @return
485    */
486   public int getMappedPosition(int pos)
487   {
488     if (map != null)
489     {
490       int[] mp = map.shiftFrom(pos);
491       if (mp != null)
492       {
493         return mp[0];
494       }
495     }
496     return pos;
497   }
498
499   public int[] getMappedWord(int pos)
500   {
501     if (map != null)
502     {
503       int[] mp = map.shiftFrom(pos);
504       if (mp != null)
505       {
506         return new int[] { mp[0], mp[0] + mp[2] * (map.getToRatio() - 1) };
507       }
508     }
509     return null;
510   }
511
512   /**
513    * locates the region of feature f in the associated sequence's reference
514    * frame
515    * 
516    * @param f
517    * @return one or more features corresponding to f
518    */
519   public SequenceFeature[] locateFeature(SequenceFeature f)
520   {
521     if (true)
522     { // f.getBegin()!=f.getEnd()) {
523       if (map != null)
524       {
525         int[] frange = map.locateInFrom(f.getBegin(), f.getEnd());
526         if (frange == null)
527         {
528           // JBPNote - this isprobably not the right thing to doJBPHack
529           return null;
530         }
531         SequenceFeature[] vf = new SequenceFeature[frange.length / 2];
532         for (int i = 0, v = 0; i < frange.length; i += 2, v++)
533         {
534           vf[v] = new SequenceFeature(f, frange[i], frange[i + 1],
535                   f.getFeatureGroup(), f.getScore());
536           if (frange.length > 2)
537           {
538             vf[v].setDescription(f.getDescription() + "\nPart " + (v + 1));
539           }
540         }
541         return vf;
542       }
543     }
544
545     // give up and just return the feature.
546     return new SequenceFeature[] { f };
547   }
548
549   /**
550    * return a series of contigs on the associated sequence corresponding to the
551    * from,to interval on the mapped reference frame
552    * 
553    * @param from
554    * @param to
555    * @return int[] { from_i, to_i for i=1 to n contiguous regions in the
556    *         associated sequence}
557    */
558   public int[] locateRange(int from, int to)
559   {
560     if (map != null)
561     {
562       if (from <= to)
563       {
564         from = (map.getToLowest() < from) ? from : map.getToLowest();
565         to = (map.getToHighest() > to) ? to : map.getToHighest();
566         if (from > to)
567         {
568           return null;
569         }
570       }
571       else
572       {
573         from = (map.getToHighest() > from) ? from : map.getToHighest();
574         to = (map.getToLowest() < to) ? to : map.getToLowest();
575         if (from < to)
576         {
577           return null;
578         }
579       }
580       return map.locateInFrom(from, to);
581     }
582     return new int[] { from, to };
583   }
584
585   /**
586    * return a series of mapped contigs mapped from a range on the associated
587    * sequence
588    * 
589    * @param from
590    * @param to
591    * @return
592    */
593   public int[] locateMappedRange(int from, int to)
594   {
595     if (map != null)
596     {
597
598       if (from <= to)
599       {
600         from = (map.getFromLowest() < from) ? from : map.getFromLowest();
601         to = (map.getFromHighest() > to) ? to : map.getFromHighest();
602         if (from > to)
603         {
604           return null;
605         }
606       }
607       else
608       {
609         from = (map.getFromHighest() > from) ? from : map.getFromHighest();
610         to = (map.getFromLowest() < to) ? to : map.getFromLowest();
611         if (from < to)
612         {
613           return null;
614         }
615       }
616       return map.locateInTo(from, to);
617     }
618     return new int[] { from, to };
619   }
620
621   /**
622    * return a new mapping object with a maplist modifed to only map the visible
623    * regions defined by viscontigs.
624    * 
625    * @param viscontigs
626    * @return
627    */
628   public Mapping intersectVisContigs(int[] viscontigs)
629   {
630     Mapping copy = new Mapping(this);
631     if (map != null)
632     {
633       int vpos = 0;
634       int apos = 0;
635       Vector toRange = new Vector();
636       Vector fromRange = new Vector();
637       for (int vc = 0; vc < viscontigs.length; vc += 2)
638       {
639         // find a mapped range in this visible region
640         int[] mpr = locateMappedRange(1 + viscontigs[vc],
641                 viscontigs[vc + 1] - 1);
642         if (mpr != null)
643         {
644           for (int m = 0; m < mpr.length; m += 2)
645           {
646             toRange.addElement(new int[] { mpr[m], mpr[m + 1] });
647             int[] xpos = locateRange(mpr[m], mpr[m + 1]);
648             for (int x = 0; x < xpos.length; x += 2)
649             {
650               fromRange.addElement(new int[] { xpos[x], xpos[x + 1] });
651             }
652           }
653         }
654       }
655       int[] from = new int[fromRange.size() * 2];
656       int[] to = new int[toRange.size() * 2];
657       int[] r;
658       for (int f = 0, fSize = fromRange.size(); f < fSize; f++)
659       {
660         r = (int[]) fromRange.elementAt(f);
661         from[f * 2] = r[0];
662         from[f * 2 + 1] = r[1];
663       }
664       for (int f = 0, fSize = toRange.size(); f < fSize; f++)
665       {
666         r = (int[]) toRange.elementAt(f);
667         to[f * 2] = r[0];
668         to[f * 2 + 1] = r[1];
669       }
670       copy.setMap(
671               new MapList(from, to, map.getFromRatio(), map.getToRatio()));
672     }
673     return copy;
674   }
675
676   /**
677    * get the sequence being mapped to - if any
678    * 
679    * @return null or a dataset sequence
680    */
681   public SequenceI getTo()
682   {
683     return to;
684   }
685
686   /**
687    * set the dataset sequence being mapped to if any
688    * 
689    * @param tto
690    */
691   public void setTo(SequenceI tto)
692   {
693     to = tto;
694   }
695
696   /**
697    * Returns an iterator which can serve up the aligned codon column positions
698    * and their corresponding peptide products
699    * 
700    * @param seq
701    *          an aligned (i.e. possibly gapped) sequence
702    * @param gapChar
703    * @return
704    */
705   public Iterator<AlignedCodon> getCodonIterator(SequenceI seq,
706           char gapChar)
707   {
708     return new AlignedCodonIterator(seq, gapChar);
709   }
710
711   /**
712    * Readable representation for debugging only, not guaranteed not to change
713    */
714   @Override
715   public String toString()
716   {
717     return String.format("%s %s", this.map.toString(),
718             this.to == null ? "" : this.to.getName());
719   }
720
721   /**
722    * Returns the identifier for the 'from' range sequence, or null if not set
723    * 
724    * @return
725    */
726   public String getMappedFromId()
727   {
728     return mappedFromId;
729   }
730
731   /**
732    * Sets the identifier for the 'from' range sequence
733    */
734   public void setMappedFromId(String mappedFromId)
735   {
736     this.mappedFromId = mappedFromId;
737   }
738
739 }