JAL-2685 tweaks to output spacing, updated TestAlignSeq for changes
[jalview.git] / src / jalview / analysis / Dna.java
index 9ce00cc..0128624 100644 (file)
@@ -69,7 +69,7 @@ public class Dna
 
   final private int dnaWidth;
 
-  final private Alignment dataset;
+  final private AlignmentI dataset;
 
   /*
    * Working variables for the translation.
@@ -120,7 +120,8 @@ public class Dna
    * @param ac2
    * @return
    */
-  public static final int compareCodonPos(AlignedCodon ac1, AlignedCodon ac2)
+  public static final int compareCodonPos(AlignedCodon ac1,
+          AlignedCodon ac2)
   {
     return comparator.compare(ac1, ac2);
     // return jalview_2_8_2compare(ac1, ac2);
@@ -134,7 +135,8 @@ public class Dna
    * @param ac2
    * @return
    */
-  private static int jalview_2_8_2compare(AlignedCodon ac1, AlignedCodon ac2)
+  private static int jalview_2_8_2compare(AlignedCodon ac1,
+          AlignedCodon ac2)
   {
     if (ac1 == null || ac2 == null || (ac1.equals(ac2)))
     {
@@ -208,13 +210,13 @@ public class Dna
     for (int gd = 0; gd < selection.length; gd++)
     {
       SequenceI dna = selection[gd];
-      DBRefEntry[] dnarefs = DBRefUtils.selectRefs(dna.getDBRef(),
+      DBRefEntry[] dnarefs = DBRefUtils.selectRefs(dna.getDBRefs(),
               jalview.datamodel.DBRefSource.DNACODINGDBS);
       if (dnarefs != null)
       {
         // intersect with pep
         List<DBRefEntry> mappedrefs = new ArrayList<DBRefEntry>();
-        DBRefEntry[] refs = dna.getDBRef();
+        DBRefEntry[] refs = dna.getDBRefs();
         for (int d = 0; d < refs.length; d++)
         {
           if (refs[d].getMap() != null && refs[d].getMap().getMap() != null
@@ -435,7 +437,8 @@ public class Dna
         /*
          * Filled up a reading frame...
          */
-        AlignedCodon alignedCodon = new AlignedCodon(cdp[0], cdp[1], cdp[2]);
+        AlignedCodon alignedCodon = new AlignedCodon(cdp[0], cdp[1],
+                cdp[2]);
         String aa = ResidueProperties.codonTranslate(new String(codon));
         rf = 0;
         final String gapString = String.valueOf(gapChar);
@@ -444,10 +447,11 @@ public class Dna
           aa = gapString;
           if (skipint == null)
           {
-            skipint = new int[] { alignedCodon.pos1, alignedCodon.pos3 /*
-                                                                        * cdp[0],
-                                                                        * cdp[2]
-                                                                        */};
+            skipint = new int[] { alignedCodon.pos1,
+                alignedCodon.pos3 /*
+                                   * cdp[0],
+                                   * cdp[2]
+                                   */ };
           }
           skipint[1] = alignedCodon.pos3; // cdp[2];
         }
@@ -502,8 +506,8 @@ public class Dna
                       }
                       if (vc + 2 < t.length)
                       {
-                        System.arraycopy(scontigs, vc + 2, t, vc, t.length
-                                - vc + 2);
+                        System.arraycopy(scontigs, vc + 2, t, vc,
+                                t.length - vc + 2);
                       }
                       scontigs = t;
                     }
@@ -596,9 +600,9 @@ public class Dna
         }
         else if (!alignedCodons[aspos].equals(alignedCodon))
         {
-          throw new IllegalStateException("Tried to coalign "
-                  + alignedCodons[aspos].toString() + " with "
-                  + alignedCodon.toString());
+          throw new IllegalStateException(
+                  "Tried to coalign " + alignedCodons[aspos].toString()
+                          + " with " + alignedCodon.toString());
         }
         if (aspos >= aaWidth)
         {
@@ -773,7 +777,7 @@ public class Dna
   {
     SequenceFeature[] sfs = dna.getSequenceFeatures();
     Boolean fgstate;
-    DBRefEntry[] dnarefs = DBRefUtils.selectRefs(dna.getDBRef(),
+    DBRefEntry[] dnarefs = DBRefUtils.selectRefs(dna.getDBRefs(),
             DBRefSource.DNACODINGDBS);
     if (dnarefs != null)
     {
@@ -790,8 +794,8 @@ public class Dna
     {
       for (SequenceFeature sf : sfs)
       {
-        fgstate = (featureGroups == null) ? null : featureGroups
-                .get(sf.featureGroup);
+        fgstate = (featureGroups == null) ? null
+                : featureGroups.get(sf.featureGroup);
         if ((featureTypes == null || featureTypes.containsKey(sf.getType()))
                 && (fgstate == null || fgstate.booleanValue()))
         {
@@ -806,4 +810,164 @@ public class Dna
       }
     }
   }
+
+  /**
+   * Returns an alignment consisting of the reversed (and optionally
+   * complemented) sequences set in this object's constructor
+   * 
+   * @param complement
+   * @return
+   */
+  public AlignmentI reverseCdna(boolean complement)
+  {
+    int sSize = selection.size();
+    List<SequenceI> reversed = new ArrayList<SequenceI>();
+    for (int s = 0; s < sSize; s++)
+    {
+      SequenceI newseq = reverseSequence(selection.get(s).getName(),
+              seqstring[s], complement);
+
+      if (newseq != null)
+      {
+        reversed.add(newseq);
+      }
+    }
+
+    SequenceI[] newseqs = reversed.toArray(new SequenceI[reversed.size()]);
+    AlignmentI al = new Alignment(newseqs);
+    ((Alignment) al).createDatasetAlignment();
+    return al;
+  }
+
+  /**
+   * Returns a reversed, and optionally complemented, sequence. The new
+   * sequence's name is the original name with "|rev" or "|revcomp" appended.
+   * aAcCgGtT and DNA ambiguity codes are complemented, any other characters are
+   * left unchanged.
+   * 
+   * @param seq
+   * @param complement
+   * @return
+   */
+  public static SequenceI reverseSequence(String seqName, String sequence,
+          boolean complement)
+  {
+    String newName = seqName + "|rev" + (complement ? "comp" : "");
+    char[] originalSequence = sequence.toCharArray();
+    int length = originalSequence.length;
+    char[] reversedSequence = new char[length];
+    int bases = 0;
+    for (int i = 0; i < length; i++)
+    {
+      char c = complement ? getComplement(originalSequence[i])
+              : originalSequence[i];
+      reversedSequence[length - i - 1] = c;
+      if (!Comparison.isGap(c))
+      {
+        bases++;
+      }
+    }
+    SequenceI reversed = new Sequence(newName, reversedSequence, 1, bases);
+    return reversed;
+  }
+
+  /**
+   * Returns dna complement (preserving case) for aAcCgGtTuU. Ambiguity codes
+   * are treated as on http://reverse-complement.com/. Anything else is left
+   * unchanged.
+   * 
+   * @param c
+   * @return
+   */
+  public static char getComplement(char c)
+  {
+    char result = c;
+    switch (c)
+    {
+    case '-':
+    case '.':
+    case ' ':
+      break;
+    case 'a':
+      result = 't';
+      break;
+    case 'A':
+      result = 'T';
+      break;
+    case 'c':
+      result = 'g';
+      break;
+    case 'C':
+      result = 'G';
+      break;
+    case 'g':
+      result = 'c';
+      break;
+    case 'G':
+      result = 'C';
+      break;
+    case 't':
+      result = 'a';
+      break;
+    case 'T':
+      result = 'A';
+      break;
+    case 'u':
+      result = 'a';
+      break;
+    case 'U':
+      result = 'A';
+      break;
+    case 'r':
+      result = 'y';
+      break;
+    case 'R':
+      result = 'Y';
+      break;
+    case 'y':
+      result = 'r';
+      break;
+    case 'Y':
+      result = 'R';
+      break;
+    case 'k':
+      result = 'm';
+      break;
+    case 'K':
+      result = 'M';
+      break;
+    case 'm':
+      result = 'k';
+      break;
+    case 'M':
+      result = 'K';
+      break;
+    case 'b':
+      result = 'v';
+      break;
+    case 'B':
+      result = 'V';
+      break;
+    case 'v':
+      result = 'b';
+      break;
+    case 'V':
+      result = 'B';
+      break;
+    case 'd':
+      result = 'h';
+      break;
+    case 'D':
+      result = 'H';
+      break;
+    case 'h':
+      result = 'd';
+      break;
+    case 'H':
+      result = 'D';
+      break;
+    }
+
+    return result;
+  }
 }