JAL-1691 applet SplitFrame scrolling; pull up of 5 fields to
[jalview.git] / src / jalview / util / MappingUtils.java
index 4cfb49e..4aed258 100644 (file)
@@ -1,5 +1,13 @@
 package jalview.util;
 
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
 import jalview.analysis.AlignmentSorter;
 import jalview.api.AlignViewportI;
 import jalview.commands.CommandI;
@@ -17,13 +25,6 @@ import jalview.datamodel.Sequence;
 import jalview.datamodel.SequenceGroup;
 import jalview.datamodel.SequenceI;
 
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
 /**
  * Helper methods for manipulations involving sequence mappings.
  * 
@@ -249,8 +250,23 @@ public final class MappingUtils
   public static SearchResults buildSearchResults(SequenceI seq, int index,
           Set<AlignedCodonFrame> seqmappings)
   {
-    SearchResults results;
-    results = new SearchResults();
+    SearchResults results = new SearchResults();
+    addSearchResults(results, seq, index, seqmappings);
+    return results;
+  }
+
+  /**
+   * Adds entries to a SearchResults object describing the mapped region
+   * corresponding to the specified sequence position.
+   * 
+   * @param results
+   * @param seq
+   * @param index
+   * @param seqmappings
+   */
+  public static void addSearchResults(SearchResults results, SequenceI seq,
+          int index, Set<AlignedCodonFrame> seqmappings)
+  {
     if (index >= seq.getStart() && index <= seq.getEnd())
     {
       for (AlignedCodonFrame acf : seqmappings)
@@ -258,7 +274,6 @@ public final class MappingUtils
         acf.markMappedRegion(seq, index, results);
       }
     }
-    return results;
   }
 
   /**
@@ -270,8 +285,8 @@ public final class MappingUtils
    * @param mapTo
    * @return
    */
-  public static SequenceGroup mapSequenceGroup(SequenceGroup sg,
-          AlignViewportI mapFrom, AlignViewportI mapTo)
+  public static SequenceGroup mapSequenceGroup(final SequenceGroup sg,
+          final AlignViewportI mapFrom, final AlignViewportI mapTo)
   {
     /*
      * Note the SequenceGroup holds aligned sequences, the mappings hold dataset
@@ -281,18 +296,50 @@ public final class MappingUtils
     AlignViewportI protein = targetIsNucleotide ? mapFrom : mapTo;
     Set<AlignedCodonFrame> codonFrames = protein.getAlignment()
             .getCodonFrames();
-
     /*
-     * Copy group name, name colours, but not sequences or sequence colour
-     * scheme
+     * Copy group name, colours etc, but not sequences or sequence colour scheme
      */
     SequenceGroup mappedGroup = new SequenceGroup(sg);
     mappedGroup.cs = mapTo.getGlobalColourScheme();
     mappedGroup.clear();
-    // TODO set width of mapped group
 
+    int minStartCol = -1;
+    int maxEndCol = -1;
+    final int selectionStartRes = sg.getStartRes();
+    final int selectionEndRes = sg.getEndRes();
     for (SequenceI selected : sg.getSequences())
     {
+      /*
+       * Find the widest range of non-gapped positions in the selection range
+       */
+      int firstUngappedPos = selectionStartRes;
+      while (firstUngappedPos <= selectionEndRes
+              && Comparison.isGap(selected.getCharAt(firstUngappedPos)))
+      {
+        firstUngappedPos++;
+      }
+
+      /*
+       * If this sequence is only gaps in the selected range, skip it
+       */
+      if (firstUngappedPos > selectionEndRes)
+      {
+        continue;
+      }
+
+      int lastUngappedPos = selectionEndRes;
+      while (lastUngappedPos >= selectionStartRes
+              && Comparison.isGap(selected.getCharAt(lastUngappedPos)))
+      {
+        lastUngappedPos--;
+      }
+
+      /*
+       * Find the selected start/end residue positions in sequence
+       */
+      int startResiduePos = selected.findPosition(firstUngappedPos);
+      int endResiduePos = selected.findPosition(lastUngappedPos);
+      
       for (AlignedCodonFrame acf : codonFrames)
       {
         SequenceI mappedSequence = targetIsNucleotide ? acf
@@ -301,8 +348,39 @@ public final class MappingUtils
         {
           for (SequenceI seq : mapTo.getAlignment().getSequences())
           {
+            int mappedStartResidue = 0;
+            int mappedEndResidue = 0;
             if (seq.getDatasetSequence() == mappedSequence)
             {
+              /*
+               * Found a sequence mapping. Locate the start/end mapped residues.
+               */
+              SearchResults sr = buildSearchResults(selected,
+                      startResiduePos, Collections.singleton(acf));
+              for (Match m : sr.getResults())
+              {
+                mappedStartResidue = m.getStart();
+                mappedEndResidue = m.getEnd();
+              }
+              sr = buildSearchResults(selected, endResiduePos,
+                      Collections.singleton(acf));
+              for (Match m : sr.getResults())
+              {
+                mappedStartResidue = Math.min(mappedStartResidue,
+                        m.getStart());
+                mappedEndResidue = Math.max(mappedEndResidue, m.getEnd());
+              }
+
+              /*
+               * Find the mapped aligned columns, save the range. Note findIndex
+               * returns a base 1 position, SequenceGroup uses base 0
+               */
+              int mappedStartCol = seq.findIndex(mappedStartResidue) - 1;
+              minStartCol = minStartCol == -1 ? mappedStartCol : Math.min(
+                      minStartCol, mappedStartCol);
+              int mappedEndCol = seq.findIndex(mappedEndResidue) - 1;
+              maxEndCol = maxEndCol == -1 ? mappedEndCol : Math.max(
+                      maxEndCol, mappedEndCol);
               mappedGroup.addSequence(seq, false);
               break;
             }
@@ -310,6 +388,8 @@ public final class MappingUtils
         }
       }
     }
+    mappedGroup.setStartRes(minStartCol < 0 ? 0 : minStartCol);
+    mappedGroup.setEndRes(maxEndCol < 0 ? 0 : maxEndCol);
     return mappedGroup;
   }
 
@@ -542,4 +622,28 @@ public final class MappingUtils
     }
     return result;
   }
+
+  /**
+   * Returns a list of any mappings that are from or to the given (aligned or
+   * dataset) sequence.
+   * 
+   * @param sequence
+   * @param mappings
+   * @return
+   */
+  public static List<AlignedCodonFrame> findMappingsForSequence(
+          SequenceI sequence, Set<AlignedCodonFrame> mappings)
+  {
+    List<AlignedCodonFrame> result = new ArrayList<AlignedCodonFrame>();
+    if (sequence == null || mappings == null)
+    {
+      return result;
+    }
+    for (AlignedCodonFrame mapping : mappings) {
+      if (mapping.involvesSequence(sequence)) {
+        result.add(mapping);
+      }
+    }
+    return result;
+  }
 }