JAL-2759 change subtractVisibleColumns and removal of reverse iterator
[jalview.git] / src / jalview / datamodel / HiddenColumns.java
index 6677151..ea8da8d 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;
@@ -444,15 +445,10 @@ public class HiddenColumns
       // take the set of hidden columns, and the set of gaps in origseq,
       // and remove all the hidden gaps from hiddenColumns
 
-      // first get the gaps as a Bitset
+      // first get the non-gaps as a Bitset
+      // then calculate hidden ^ not(gap)
       BitSet gaps = origseq.gapBitset();
-
-      // now calculate hidden ^ not(gap)
-      BitSet hidden = new BitSet();
-      markHiddenRegions(hidden);
-      hidden.andNot(gaps);
-      hiddenColumns.clear();
-      this.hideColumns(hidden);
+      this.andNot(gaps);
 
       // for each sequence in the alignment, except the profile sequence,
       // insert gaps corresponding to each hidden region but where each hidden
@@ -481,7 +477,7 @@ public class HiddenColumns
         newhidden.add(new int[] { left, right });
 
         // make a string with number of gaps = length of hidden region
-        StringBuffer sb = new StringBuffer();
+        StringBuilder sb = new StringBuilder();
         for (int s = 0; s < right - left + 1; s++)
         {
           sb.append(gc);
@@ -510,7 +506,7 @@ public class HiddenColumns
    * @param al
    *          alignment to pad sequences in
    */
-  private void padGaps(StringBuffer sb, int pos, SequenceI profileseq,
+  private void padGaps(StringBuilder sb, int pos, SequenceI profileseq,
           AlignmentI al)
   {
     // loop over the sequences and pad with gaps where required
@@ -639,12 +635,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();
@@ -673,16 +664,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();
@@ -774,48 +766,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
     {
@@ -952,7 +921,7 @@ public class HiddenColumns
       {
         for (int i = 0; i < iSize; i++)
         {
-          StringBuffer visibleSeq = new StringBuffer();
+          StringBuilder visibleSeq = new StringBuilder();
 
           Iterator<int[]> blocks = new VisibleContigsIterator(start,
                   end + 1, hiddenColumns);
@@ -1058,119 +1027,6 @@ public class HiddenColumns
     }
   }
 
-  /**
-   * delete any columns in alignmentAnnotation that are hidden (including
-   * sequence associated annotation).
-   * 
-   * @param alignmentAnnotation
-   */
-  public void makeVisibleAnnotation(AlignmentAnnotation alignmentAnnotation)
-  {
-    if (alignmentAnnotation != null
-            && alignmentAnnotation.annotations != null)
-    {
-      makeVisibleAnnotation(0, alignmentAnnotation.annotations.length,
-            alignmentAnnotation);
-    }
-  }
-
-  /**
-   * delete any columns in alignmentAnnotation that are hidden (including
-   * sequence associated annotation).
-   * 
-   * @param start
-   *          remove any annotation to the right of this column
-   * @param end
-   *          remove any annotation to the left of this column
-   * @param alignmentAnnotation
-   *          the annotation to operate on
-   */
-  public void makeVisibleAnnotation(int start, int end,
-          AlignmentAnnotation alignmentAnnotation)
-  {
-    try
-    {
-      LOCK.readLock().lock();
-
-      int startFrom = start;
-      int endAt = end;
-
-      if (alignmentAnnotation != null
-              && alignmentAnnotation.annotations != null)
-      {
-        if (!hiddenColumns.isEmpty())
-        {
-          removeHiddenAnnotation(startFrom, endAt, alignmentAnnotation);
-        }
-        else
-        {
-          alignmentAnnotation.restrict(startFrom, endAt);
-        }
-      }
-    } finally
-    {
-      LOCK.readLock().unlock();
-    }
-  }
-
-  private void removeHiddenAnnotation(int start, int end,
-          AlignmentAnnotation alignmentAnnotation)
-  {
-    // mangle the alignmentAnnotation annotation array
-    ArrayList<Annotation[]> annels = new ArrayList<>();
-    Annotation[] els = null;
-
-    int w = 0;
-    
-    Iterator<int[]> blocks = new VisibleContigsIterator(start, end + 1,
-            hiddenColumns);
-
-    int copylength;
-    int annotationLength;
-    while (blocks.hasNext())
-    {
-      int[] block = blocks.next();
-      annotationLength = block[1] - block[0] + 1;
-    
-      if (blocks.hasNext())
-      {
-        // copy just the visible segment of the annotation row
-        copylength = annotationLength;
-      }
-      else
-      {
-        if (annotationLength + block[0] <= alignmentAnnotation.annotations.length)
-        {
-          // copy just the visible segment of the annotation row
-          copylength = annotationLength;
-        }
-        else
-        {
-          // copy to the end of the annotation row
-          copylength = alignmentAnnotation.annotations.length - block[0];
-        }
-      }
-      
-      els = new Annotation[annotationLength];
-      annels.add(els);
-      System.arraycopy(alignmentAnnotation.annotations, block[0], els, 0,
-              copylength);
-      w += annotationLength;
-    }
-    
-    if (w != 0)
-    {
-      alignmentAnnotation.annotations = new Annotation[w];
-
-      w = 0;
-      for (Annotation[] chnk : annels)
-      {
-        System.arraycopy(chnk, 0, alignmentAnnotation.annotations, w,
-                chnk.length);
-        w += chnk.length;
-      }
-    }
-  }
 
   /**
    * 
@@ -1234,7 +1090,7 @@ public class HiddenColumns
    * Hide columns corresponding to the marked bits
    * 
    * @param inserts
-   *          - columns map to bits starting from zero
+   *          - columns mapped to bits starting from zero
    */
   public void hideColumns(BitSet inserts)
   {
@@ -1257,20 +1113,109 @@ public class HiddenColumns
   }
 
   /**
+   * Hide columns corresponding to the marked bits, within the range
+   * [start,end]. Entries in tohide which are outside [start,end] are ignored.
+   * 
+   * @param tohide
+   *          columns mapped to bits starting from zero
+   * @param start
+   *          start of range to hide columns within
+   * @param end
+   *          end of range to hide columns within
+   */
+  public void hideColumns(BitSet tohide, int start, int end)
+  {
+    clearHiddenColumnsInRange(start, end);
+
+    // make sure only bits between start and end are set
+    if (!tohide.isEmpty())
+    {
+      tohide.clear(0, start);
+      tohide.clear(Math.min(end + 1, tohide.length() + 1),
+              tohide.length() + 1);
+    }
+
+    hideColumns(tohide);
+  }
+
+  /**
+   * Make all columns in the range [start,end] visible
+   * 
+   * @param start
+   *          start of range to show columns
+   * @param end
+   *          end of range to show columns
+   */
+  private void clearHiddenColumnsInRange(int start, int end)
+  {
+    try
+    {
+      LOCK.writeLock().lock();
+      
+      if (!hiddenColumns.isEmpty())
+      {
+        HiddenCursorPosition pos = cursor.findRegionForColumn(start);
+        int index = pos.getRegionIndex();
+        int startindex = index; // first index in hiddenColumns to remove
+
+        if (index != -1 && index != hiddenColumns.size())
+        {
+          // regionIndex is the region which either contains start
+          // or lies to the right of start
+          int[] region = hiddenColumns.get(index);
+          if (region[0] < start && region[1] >= start)
+          {
+            // region contains start, truncate so that it ends just before start
+            region[1] = start - 1;
+            startindex++;
+          }
+        }
+
+        pos = cursor.findRegionForColumn(end);
+        index = pos.getRegionIndex();
+        int endindex = index - 1; // last index in hiddenColumns to remove
+
+        if (index != -1 && index != hiddenColumns.size())
+        {
+          // regionIndex is the region which either contains end
+          // or lies to the right of end
+          int[] region = hiddenColumns.get(index);
+          if (region[0] <= end && region[1] > end)
+          {
+            // region contains end, truncate so that it starts just after end
+            region[0] = end + 1;
+          }
+        }
+
+        hiddenColumns.subList(startindex, endindex + 1).clear();
+        cursor.resetCursor(hiddenColumns);
+        numColumns = 0;
+      }
+    } finally
+    {
+      LOCK.writeLock().unlock();
+    }
+  }
+
+  /**
    * 
    * @param inserts
    *          BitSet where hidden columns will be marked
    */
-  public void markHiddenRegions(BitSet inserts)
+  private void andNot(BitSet updates)
   {
     try
     {
       LOCK.readLock().lock();
 
+      BitSet hiddenBitSet = new BitSet();
       for (int[] range : hiddenColumns)
       {
-        inserts.set(range[0], range[1] + 1);
+        hiddenBitSet.set(range[0], range[1] + 1);
       }
+      hiddenBitSet.andNot(updates);
+      hiddenColumns.clear();
+      hideColumns(hiddenBitSet);
     } finally
     {
       LOCK.readLock().unlock();