JAL-2591 More HiddenColumns refactoring. Tests passing.
[jalview.git] / src / jalview / datamodel / HiddenColumns.java
index 0036402..b53fc8b 100644 (file)
@@ -1,3 +1,23 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.datamodel;
 
 import jalview.util.Comparison;
@@ -6,14 +26,13 @@ import jalview.util.ShiftList;
 import java.util.ArrayList;
 import java.util.BitSet;
 import java.util.Collections;
-import java.util.Iterator;
 import java.util.List;
 import java.util.Vector;
 import java.util.concurrent.locks.ReentrantReadWriteLock;
 
-public class HiddenColumns implements Iterable<int[]>
+public class HiddenColumns
 {
-  private static final ReentrantReadWriteLock lock = new ReentrantReadWriteLock();
+  private static final ReentrantReadWriteLock LOCK = new ReentrantReadWriteLock();
   
   /*
    * list of hidden column [start, end] ranges; the list is maintained in
@@ -26,7 +45,7 @@ public class HiddenColumns implements Iterable<int[]>
    * 
    * @return empty list or List of hidden column intervals
    */
-  public List<int[]> getHiddenRegions()
+  private List<int[]> getHiddenRegions()
   {
     return hiddenColumns == null ? Collections.<int[]> emptyList()
             : hiddenColumns;
@@ -46,19 +65,22 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       StringBuilder regionBuilder = new StringBuilder();
-      for (int[] range : hiddenColumns)
+      if (hiddenColumns != null)
       {
-        regionBuilder.append(delimiter).append(range[0]).append(between)
-                .append(range[1]);
-      }
+        for (int[] range : hiddenColumns)
+        {
+          regionBuilder.append(delimiter).append(range[0]).append(between)
+                  .append(range[1]);
+        }
 
-      regionBuilder.deleteCharAt(0);
+        regionBuilder.deleteCharAt(0);
+      }
       return regionBuilder.toString();
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -71,7 +93,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       int size = 0;
       if (hasHidden())
       {
@@ -84,7 +106,7 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -97,11 +119,11 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       return (hiddenColumns != null) && (!hiddenColumns.isEmpty());
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
 
   }
@@ -111,7 +133,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
 
       if (!(obj instanceof HiddenColumns))
       {
@@ -143,7 +165,7 @@ public class HiddenColumns implements Iterable<int[]>
       return true;
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -158,7 +180,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       int result = column;
       if (hiddenColumns != null)
       {
@@ -174,7 +196,7 @@ public class HiddenColumns implements Iterable<int[]>
       return result;
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -191,7 +213,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       int result = hiddenColumn;
       if (hiddenColumns != null)
       {
@@ -233,7 +255,7 @@ public class HiddenColumns implements Iterable<int[]>
                      // columns.
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -253,7 +275,7 @@ public class HiddenColumns implements Iterable<int[]>
     try
     {
 
-      lock.readLock().lock();
+      LOCK.readLock().lock();
     int distance = visibleDistance;
 
     // in case startColumn is in a hidden region, move it to the left
@@ -297,7 +319,7 @@ public class HiddenColumns implements Iterable<int[]>
     return start - distance;
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
 
   }
@@ -311,37 +333,45 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
-      List<Integer> positions = new ArrayList<>(
-              hiddenColumns.size());
+      LOCK.readLock().lock();
+      List<Integer> positions = null;
 
-      positions.add(hiddenColumns.elementAt(0)[0]);
-      for (int i = 1; i < hiddenColumns.size(); ++i)
+      if (hiddenColumns != null)
       {
+        positions = new ArrayList<>(hiddenColumns.size());
 
-        int result = 0;
-        if (hiddenColumns != null)
+        positions.add(hiddenColumns.elementAt(0)[0]);
+        for (int i = 1; i < hiddenColumns.size(); ++i)
         {
-          int index = 0;
-          int gaps = 0;
-          do
+
+          int result = 0;
+          if (hiddenColumns != null)
           {
-            int[] region = hiddenColumns.elementAt(index);
-            gaps += region[1] + 1 - region[0];
-            result = region[1] + 1;
-            index++;
-          } while (index <= i);
+            int index = 0;
+            int gaps = 0;
+            do
+            {
+              int[] region = hiddenColumns.elementAt(index);
+              gaps += region[1] + 1 - region[0];
+              result = region[1] + 1;
+              index++;
+            } while (index <= i);
 
-          result -= gaps;
+            result -= gaps;
+          }
+          positions.add(result);
         }
-        positions.add(result);
+      }
+      else
+      {
+        positions = new ArrayList<>();
       }
 
       return positions;
     }
     finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -356,7 +386,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       if (hiddenColumns != null)
       {
         int index = 0;
@@ -375,7 +405,7 @@ public class HiddenColumns implements Iterable<int[]>
       return alPos;
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
 
   }
@@ -391,7 +421,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
 
     if (hiddenColumns != null)
     {
@@ -411,7 +441,7 @@ public class HiddenColumns implements Iterable<int[]>
     return alPos;
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -428,7 +458,7 @@ public class HiddenColumns implements Iterable<int[]>
     try
     {
 
-      lock.readLock().lock();
+      LOCK.readLock().lock();
     if (hiddenColumns != null)
     {
       int index = hiddenColumns.size() - 1;
@@ -447,7 +477,7 @@ public class HiddenColumns implements Iterable<int[]>
     return -1;
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
 
   }
@@ -476,69 +506,69 @@ public class HiddenColumns implements Iterable<int[]>
 
       if (!alreadyLocked)
       {
-        lock.writeLock().lock();
+        LOCK.writeLock().lock();
       }
 
-    if (hiddenColumns == null)
-    {
-      hiddenColumns = new Vector<>();
-    }
-
-    /*
-     * traverse existing hidden ranges and insert / amend / append as
-     * appropriate
-     */
-    for (int i = 0; i < hiddenColumns.size(); i++)
-    {
-      int[] region = hiddenColumns.elementAt(i);
-
-      if (end < region[0] - 1)
+      if (hiddenColumns == null)
       {
-        /*
-         * insert discontiguous preceding range
-         */
-        hiddenColumns.insertElementAt(new int[] { start, end }, i);
-        return;
+        hiddenColumns = new Vector<>();
       }
 
-      if (end <= region[1])
+      /*
+       * traverse existing hidden ranges and insert / amend / append as
+       * appropriate
+       */
+      for (int i = 0; i < hiddenColumns.size(); i++)
       {
-        /*
-         * new range overlaps existing, or is contiguous preceding it - adjust
-         * start column
-         */
-        region[0] = Math.min(region[0], start);
-        return;
-      }
+        int[] region = hiddenColumns.elementAt(i);
 
-      if (start <= region[1] + 1)
-      {
-        /*
-         * new range overlaps existing, or is contiguous following it - adjust
-         * start and end columns
-         */
-        region[0] = Math.min(region[0], start);
-        region[1] = Math.max(region[1], end);
-
-        /*
-         * also update or remove any subsequent ranges 
-         * that are overlapped
-         */
-        while (i < hiddenColumns.size() - 1)
+        if (end < region[0] - 1)
+        {
+          /*
+           * insert discontiguous preceding range
+           */
+          hiddenColumns.insertElementAt(new int[] { start, end }, i);
+          return;
+        }
+
+        if (end <= region[1])
         {
-          int[] nextRegion = hiddenColumns.get(i + 1);
-          if (nextRegion[0] > end + 1)
+          /*
+           * new range overlaps existing, or is contiguous preceding it - adjust
+           * start column
+           */
+          region[0] = Math.min(region[0], start);
+          return;
+        }
+
+        if (start <= region[1] + 1)
+        {
+          /*
+           * new range overlaps existing, or is contiguous following it - adjust
+           * start and end columns
+           */
+          region[0] = Math.min(region[0], start);
+          region[1] = Math.max(region[1], end);
+
+          /*
+           * also update or remove any subsequent ranges 
+           * that are overlapped
+           */
+          while (i < hiddenColumns.size() - 1)
           {
-            /*
-             * gap to next hidden range - no more to update
-             */
-            break;
+            int[] nextRegion = hiddenColumns.get(i + 1);
+            if (nextRegion[0] > end + 1)
+            {
+              /*
+               * gap to next hidden range - no more to update
+               */
+              break;
+            }
+            region[1] = Math.max(nextRegion[1], end);
+            hiddenColumns.remove(i + 1);
           }
-          region[1] = Math.max(nextRegion[1], end);
-          hiddenColumns.remove(i + 1);
+          return;
         }
-        return;
-      }
     }
 
     /*
@@ -549,7 +579,7 @@ public class HiddenColumns implements Iterable<int[]>
     {
       if (!alreadyLocked)
       {
-        lock.writeLock().unlock();
+        LOCK.writeLock().unlock();
       }
     }
   }
@@ -558,7 +588,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
 
     if (hiddenColumns != null)
     {
@@ -574,7 +604,7 @@ public class HiddenColumns implements Iterable<int[]>
     return true;
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -595,7 +625,7 @@ public class HiddenColumns implements Iterable<int[]>
     try
     {
 
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       if (copy != null)
       {
         if (copy.hiddenColumns != null)
@@ -606,7 +636,7 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -615,7 +645,8 @@ public class HiddenColumns implements Iterable<int[]>
     Vector<int[]> copy = new Vector<>(hiddenColumns.size());
     for (int i = 0, j = hiddenColumns.size(); i < j; i++)
     {
-      int[] rh, cp;
+      int[] rh;
+      int[] cp;
       rh = hiddenColumns.elementAt(i);
       if (rh != null)
       {
@@ -629,10 +660,17 @@ public class HiddenColumns implements Iterable<int[]>
 
   private ArrayList<int[]> copyHiddenRegionsToArrayList()
   {
-    ArrayList<int[]> copy = new ArrayList<>(hiddenColumns.size());
-    for (int i = 0, j = hiddenColumns.size(); i < j; i++)
+    int size = 0;
+    if (hiddenColumns != null)
     {
-      int[] rh, cp;
+      size = hiddenColumns.size();
+    }
+    ArrayList<int[]> copy = new ArrayList<>(size);
+
+    for (int i = 0, j = size; i < j; i++)
+    {
+      int[] rh;
+      int[] cp;
       rh = hiddenColumns.elementAt(i);
       if (rh != null)
       {
@@ -641,30 +679,46 @@ public class HiddenColumns implements Iterable<int[]>
         copy.add(cp);
       }
     }
+
     return copy;
   }
 
-  public void getHiddenColumnsCopy(Vector<int[]> copy)
+  /**
+   * Returns a copy of the vector of hidden regions, as a vector. Before using
+   * this method please consider if you really need access to the hidden regions
+   * - a new (or existing!) method on HiddenColumns might be more appropriate.
+   * 
+   * @return hidden regions as vector of [start,end] pairs
+   */
+  public Vector<int[]> getHiddenColumnsCopy()
   {
     try
     {
-      lock.readLock().lock();
-      copy = copyHiddenRegions();
+      LOCK.readLock().lock();
+      return copyHiddenRegions();
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
-  public void getHiddenColumnsCopy(ArrayList<int[]> copy)
+  /**
+   * Returns a copy of the vector of hidden regions, as an ArrayList. Before
+   * using this method please consider if you really need access to the hidden
+   * regions - a new (or existing!) method on HiddenColumns might be more
+   * appropriate.
+   * 
+   * @return hidden regions as an ArrayList of [start,end] pairs
+   */
+  public ArrayList<int[]> getHiddenColumnsCopyAsList()
   {
     try
     {
-      lock.readLock().lock();
-      copy = copyHiddenRegionsToArrayList();
+      LOCK.readLock().lock();
+      return copyHiddenRegionsToArrayList();
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -681,7 +735,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.writeLock().lock();
+      LOCK.writeLock().lock();
       List<int[]> deletedHiddenColumns = null;
 
       if (hiddenColumns != null)
@@ -720,7 +774,7 @@ public class HiddenColumns implements Iterable<int[]>
       return deletedHiddenColumns;
     } finally
     {
-      lock.writeLock().unlock();
+      LOCK.writeLock().unlock();
     }
   }
 
@@ -737,7 +791,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.writeLock().lock();
+      LOCK.writeLock().lock();
       if (hiddenColumns != null)
       {
         for (int i = 0; i < hiddenColumns.size(); i++)
@@ -769,7 +823,7 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.writeLock().unlock();
+      LOCK.writeLock().unlock();
     }
   }
 
@@ -787,7 +841,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       if (hiddenColumns != null && hiddenColumns.size() > 0)
       {
         List<int[]> visiblecontigs = new ArrayList<>();
@@ -795,7 +849,8 @@ public class HiddenColumns implements Iterable<int[]>
 
         int vstart = start;
         int[] region;
-        int hideStart, hideEnd;
+        int hideStart;
+        int hideEnd;
 
         for (int j = 0; vstart < end && j < regions.size(); j++)
         {
@@ -836,7 +891,7 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -845,19 +900,21 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
-      int i, iSize = seqs.length;
+      LOCK.readLock().lock();
+      int iSize = seqs.length;
       String selections[] = new String[iSize];
       if (hiddenColumns != null && hiddenColumns.size() > 0)
       {
-        for (i = 0; i < iSize; i++)
+        for (int i = 0; i < iSize; i++)
         {
           StringBuffer visibleSeq = new StringBuffer();
           List<int[]> regions = getHiddenRegions();
 
-          int blockStart = start, blockEnd = end;
+          int blockStart = start;
+          int blockEnd = end;
           int[] region;
-          int hideStart, hideEnd;
+          int hideStart;
+          int hideEnd;
 
           for (int j = 0; j < regions.size(); j++)
           {
@@ -894,7 +951,7 @@ public class HiddenColumns implements Iterable<int[]>
       }
       else
       {
-        for (i = 0; i < iSize; i++)
+        for (int i = 0; i < iSize; i++)
         {
           selections[i] = seqs[i].getSequenceAsString(start, end);
         }
@@ -904,7 +961,7 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -922,23 +979,30 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
-      int fpos = seq.getStart(), lpos = seq.getEnd();
+      LOCK.readLock().lock();
+      int fpos = seq.getStart();
+      int lpos = seq.getEnd();
       int start = 0;
 
       if (hiddenColumns == null || hiddenColumns.size() == 0)
       {
-        int ifpos = seq.findIndex(fpos) - 1,
-                ilpos = seq.findIndex(lpos) - 1;
+        int ifpos = seq.findIndex(fpos) - 1;
+        int ilpos = seq.findIndex(lpos) - 1;
         return new int[] { ifpos, ilpos, fpos, lpos, ifpos, ilpos };
       }
 
       // Simply walk along the sequence whilst watching for hidden column
       // boundaries
       List<int[]> regions = getHiddenRegions();
-      int spos = fpos, lastvispos = -1, rcount = 0,
-              hideStart = seq.getLength(), hideEnd = -1;
-      int visPrev = 0, visNext = 0, firstP = -1, lastP = -1;
+      int spos = fpos;
+      int lastvispos = -1;
+      int rcount = 0;
+      int hideStart = seq.getLength();
+      int hideEnd = -1;
+      int visPrev = 0;
+      int visNext = 0;
+      int firstP = -1;
+      int lastP = -1;
       boolean foundStart = false;
       for (int p = 0, pLen = seq.getLength(); spos <= seq.getEnd()
               && p < pLen; p++)
@@ -991,7 +1055,7 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -1022,7 +1086,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       if (alignmentAnnotation.annotations == null)
       {
         return;
@@ -1038,9 +1102,12 @@ public class HiddenColumns implements Iterable<int[]>
         Vector<Annotation[]> annels = new Vector<>();
         Annotation[] els = null;
         List<int[]> regions = getHiddenRegions();
-        int blockStart = start, blockEnd = end;
+        int blockStart = start;
+        int blockEnd = end;
         int[] region;
-        int hideStart, hideEnd, w = 0;
+        int hideStart;
+        int hideEnd;
+        int w = 0;
 
         for (int j = 0; j < regions.size(); j++)
         {
@@ -1110,7 +1177,7 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -1122,11 +1189,11 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       return hiddenColumns != null && hiddenColumns.size() > 0;
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -1138,11 +1205,11 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       return hiddenColumns != null && hiddenColumns.size() > 1;
     } finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -1156,7 +1223,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.writeLock().lock();
+      LOCK.writeLock().lock();
       List<int[]> inserts = sr.getInsertions();
       for (int[] r : inserts)
       {
@@ -1164,7 +1231,7 @@ public class HiddenColumns implements Iterable<int[]>
       }
     } finally
     {
-      lock.writeLock().unlock();
+      LOCK.writeLock().unlock();
     }
   }
 
@@ -1175,7 +1242,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.writeLock().lock();
+      LOCK.writeLock().lock();
       if (hiddenColumns != null)
       {
         for (int i = 0; i < hiddenColumns.size(); i++)
@@ -1192,7 +1259,7 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.writeLock().unlock();
+      LOCK.writeLock().unlock();
     }
   }
 
@@ -1206,7 +1273,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.writeLock().lock();
+      LOCK.writeLock().lock();
       for (int i = 0; i < hiddenColumns.size(); i++)
       {
         int[] region = hiddenColumns.elementAt(i);
@@ -1228,7 +1295,7 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.writeLock().unlock();
+      LOCK.writeLock().unlock();
     }
   }
 
@@ -1244,7 +1311,10 @@ public class HiddenColumns implements Iterable<int[]>
           Vector<int[]> intervals)
   {
     boolean pruned = false;
-    int i = 0, j = intervals.size() - 1, s = 0, t = shifts.size() - 1;
+    int i = 0;
+    int j = intervals.size() - 1;
+    int s = 0;
+    int t = shifts.size() - 1;
     int hr[] = intervals.elementAt(i);
     int sr[] = shifts.get(s);
     while (i <= j && s <= t)
@@ -1337,7 +1407,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.writeLock().lock();
+      LOCK.writeLock().lock();
       // delete any intervals intersecting.
       if (hiddenColumns != null)
       {
@@ -1350,7 +1420,7 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.writeLock().unlock();
+      LOCK.writeLock().unlock();
     }
   }
 
@@ -1552,7 +1622,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       int hashCode = 1;
       if (hiddenColumns != null)
       {
@@ -1566,7 +1636,7 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
@@ -1580,7 +1650,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.writeLock().lock();
+      LOCK.writeLock().lock();
       for (int firstSet = inserts
               .nextSetBit(0), lastSet = 0; firstSet >= 0; firstSet = inserts
                       .nextSetBit(lastSet))
@@ -1590,7 +1660,7 @@ public class HiddenColumns implements Iterable<int[]>
       }
     } finally
     {
-      lock.writeLock().unlock();
+      LOCK.writeLock().unlock();
     }
   }
 
@@ -1603,7 +1673,7 @@ public class HiddenColumns implements Iterable<int[]>
   {
     try
     {
-      lock.readLock().lock();
+      LOCK.readLock().lock();
       if (hiddenColumns == null)
       {
         return;
@@ -1615,18 +1685,96 @@ public class HiddenColumns implements Iterable<int[]>
     }
     finally
     {
-      lock.readLock().unlock();
+      LOCK.readLock().unlock();
     }
   }
 
-  @Override
-  public Iterator<int[]> iterator()
+  /**
+   * Calculate the visible start and end index of an alignment.
+   * 
+   * @param width
+   *          full alignment width
+   * @return integer array where: int[0] = startIndex, and int[1] = endIndex
+   */
+  public int[] getVisibleStartAndEndIndex(int width)
+  {
+    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 };
+
+      if (hiddenColumns == null)
+      {
+        return new int[] { startPos, endPos };
+      }
+
+      for (int[] hiddenCol : hiddenColumns)
+      {
+        lowestRange = (hiddenCol[0] <= startPos) ? hiddenCol : lowestRange;
+        higestRange = (hiddenCol[1] >= endPos) ? hiddenCol : higestRange;
+      }
+
+      if (lowestRange[0] == -1 && lowestRange[1] == -1)
+      {
+        startPos = alignmentStartEnd[0];
+      }
+      else
+      {
+        startPos = lowestRange[1] + 1;
+      }
+
+      if (higestRange[0] == -1 && higestRange[1] == -1)
+      {
+        endPos = alignmentStartEnd[1];
+      }
+      else
+      {
+        endPos = higestRange[0] - 1;
+      }
+      return new int[] { startPos, endPos };
+    } finally
+    {
+      LOCK.readLock().unlock();
+    }
+
+  }
+
+  /**
+   * Finds the hidden region (if any) which starts or ends at res
+   * 
+   * @param res
+   *          visible residue position, unadjusted for hidden columns
+   * @return region as [start,end] or null if no matching region is found
+   */
+  public int[] getRegionWithEdgeAtRes(int res)
   {
-    if (hiddenColumns == null)
+    try
+    {
+      LOCK.readLock().lock();
+      int adjres = adjustForHiddenColumns(res);
+
+      int[] reveal = null;
+      if (hiddenColumns != null)
+      {
+        for (int[] region : hiddenColumns)
+        {
+          if (adjres + 1 == region[0] || adjres - 1 == region[1])
+          {
+            reveal = region;
+            break;
+          }
+        }
+      }
+      return reveal;
+    } finally
     {
-      return Collections.<int[]> emptyList().iterator();
+      LOCK.readLock().unlock();
     }
-    return hiddenColumns.iterator();
   }
 
 }