JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / analysis / AlignSeq.java
index dd29d73..241eeeb 100755 (executable)
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  */
 package jalview.analysis;
 
-import java.util.*;
-
-import java.awt.*;
-
-import jalview.datamodel.*;
-import jalview.schemes.*;
-import jalview.util.*;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.Mapping;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceI;
+import jalview.schemes.ResidueProperties;
+import jalview.schemes.ScoreMatrix;
+import jalview.util.Comparison;
+import jalview.util.Format;
+import jalview.util.MapList;
+import jalview.util.MessageManager;
+
+import java.awt.Color;
+import java.awt.Graphics;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.StringTokenizer;
 
 /**
  * 
@@ -40,13 +51,13 @@ public class AlignSeq
 
   public static final String DNA = "dna";
 
-  static String[] dna =
-  { "A", "C", "G", "T", "-" };
+  private static final String NEWLINE = System.lineSeparator();
+
+  static String[] dna = { "A", "C", "G", "T", "-" };
 
   // "C", "T", "A", "G", "-"};
-  static String[] pep =
-  { "A", "R", "N", "D", "C", "Q", "E", "G", "H", "I", "L", "K", "M", "F",
-      "P", "S", "T", "W", "Y", "V", "B", "Z", "X", "-" };
+  static String[] pep = { "A", "R", "N", "D", "C", "Q", "E", "G", "H", "I",
+      "L", "K", "M", "F", "P", "S", "T", "W", "Y", "V", "B", "Z", "X", "-" };
 
   int[][] score;
 
@@ -438,7 +449,8 @@ public class AlignSeq
     else
     {
       output.append("Wrong type = dna or pep only");
-      throw new Error(MessageManager.formatMessage("error.unknown_type_dna_or_pep", new String[]{type2}));
+      throw new Error(MessageManager.formatMessage(
+              "error.unknown_type_dna_or_pep", new String[] { type2 }));
     }
   }
 
@@ -568,21 +580,28 @@ public class AlignSeq
     int nochunks = ((aseq1.length - count) / len) + 1;
     pid = 0;
 
-    output.append("Score = " + score[maxi][maxj] + "\n");
-    output.append("Length of alignment = " + (aseq1.length - count) + "\n");
+    output.append("Score = ").append(score[maxi][maxj]).append(NEWLINE);
+    output.append("Length of alignment = ")
+            .append(String.valueOf(aseq1.length - count)).append(NEWLINE);
     output.append("Sequence ");
     output.append(new Format("%" + maxid + "s").form(s1.getName()));
-    output.append(" :  " + s1.getStart() + " - " + s1.getEnd()
-            + " (Sequence length = " + s1str.length() + ")\n");
+    output.append(" :  ").append(String.valueOf(s1.getStart()))
+            .append(" - ").append(String.valueOf(s1.getEnd()));
+    output.append(" (Sequence length = ")
+            .append(String.valueOf(s1str.length())).append(")")
+            .append(NEWLINE);
     output.append("Sequence ");
     output.append(new Format("%" + maxid + "s").form(s2.getName()));
-    output.append(" :  " + s2.getStart() + " - " + s2.getEnd()
-            + " (Sequence length = " + s2str.length() + ")\n\n");
+    output.append(" :  ").append(String.valueOf(s2.getStart()))
+            .append(" - ").append(String.valueOf(s2.getEnd()));
+    output.append(" (Sequence length = ")
+            .append(String.valueOf(s2str.length())).append(")")
+            .append(NEWLINE).append(NEWLINE);
 
     for (int j = 0; j < nochunks; j++)
     {
       // Print the first aligned sequence
-      output.append(new Format("%" + (maxid) + "s").form(s1id) + " ");
+      output.append(new Format("%" + (maxid) + "s").form(s1id)).append(" ");
 
       for (int i = 0; i < len; i++)
       {
@@ -592,8 +611,8 @@ public class AlignSeq
         }
       }
 
-      output.append("\n");
-      output.append(new Format("%" + (maxid) + "s").form(" ") + " ");
+      output.append(NEWLINE);
+      output.append(new Format("%" + (maxid) + "s").form(" ")).append(" ");
 
       // Print out the matching chars
       for (int i = 0; i < len; i++)
@@ -627,9 +646,9 @@ public class AlignSeq
       }
 
       // Now print the second aligned sequence
-      output = output.append("\n");
-      output = output.append(new Format("%" + (maxid) + "s").form(s2id)
-              + " ");
+      output = output.append(NEWLINE);
+      output = output.append(new Format("%" + (maxid) + "s").form(s2id))
+              .append(" ");
 
       for (int i = 0; i < len; i++)
       {
@@ -639,7 +658,7 @@ public class AlignSeq
         }
       }
 
-      output = output.append("\n\n");
+      output.append(NEWLINE).append(NEWLINE);
     }
 
     pid = pid / (aseq1.length - count) * 100;
@@ -793,19 +812,23 @@ public class AlignSeq
   }
 
   /**
-   * DOCUMENT ME!
+   * Returns the given sequence with all of the given gap characters removed.
    * 
-   * @param gapChar
-   *          DOCUMENT ME!
+   * @param gapChars
+   *          a string of characters to be treated as gaps
    * @param seq
-   *          DOCUMENT ME!
+   *          the input sequence
    * 
-   * @return DOCUMENT ME!
+   * @return
    */
