JAL-2759 Changes to getVisibleSequenceStrings after review
[jalview.git] / src / jalview / datamodel / HiddenColumns.java
index 55af3f8..ab71cbe 100644 (file)
@@ -21,6 +21,7 @@
 package jalview.datamodel;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.BitSet;
 import java.util.Iterator;
 import java.util.List;
@@ -152,19 +153,9 @@ public class HiddenColumns
    */
   public void hideColumns(int start, int end)
   {
-    boolean wasAlreadyLocked = false;
     try
     {
-      // check if the write lock was already locked by this thread,
-      // as this method can be called internally in loops within HiddenColumns
-      if (!LOCK.isWriteLockedByCurrentThread())
-      {
-        LOCK.writeLock().lock();
-      }
-      else
-      {
-        wasAlreadyLocked = true;
-      }
+      LOCK.writeLock().lock();
 
       int previndex = 0;
       int prevHiddenCount = 0;
@@ -219,10 +210,7 @@ public class HiddenColumns
 
     } finally
     {
-      if (!wasAlreadyLocked)
-      {
-        LOCK.writeLock().unlock();
-      }
+      LOCK.writeLock().unlock();
     }
   }
 
@@ -395,158 +383,8 @@ public class HiddenColumns
     }
   }
 
-  /**
-   * Add gaps into the sequences aligned to profileseq under the given
-   * AlignmentView
-   * 
-   * @param profileseq
-   *          sequence in al which sequences are aligned to
-   * @param al
-   *          alignment to have gaps inserted into it
-   * @param input
-   *          alignment view where sequence corresponding to profileseq is first
-   *          entry
-   * @return new HiddenColumns for new alignment view, with insertions into
-   *         profileseq marked as hidden.
-   */
-  public static HiddenColumns propagateInsertions(SequenceI profileseq,
-          AlignmentI al, AlignmentView input)
-  {
-    int profsqpos = 0;
-
-    char gc = al.getGapCharacter();
-    Object[] alandhidden = input.getAlignmentAndHiddenColumns(gc);
-    HiddenColumns nview = (HiddenColumns) alandhidden[1];
-    SequenceI origseq = ((SequenceI[]) alandhidden[0])[profsqpos];
-    nview.propagateInsertions(profileseq, al, origseq);
-    return nview;
-  }
-
-  /**
-   * 
-   * @param profileseq
-   *          sequence in al which corresponds to origseq
-   * @param al
-   *          alignment which is to have gaps inserted into it
-   * @param origseq
-   *          sequence corresponding to profileseq which defines gap map for
-   *          modifying al
-   */
-  private void propagateInsertions(SequenceI profileseq, AlignmentI al,
-          SequenceI origseq)
-  {
-    try
-    {
-      LOCK.writeLock().lock();
 
-      char gc = al.getGapCharacter();
-
-      // take the set of hidden columns, and the set of gaps in origseq,
-      // and remove all the hidden gaps from hiddenColumns
-
-      // first get the non-gaps as a Bitset
-      // then calculate hidden ^ not(gap)
-      BitSet gaps = origseq.gapBitset();
-      this.andNot(gaps);
-
-      // for each sequence in the alignment, except the profile sequence,
-      // insert gaps corresponding to each hidden region but where each hidden
-      // column region is shifted backwards by the number of preceding visible
-      // gaps update hidden columns at the same time
-      List<int[]> newhidden = new ArrayList<>();
-
-      int numGapsBefore = 0;
-      int gapPosition = 0;
-      for (int[] region : hiddenColumns)
-      {
-        // get region coordinates accounting for gaps
-        // we can rely on gaps not being *in* hidden regions because we already
-        // removed those
-        while (gapPosition < region[0])
-        {
-          gapPosition++;
-          if (gaps.get(gapPosition))
-          {
-            numGapsBefore++;
-          }
-        }
-
-        int left = region[0] - numGapsBefore;
-        int right = region[1] - numGapsBefore;
-        newhidden.add(new int[] { left, right });
-
-        // make a string with number of gaps = length of hidden region
-        StringBuilder sb = new StringBuilder();
-        for (int s = 0; s < right - left + 1; s++)
-        {
-          sb.append(gc);
-        }
-        padGaps(sb, left, profileseq, al);
-
-      }
-      hiddenColumns = newhidden;
-      cursor.resetCursor(hiddenColumns);
-      numColumns = 0;
-    } finally
-    {
-      LOCK.writeLock().unlock();
-    }
-  }
 
