Merge branch 'releases/Release_2_11_3_Branch'
[jalview.git] / src / jalview / datamodel / AlignmentView.java
index a6f4310..6ab71c7 100644 (file)
@@ -26,7 +26,6 @@ import jalview.util.ShiftList;
 import java.io.PrintStream;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Vector;
 
 /**
  * Transient object compactly representing a 'view' of an alignment - with
@@ -47,7 +46,7 @@ public class AlignmentView
    * one or more ScGroup objects, which are referenced by each seqCigar's group
    * membership
    */
-  private List<ScGroup> scGroups=null;
+  private List<ScGroup> scGroups = null;
 
   private boolean isNa = false;
 
@@ -69,13 +68,51 @@ public class AlignmentView
    */
   private class ScGroup
   {
-    public Vector seqs;
+    public List<SeqCigar> seqs;
 
     public SequenceGroup sg;
 
     ScGroup()
     {
-      seqs = new Vector();
+      seqs = new ArrayList<>();
+    }
+
+    /**
+     * @param seq
+     * @return true if seq was not a member before and was added to group
+     */
+    public boolean add(SeqCigar seq)
+    {
+      if (!seq.isMemberOf(this))
+      {
+        seqs.add(seq);
+        seq.setGroupMembership(this);
+        return true;
+      }
+      else
+      {
+        return false;
+      }
+    }
+
+    /**
+     * 
+     * @param seq
+     * @return true if seq was a member and was removed from group
+     */
+    public boolean remove(SeqCigar seq)
+    {
+      if (seq.removeGroupMembership(this))
+      {
+        seqs.remove(seq);
+        return true;
+      }
+      return false;
+    }
+
+    public int size()
+    {
+      return seqs.size();
     }
   }
 
@@ -83,7 +120,7 @@ public class AlignmentView
    * vector of selected seqCigars. This vector is also referenced by each
    * seqCigar contained in it.
    */
-  private Vector selected;
+  private ScGroup selected;
 
   /**
    * Construct an alignmentView from a live jalview alignment view. Note -
@@ -103,17 +140,17 @@ public class AlignmentView
    *          - when set, any groups on the given alignment will be marked on
    *          the view
    */
-  public AlignmentView(AlignmentI alignment,
-          ColumnSelection columnSelection, SequenceGroup selection,
-          boolean hasHiddenColumns, boolean selectedRegionOnly,
-          boolean recordGroups)
+  public AlignmentView(AlignmentI alignment, HiddenColumns hidden,
+          SequenceGroup selection, boolean hasHiddenColumns,
+          boolean selectedRegionOnly, boolean recordGroups)
   {
     // refactored from AlignViewport.getAlignmentView(selectedOnly);
     this(new jalview.datamodel.CigarArray(alignment,
-            (hasHiddenColumns ? columnSelection : null),
+            (hasHiddenColumns ? hidden : null),
             (selectedRegionOnly ? selection : null)),
-            (selectedRegionOnly && selection != null) ? selection
-                    .getStartRes() : 0);
+            (selectedRegionOnly && selection != null)
+                    ? selection.getStartRes()
+                    : 0);
     isNa = alignment.isNucleotide();
     // walk down SeqCigar array and Alignment Array - optionally restricted by
     // selected region.
@@ -123,19 +160,18 @@ public class AlignmentView
     SequenceI[] selseqs;
     if (selection != null && selection.getSize() > 0)
     {
-      List<SequenceI> sel = selection.getSequences(null);
-      this.selected = new Vector();
-      selseqs = selection
-              .getSequencesInOrder(alignment, selectedRegionOnly);
+      this.selected = new ScGroup();
+      selseqs = selection.getSequencesInOrder(alignment,
+              selectedRegionOnly);
     }
     else
     {
       selseqs = alignment.getSequencesArray();
     }
 
-    List<List<SequenceI>> seqsets=new ArrayList<List<SequenceI>>();
+    List<List<SequenceI>> seqsets = new ArrayList<>();
     // get the alignment's group list and make a copy
-    List<SequenceGroup> grps = new ArrayList<SequenceGroup>();
+    List<SequenceGroup> grps = new ArrayList<>();
     List<SequenceGroup> gg = alignment.getGroups();
     grps.addAll(gg);
     ScGroup[] sgrps = null;
@@ -148,7 +184,7 @@ public class AlignmentView
         // strip out any groups that do not actually intersect with the
         // visible and selected region
         int ssel = selection.getStartRes(), esel = selection.getEndRes();