-  public static String extractGaps(String gapChar, String seq)
+  public static String extractGaps(String gapChars, String seq)
   {
-    StringTokenizer str = new StringTokenizer(seq, gapChar);
-    StringBuffer newString = new StringBuffer();
+    if (gapChars == null || seq == null)
+    {
+      return null;
+    }
+    StringTokenizer str = new StringTokenizer(seq, gapChars);
+    StringBuilder newString = new StringBuilder(seq.length());
 
     while (str.hasMoreTokens())
     {
@@ -1009,22 +1032,29 @@ public class AlignSeq
 
       if (allowmismatch || c1 == c2)
       {
-        lastmatch = true;
-        // extend mapping interval.
+        // extend mapping interval
         if (lp1 + 1 != alignpos || lp2 + 1 != pdbpos)
         {
           as1.add(Integer.valueOf(alignpos));
           as2.add(Integer.valueOf(pdbpos));
         }
+        lastmatch = true;
         lp1 = alignpos;
         lp2 = pdbpos;
       }
       else
       {
+        // extend mapping interval
+        if (lastmatch)
+        {
+          as1.add(Integer.valueOf(lp1));
+          as2.add(Integer.valueOf(lp2));
+        }
         lastmatch = false;
       }
     }
     // construct range pairs
+
     int[] mapseq1 = new int[as1.size() + (lastmatch ? 1 : 0)], mapseq2 = new int[as2
             .size() + (lastmatch ? 1 : 0)];
     int i = 0;
@@ -1058,16 +1088,24 @@ public class AlignSeq
    * @param ochains
    * @param al
    * @param dnaOrProtein
-   * @param removeOldAnnots when true, old annotation is cleared before new annotation transferred
+   * @param removeOldAnnots
+   *          when true, old annotation is cleared before new annotation
+   *          transferred
+   * @return List<List<SequenceI> originals, List<SequenceI> replacement,
+   *         List<AlignSeq> alignment between each>
    */
-  public static void replaceMatchingSeqsWith(List<SequenceI> seqs, List<AlignmentAnnotation> annotations, List<SequenceI> ochains,
-          AlignmentI al, String dnaOrProtein, boolean removeOldAnnots)
+  public static List<List<? extends Object>> replaceMatchingSeqsWith(
+          List<SequenceI> seqs, List<AlignmentAnnotation> annotations,
+          List<SequenceI> ochains, AlignmentI al, String dnaOrProtein,
+          boolean removeOldAnnots)
   {
+    List<SequenceI> orig = new ArrayList<SequenceI>(), repl = new ArrayList<SequenceI>();
+    List<AlignSeq> aligs = new ArrayList<AlignSeq>();
     if (al != null && al.getHeight() > 0)
     {
       ArrayList<SequenceI> matches = new ArrayList<SequenceI>();
       ArrayList<AlignSeq> aligns = new ArrayList<AlignSeq>();
-  
+
       for (SequenceI sq : ochains)
       {
         SequenceI bestm = null;
@@ -1075,8 +1113,7 @@ public class AlignSeq
         int bestscore = 0;
         for (SequenceI msq : al.getSequences())
         {
-          AlignSeq aseq = doGlobalNWAlignment(msq, sq,
-                  dnaOrProtein);
+          AlignSeq aseq = doGlobalNWAlignment(msq, sq, dnaOrProtein);
           if (bestm == null || aseq.getMaxScore() > bestscore)
           {
             bestscore = aseq.getMaxScore();
@@ -1097,10 +1134,14 @@ public class AlignSeq
         if ((q = ochains.indexOf(sp)) > -1)
         {
           seqs.set(p, sq = matches.get(q));
+          orig.add(sp);
+          repl.add(sq);
           sq.setName(sp.getName());
           sq.setDescription(sp.getDescription());
           Mapping sp2sq;
-          sq.transferAnnotation(sp, sp2sq = aligns.get(q).getMappingFromS1(false));
+          sq.transferAnnotation(sp,
+                  sp2sq = aligns.get(q).getMappingFromS1(false));
+          aligs.add(aligns.get(q));
           int inspos = -1;
           for (int ap = 0; ap < annotations.size();)
           {
@@ -1110,12 +1151,16 @@ public class AlignSeq
               {
                 inspos = ap;
               }
-              if (removeOldAnnots) {
+              if (removeOldAnnots)
+              {
                 annotations.remove(ap);
-              } else {
-                AlignmentAnnotation alan = annotations.get(ap);
+              }
+              else
+              {
+                AlignmentAnnotation alan = annotations.remove(ap);
                 alan.liftOver(sq, sp2sq);
                 alan.setSequenceRef(sq);
+                sq.addAlignmentAnnotation(alan);
               }
             }
             else
@@ -1123,13 +1168,15 @@ public class AlignSeq
               ap++;
             }
           }
-          if (sq.getAnnotation() != null)
+          if (sq.getAnnotation() != null && sq.getAnnotation().length > 0)
           {
-            annotations.addAll(inspos, Arrays.asList(sq.getAnnotation()));
+            annotations.addAll(inspos == -1 ? annotations.size() : inspos,
+                    Arrays.asList(sq.getAnnotation()));
           }
         }
       }
     }
+    return Arrays.asList(orig, repl, aligs);
   }
 
   /**