-  /**
-   * Pad gaps in all sequences in alignment except profileseq
-   * 
-   * @param sb
-   *          gap string to insert
-   * @param left
-   *          position to insert at
-   * @param profileseq
-   *          sequence not to pad
-   * @param al
-   *          alignment to pad sequences in
-   */
-  private void padGaps(StringBuilder sb, int pos, SequenceI profileseq,
-          AlignmentI al)
-  {
-    // loop over the sequences and pad with gaps where required
-    for (int s = 0, ns = al.getHeight(); s < ns; s++)
-    {
-      SequenceI sqobj = al.getSequenceAt(s);
-      if (sqobj != profileseq)
-      {
-        String sq = al.getSequenceAt(s).getSequenceAsString();
-        if (sq.length() <= pos)
-        {
-          // pad sequence
-          int diff = pos - sq.length() - 1;
-          if (diff > 0)
-          {
-            // pad gaps
-            sq = sq + sb;
-            while ((diff = pos - sq.length() - 1) > 0)
-            {
-              if (diff >= sb.length())
-              {
-                sq += sb.toString();
-              }
-              else
-              {
-                char[] buf = new char[diff];
-                sb.getChars(0, diff, buf, 0);
-                sq += buf.toString();
-              }
-            }
-          }
-          sq += sb.toString();
-        }
-        else
-        {
-          al.getSequenceAt(s).setSequence(
-                  sq.substring(0, pos) + sb.toString() + sq.substring(pos));
-        }
-      }
-    }
-  }
 
   /*
    * Methods which only need read access to the hidden columns collection. 
@@ -634,12 +472,7 @@ public class HiddenColumns
     try
     {
       LOCK.readLock().lock();
-      int num = 0;
-      if (hasHiddenColumns())
-      {
-        num = hiddenColumns.size();
-      }
-      return num;
+      return hiddenColumns.size();
     } finally
     {
       LOCK.readLock().unlock();
@@ -668,16 +501,17 @@ public class HiddenColumns
         return false;
       }
 
+      Iterator<int[]> it = this.iterator();
       Iterator<int[]> thatit = that.iterator();
-      for (int[] thisRange : hiddenColumns)
+      while (it.hasNext())
       {
-        int[] thatRange = thatit.next();
-        if (thisRange[0] != thatRange[0] || thisRange[1] != thatRange[1])
+        if (!(Arrays.equals(it.next(), thatit.next())))
         {
           return false;
         }
       }
       return true;
+
     } finally
     {
       LOCK.readLock().unlock();
@@ -769,48 +603,25 @@ public class HiddenColumns
 
   /**
    * Find the visible column which is a given visible number of columns to the
-   * left of another visible column. i.e. for a startColumn x, the column which
-   * is distance 1 away will be column x-1.
+   * left (negative visibleDistance) or right (positive visibleDistance) of
+   * startColumn. If startColumn is not visible, we use the visible column at
+   * the left boundary of the hidden region containing startColumn.
    * 
    * @param visibleDistance
-   *          the number of visible columns to offset by
+   *          the number of visible columns to offset by (left offset = negative
+   *          value; right offset = positive value)
    * @param startColumn
-   *          the column to start from
-   * @return the position of the column in the visible alignment
+   *          the position of the column to start from (absolute position)
+   * @return the position of the column which is <visibleDistance> away
+   *         (absolute position)
    */