-        List<SequenceGroup> isg = new ArrayList<SequenceGroup>();
+        List<SequenceGroup> isg = new ArrayList<>();
         for (SequenceGroup sg : grps)
         {
           if (!(sg.getStartRes() > esel || sg.getEndRes() < ssel))
@@ -194,8 +230,7 @@ public class AlignmentView
         if (selection != null && selection.getSize() > 0
                 && !selectedRegionOnly)
         {
-          sequences[csi].setGroupMembership(selected);
-          selected.addElement(sequences[csi]);
+          selected.add(sequences[csi]);
         }
         if (seqsets != null)
         {
@@ -203,14 +238,13 @@ public class AlignmentView
           {
             if ((seqsets.get(sg)).contains(selseqs[i]))
             {
-              sequences[csi].setGroupMembership(sgrps[sg]);
               sgrps[sg].sg.deleteSequence(selseqs[i], false);
-              sgrps[sg].seqs.addElement(sequences[csi]);
+              sgrps[sg].add(sequences[csi]);
               if (!addedgps[sg])
               {
                 if (scGroups == null)
                 {
-                  scGroups = new ArrayList<ScGroup>();
+                  scGroups = new ArrayList<>();
                 }
                 addedgps[sg] = true;
                 scGroups.add(sgrps[sg]);
@@ -241,7 +275,8 @@ public class AlignmentView
   {
     if (!seqcigararray.isSeqCigarArray())
     {
-      throw new Error(MessageManager.getString("error.implementation_error_can_only_make_alignmnet_from_cigararray"));
+      throw new Error(
+              "Implementation Error - can only make an alignment view from a CigarArray of sequences.");
     }
     // contigs = seqcigararray.applyDeletions();
     contigs = seqcigararray.getDeletedRegions();
@@ -294,14 +329,13 @@ public class AlignmentView
    *          char
    * @return Object[] { SequenceI[], ColumnSelection}
    */
-  public Object[] getAlignmentAndColumnSelection(char gapCharacter)
+  public Object[] getAlignmentAndHiddenColumns(char gapCharacter)
   {
-    ColumnSelection colsel = new ColumnSelection();
+    HiddenColumns hidden = new HiddenColumns();
 
-    return new Object[]
-    {
-        SeqCigar.createAlignmentSequences(sequences, gapCharacter, colsel,
-                contigs), colsel };
+    return new Object[] { SeqCigar.createAlignmentSequences(sequences,
+            gapCharacter, hidden, contigs),
+        hidden };
   }
 
   /**
@@ -334,8 +368,8 @@ public class AlignmentView
    *          - true if vcal is alignment of the visible regions of the view
    *          (e.g. as returned from getVisibleAlignment)
    */
-  private void addPrunedGroupsInOrder(AlignmentI vcal, int gstart,
-          int gend, boolean viscontigs)
+  private void addPrunedGroupsInOrder(AlignmentI vcal, int gstart, int gend,
+          boolean viscontigs)
   {
     boolean r = false;
     if (gstart > -1 && gstart <= gend)
@@ -405,8 +439,8 @@ public class AlignmentView
               for (int h = 0; h < contigs.length; h += 3)
               {
                 {
-                  prune.addShift(p + contigs[h + 1], contigs[h + 2]
-                          - contigs[h + 1]);
+                  prune.addShift(p + contigs[h + 1],
+                          contigs[h + 2] - contigs[h + 1]);
                 }
                 p = contigs[h + 1] + contigs[h + 2];
               }
@@ -474,12 +508,8 @@ public class AlignmentView
     for (int i = 0, j = sequences.length; i < j; i++)
     {
       aln[i] = sequences[i].getSeq(c);
-    }
-    // Remove hidden regions from sequence objects.
-    String seqs[] = getSequenceStrings(c);
-    for (int i = 0, j = aln.length; i < j; i++)
-    {
-      aln[i].setSequence(seqs[i]);
+      // Remove hidden regions from sequence
+      aln[i].setSequence(getASequenceString(c, i));
     }
     return aln;
   }
@@ -515,8 +545,38 @@ public class AlignmentView
   }
 
   /**
+   * build a string excluding hidden regions from a particular sequence in the
+   * view
+   * 
+   * @param c
+   * @param n
+   * @return
+   */
+  private String getASequenceString(char c, int n)
+  {
+    String sqn;
+    String fullseq = sequences[n].getSequenceString(c);
+    if (contigs != null)
+    {
+      sqn = "";
+      int p = 0;
+      for (int h = 0; h < contigs.length; h += 3)
+      {
+        sqn += fullseq.substring(p, contigs[h + 1]);
+        p = contigs[h + 1] + contigs[h + 2];
+      }
+      sqn += fullseq.substring(p);
+    }
+    else
+    {
+      sqn = fullseq;
+    }
+    return sqn;
+  }
+
+  /**
    * get an array of visible sequence strings for a view on an alignment using
-   * the given gap character
+   * the given gap character uses getASequenceString
    * 
    * @param c
    *          char
@@ -527,22 +587,7 @@ public class AlignmentView
     String[] seqs = new String[sequences.length];
     for (int n = 0; n < sequences.length; n++)
     {
-      String fullseq = sequences[n].getSequenceString(c);
-      if (contigs != null)
-      {
-        seqs[n] = "";
-        int p = 0;
-        for (int h = 0; h < contigs.length; h += 3)
-        {
-          seqs[n] += fullseq.substring(p, contigs[h + 1]);
-          p = contigs[h + 1] + contigs[h + 2];
-        }
-        seqs[n] += fullseq.substring(p);
-      }
-      else
-      {
-        seqs[n] = fullseq;
-      }
+      seqs[n] = getASequenceString(c, n);
     }
     return seqs;
   }
@@ -605,8 +650,8 @@ public class AlignmentView
           SequenceI mseq[] = new SequenceI[sequences.length];
           for (int s = 0; s < mseq.length; s++)
           {
-            mseq[s] = sequences[s].getSeq(gapCharacter).getSubSequence(
-                    start, contigs[contig + 1]);
+            mseq[s] = sequences[s].getSeq(gapCharacter)
+                    .getSubSequence(start, contigs[contig + 1]);
           }
           smsa[j] = mseq;
           j++;
@@ -652,7 +697,8 @@ public class AlignmentView
   {
     if (sequences == null || width <= 0)
     {
-      throw new Error(MessageManager.getString("error.empty_view_cannot_be_updated"));
+      throw new Error(MessageManager
+              .getString("error.empty_view_cannot_be_updated"));
     }
     if (nvismsa == null)
     {
@@ -662,7 +708,8 @@ public class AlignmentView
     if (contigs != null && contigs.length > 0)
     {
       SequenceI[] alignment = new SequenceI[sequences.length];
-      ColumnSelection columnselection = new ColumnSelection();
+      // ColumnSelection columnselection = new ColumnSelection();
+      HiddenColumns hidden = new HiddenColumns();
       if (contigs != null && contigs.length > 0)
       {
         int start = 0;
@@ -682,7 +729,13 @@ public class AlignmentView
               j++;
               if (mseq.length != sequences.length)
               {
-                throw new Error(MessageManager.formatMessage("error.mismatch_between_number_of_sequences_in_block", new String[]{Integer.valueOf(j).toString(),Integer.valueOf(mseq.length).toString(),Integer.valueOf(sequences.length).toString() }));
+                throw new Error(MessageManager.formatMessage(
+                        "error.mismatch_between_number_of_sequences_in_block",
+                        new String[]
+                        { Integer.valueOf(j).toString(),
+                            Integer.valueOf(mseq.length).toString(),
+                            Integer.valueOf(sequences.length)
+                                    .toString() }));
               }
               swidth = mseq[0].getLength(); // JBPNote: could ensure padded
               // here.
@@ -694,9 +747,9 @@ public class AlignmentView
                 }
                 else
                 {
-                  alignment[s].setSequence(alignment[s]
-                          .getSequenceAsString()
-                          + mseq[s].getSequenceAsString());
+                  alignment[s]
+                          .setSequence(alignment[s].getSequenceAsString()
+                                  + mseq[s].getSequenceAsString());
                   if (mseq[s].getStart() <= mseq[s].getEnd())
                   {
                     alignment[s].setEnd(mseq[s].getEnd());
@@ -728,9 +781,9 @@ public class AlignmentView
                   }
                   else
                   {
-                    alignment[s].setSequence(alignment[s]
-                            .getSequenceAsString()
-                            + oseq.getSequenceAsString());
+                    alignment[s]
+                            .setSequence(alignment[s].getSequenceAsString()
+                                    + oseq.getSequenceAsString());
                     if (oseq.getEnd() >= oseq.getStart())
                     {
                       alignment[s].setEnd(oseq.getEnd());
@@ -765,8 +818,7 @@ public class AlignmentView
             }
           }
           // mark hidden segment as hidden in the new alignment
-          columnselection.hideColumns(nwidth, nwidth + contigs[contig + 2]
-                  - 1);
+          hidden.hideColumns(nwidth, nwidth + contigs[contig + 2] - 1);
           nwidth += contigs[contig + 2];
         }
         // Do final segment - if it exists
@@ -821,9 +873,9 @@ public class AlignmentView
                   }
                   else
                   {
-                    alignment[s].setSequence(alignment[s]
-                            .getSequenceAsString()
-                            + oseq.getSequenceAsString());
+                    alignment[s]
+                            .setSequence(alignment[s].getSequenceAsString()
+                                    + oseq.getSequenceAsString());
                     if (oseq.getEnd() >= oseq.getStart())
                     {
                       alignment[s].setEnd(oseq.getEnd());
@@ -835,29 +887,31 @@ public class AlignmentView
               else
               {
                 // place gaps.
-                throw new Error(MessageManager.getString("error.padding_not_yet_implemented"));
+                throw new Error(MessageManager
+                        .getString("error.padding_not_yet_implemented"));
               }
             }
           }
         }
       }
-      return new Object[]
-      { alignment, columnselection };
+      return new Object[] { alignment, hidden };
     }
     else
     {
       if (nvismsa.length != 1)
       {
-        throw new Error(MessageManager.formatMessage("error.mismatch_between_visible_blocks_to_update_and_number_of_contigs_in_view", new String[]{Integer.valueOf(nvismsa.length).toString()}));
+        throw new Error(MessageManager.formatMessage(
+                "error.mismatch_between_visible_blocks_to_update_and_number_of_contigs_in_view",
+                new String[]
+                { Integer.valueOf(nvismsa.length).toString() }));
       }
       if (nvismsa[0] != null)
       {
-        return new Object[]
-        { nvismsa[0], new ColumnSelection() };
+        return new Object[] { nvismsa[0], new HiddenColumns() };
       }
       else
       {
-        return getAlignmentAndColumnSelection(gapCharacter);
+        return getAlignmentAndHiddenColumns(gapCharacter);
       }
     }
   }
@@ -907,15 +961,14 @@ public class AlignmentView
       if (start < fwidth)
       {
         viscontigs[nvis] = start;
-        viscontigs[nvis + 1] = fwidth; // end is inclusive
+        viscontigs[nvis + 1] = fwidth - 1; // end is inclusive
         nvis += 2;
       }
       return viscontigs;
     }
     else
     {
-      return new int[]
-      { 0, width };
+      return new int[] { 0, width - 1 };
     }
   }
 
@@ -1045,10 +1098,10 @@ public class AlignmentView
                 + sgr.sg.getEndRes());
         for (int s = 0; s < sgr.seqs.size(); s++)
         {
-          if (!((SeqCigar) sgr.seqs.elementAt(s)).isMemberOf(sgr))
+          // JBPnote this should be a unit test for ScGroup
+          if (!sgr.seqs.get(s).isMemberOf(sgr))
           {
-            os.println("** WARNING: sequence "
-                    + ((SeqCigar) sgr.seqs.elementAt(s)).toString()
+            os.println("** WARNING: sequence " + sgr.seqs.get(s).toString()
                     + " is not marked as member of group.");
           }
         }
@@ -1073,113 +1126,114 @@ public class AlignmentView
   }
 
   public static void testSelectionViews(AlignmentI alignment,
-          ColumnSelection csel, SequenceGroup selection)
+          HiddenColumns hidden, SequenceGroup selection)
   {
-    System.out.println("Testing standard view creation:\n");
+    jalview.bin.Console.outPrintln("Testing standard view creation:\n");
     AlignmentView view = null;
     try
     {
-      System.out
-              .println("View with no hidden columns, no limit to selection, no groups to be collected:");
-      view = new AlignmentView(alignment, csel, selection, false, false,
+      jalview.bin.Console.outPrintln(
+              "View with no hidden columns, no limit to selection, no groups to be collected:");
+      view = new AlignmentView(alignment, hidden, selection, false, false,
               false);
       summariseAlignmentView(view, System.out);
 
     } catch (Exception e)
     {
       e.printStackTrace();
-      System.err
-              .println("Failed to generate alignment with selection but no groups marked.");
+      jalview.bin.Console.errPrintln(
+              "Failed to generate alignment with selection but no groups marked.");
     }
     try
     {
-      System.out
-              .println("View with no hidden columns, no limit to selection, and all groups to be collected:");
-      view = new AlignmentView(alignment, csel, selection, false, false,
+      jalview.bin.Console.outPrintln(
+              "View with no hidden columns, no limit to selection, and all groups to be collected:");
+      view = new AlignmentView(alignment, hidden, selection, false, false,
               true);
       summariseAlignmentView(view, System.out);
     } catch (Exception e)
     {
       e.printStackTrace();
-      System.err
-              .println("Failed to generate alignment with selection marked but no groups marked.");
+      jalview.bin.Console.errPrintln(
+              "Failed to generate alignment with selection marked but no groups marked.");
     }
     try
     {
-      System.out
-              .println("View with no hidden columns, limited to selection and no groups to be collected:");
-      view = new AlignmentView(alignment, csel, selection, false, true,
+      jalview.bin.Console.outPrintln(
+              "View with no hidden columns, limited to selection and no groups to be collected:");
+      view = new AlignmentView(alignment, hidden, selection, false, true,
               false);
       summariseAlignmentView(view, System.out);
     } catch (Exception e)
     {
       e.printStackTrace();
-      System.err
-              .println("Failed to generate alignment with selection restricted but no groups marked.");
+      jalview.bin.Console.errPrintln(
+              "Failed to generate alignment with selection restricted but no groups marked.");
     }
     try
     {
-      System.out
-              .println("View with no hidden columns, limited to selection, and all groups to be collected:");
-      view = new AlignmentView(alignment, csel, selection, false, true,
+      jalview.bin.Console.outPrintln(
+              "View with no hidden columns, limited to selection, and all groups to be collected:");
+      view = new AlignmentView(alignment, hidden, selection, false, true,
               true);
       summariseAlignmentView(view, System.out);
     } catch (Exception e)
     {
       e.printStackTrace();
-      System.err
-              .println("Failed to generate alignment with selection restricted and groups marked.");
+      jalview.bin.Console.errPrintln(
+              "Failed to generate alignment with selection restricted and groups marked.");
     }
     try
     {
-      System.out
-              .println("View *with* hidden columns, no limit to selection, no groups to be collected:");
-      view = new AlignmentView(alignment, csel, selection, true, false,
+      jalview.bin.Console.outPrintln(
+              "View *with* hidden columns, no limit to selection, no groups to be collected:");
+      view = new AlignmentView(alignment, hidden, selection, true, false,
               false);
       summariseAlignmentView(view, System.out);
     } catch (Exception e)
     {
       e.printStackTrace();
-      System.err
-              .println("Failed to generate alignment with selection but no groups marked.");
+      jalview.bin.Console.errPrintln(
+              "Failed to generate alignment with selection but no groups marked.");
     }
     try
     {
-      System.out
-              .println("View *with* hidden columns, no limit to selection, and all groups to be collected:");
-      view = new AlignmentView(alignment, csel, selection, true, false,
+      jalview.bin.Console.outPrintln(
+              "View *with* hidden columns, no limit to selection, and all groups to be collected:");
+      view = new AlignmentView(alignment, hidden, selection, true, false,
               true);
       summariseAlignmentView(view, System.out);
     } catch (Exception e)
     {
       e.printStackTrace();
-      System.err
-              .println("Failed to generate alignment with selection marked but no groups marked.");
+      jalview.bin.Console.errPrintln(
+              "Failed to generate alignment with selection marked but no groups marked.");
     }
     try
     {
-      System.out
-              .println("View *with* hidden columns, limited to selection and no groups to be collected:");
-      view = new AlignmentView(alignment, csel, selection, true, true,
+      jalview.bin.Console.outPrintln(
+              "View *with* hidden columns, limited to selection and no groups to be collected:");
+      view = new AlignmentView(alignment, hidden, selection, true, true,
               false);
       summariseAlignmentView(view, System.out);
     } catch (Exception e)
     {
       e.printStackTrace();
-      System.err
-              .println("Failed to generate alignment with selection restricted but no groups marked.");
+      jalview.bin.Console.errPrintln(
+              "Failed to generate alignment with selection restricted but no groups marked.");
     }
     try
     {
-      System.out
-              .println("View *with* hidden columns, limited to selection, and all groups to be collected:");
-      view = new AlignmentView(alignment, csel, selection, true, true, true);
+      jalview.bin.Console.outPrintln(
+              "View *with* hidden columns, limited to selection, and all groups to be collected:");
+      view = new AlignmentView(alignment, hidden, selection, true, true,
+              true);
       summariseAlignmentView(view, System.out);
     } catch (Exception e)
     {
       e.printStackTrace();
-      System.err
-              .println("Failed to generate alignment with selection restricted and groups marked.");
+      jalview.bin.Console.errPrintln(
+              "Failed to generate alignment with selection restricted and groups marked.");
     }
 
   }