-  public int subtractVisibleColumns(int visibleDistance, int startColumn)
+  public int offsetByVisibleColumns(int visibleDistance, int startColumn)
   {
     try
     {
       LOCK.readLock().lock();
-      int distance = visibleDistance;
-
-      // in case startColumn is in a hidden region, move it to the left
-      int start = visibleToAbsoluteColumn(absoluteToVisibleColumn(startColumn));
-
-      Iterator<int[]> it = new ReverseRegionsIterator(0, start,
-              hiddenColumns);
-
-      while (it.hasNext() && (distance > 0))
-      {
-        int[] region = it.next();
-
-        if (start > region[1])
-        {
-          // subtract the gap to right of region from distance
-          if (start - region[1] <= distance)
-          {
-            distance -= start - region[1];
-            start = region[0] - 1;
-          }
-          else
-          {
-            start = start - distance;
-            distance = 0;
-          }
-        }
-      }
-      return start - distance;
+      int start = absoluteToVisibleColumn(startColumn);
+      return visibleToAbsoluteColumn(start + visibleDistance);
 
     } finally
     {
@@ -828,7 +639,7 @@ public class HiddenColumns
    * @return the index of the next hidden column, or alPos if there is no next
    *         hidden column
    */
-  public int getHiddenBoundaryRight(int alPos)
+  public int getNextHiddenBoundary(boolean left, int alPos)
   {
     try
     {
@@ -836,7 +647,13 @@ public class HiddenColumns
       if (!hiddenColumns.isEmpty())
       {
         int index = cursor.findRegionForColumn(alPos).getRegionIndex();
-        if (index < hiddenColumns.size())
+
+        if (left && index > 0)
+        {
+          int[] region = hiddenColumns.get(index - 1);
+          return region[1];
+        }
+        else if (!left && index < hiddenColumns.size())
         {
           int[] region = hiddenColumns.get(index);
           if (alPos < region[0])
@@ -861,38 +678,6 @@ public class HiddenColumns
   }
 
   /**
-   * This method returns the leftmost limit of a region of an alignment with
-   * hidden columns. In otherwords, the previous hidden column.
-   * 
-   * @param alPos
-   *          the absolute (visible) alignmentPosition to find the previous
-   *          hidden column for
-   */
-  public int getHiddenBoundaryLeft(int alPos)
-  {
-    try
-    {
-      LOCK.readLock().lock();
-
-      if (!hiddenColumns.isEmpty())
-      {
-        int index = cursor.findRegionForColumn(alPos).getRegionIndex();
-
-        if (index > 0)
-        {
-          int[] region = hiddenColumns.get(index - 1);
-          return region[1];
-        }
-      }
-      return alPos;
-    } finally
-    {
-      LOCK.readLock().unlock();
-    }
-  }
-
-
-  /**
    * Answers if a column in the alignment is visible
    * 
    * @param column
@@ -925,67 +710,6 @@ public class HiddenColumns
   }
 
   /**
-   * Get the visible sections of a set of sequences
-   * 
-   * @param start
-   *          sequence position to start from
-   * @param end
-   *          sequence position to end at
-   * @param seqs
-   *          an array of sequences
-   * @return an array of strings encoding the visible parts of each sequence
-   */
-  public String[] getVisibleSequenceStrings(int start, int end,
-          SequenceI[] seqs)
-  {
-    try
-    {
-      LOCK.readLock().lock();
-      int iSize = seqs.length;
-      String[] selections = new String[iSize];
-      if (!hiddenColumns.isEmpty())
-      {
-        for (int i = 0; i < iSize; i++)
-        {
-          StringBuilder visibleSeq = new StringBuilder();
-
-          Iterator<int[]> blocks = new VisibleContigsIterator(start,
-                  end + 1, hiddenColumns);
-
-          while (blocks.hasNext())
-          {
-            int[] block = blocks.next();
-            if (blocks.hasNext())
-            {
-              visibleSeq
-                      .append(seqs[i].getSequence(block[0], block[1] + 1));
-            }
-            else
-            {
-              visibleSeq
-                      .append(seqs[i].getSequence(block[0], block[1]));
-            }
-          }
-
-          selections[i] = visibleSeq.toString();
-        }
-      }
-      else
-      {
-        for (int i = 0; i < iSize; i++)
-        {
-          selections[i] = seqs[i].getSequenceAsString(start, end);
-        }
-      }
-
-      return selections;
-    } finally
-    {
-      LOCK.readLock().unlock();
-    }
-  }
-
-  /**
    * Locate the first position visible for this sequence. If seq isn't visible
    * then return the position of the left side of the hidden boundary region.
    * 
@@ -1225,14 +949,14 @@ public class HiddenColumns
 
   /**
    * 
-   * @param inserts
+   * @param updates
    *          BitSet where hidden columns will be marked
    */
-  private void andNot(BitSet updates)
+  protected void andNot(BitSet updates)
   {
     try
     {
-      LOCK.readLock().lock();
+      LOCK.writeLock().lock();
 
       BitSet hiddenBitSet = new BitSet();
       for (int[] range : hiddenColumns)
@@ -1244,7 +968,7 @@ public class HiddenColumns
       hideColumns(hiddenBitSet);
     } finally
     {
-      LOCK.readLock().unlock();
+      LOCK.writeLock().unlock();
     }
   }
 
@@ -1260,42 +984,27 @@ public class HiddenColumns
     try
     {
       LOCK.readLock().lock();
-      int[] alignmentStartEnd = new int[] { 0, width - 1 };
-      int startPos = alignmentStartEnd[0];
-      int endPos = alignmentStartEnd[1];
 
-      int[] lowestRange = new int[] { -1, -1 };
-      int[] higestRange = new int[] { -1, -1 };
+      int firstVisible = 0;
+      int lastVisible = width - 1;
 
-      if (hiddenColumns.isEmpty())
-      {
-        return new int[] { startPos, endPos };
-      }
-
-      for (int[] range : hiddenColumns)
+      if (!hiddenColumns.isEmpty())
       {
-        lowestRange = (range[0] <= startPos) ? range : lowestRange;
-        higestRange = (range[1] >= endPos) ? range : higestRange;
-      }
+        // first visible col with index 0, convert to absolute index
+        firstVisible = visibleToAbsoluteColumn(0);
 
-      if (lowestRange[0] == -1) // includes (lowestRange[1] == -1)
-      {
-        startPos = alignmentStartEnd[0];
-      }
-      else
-      {
-        startPos = lowestRange[1] + 1;
+        // last visible column is either immediately to left of
+        // last hidden region, or is just the last column in the alignment
+        int[] lastregion = hiddenColumns.get(hiddenColumns.size() - 1);
+        if (lastregion[1] == width - 1)
+        {
+          // last region is at very end of alignment
+          // last visible column immediately precedes it
+          lastVisible = lastregion[0] - 1;
+        }
       }
+      return new int[] { firstVisible, lastVisible };
 
-      if (higestRange[0] == -1) // includes (higestRange[1] == -1)
-      {
-        endPos = alignmentStartEnd[1];
-      }
-      else
-      {
-        endPos = higestRange[0] - 1;
-      }
-      return new int[] { startPos, endPos };
     } finally
     {
       LOCK.readLock().unlock();