src/jalview/datamodel/HiddenColumns.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.datamodel;
  22
  23 import java.util.ArrayList;
  24 import java.util.Arrays;
  25 import java.util.BitSet;
  26 import java.util.Iterator;
  27 import java.util.List;
  28 import java.util.concurrent.locks.ReentrantReadWriteLock;
  29
  30 /**
  31  * This class manages the collection of hidden columns associated with an
  32  * alignment. To iterate over the collection, or over visible columns/regions,
  33  * use an iterator obtained from one of:
  34  *
  35  * - getBoundedIterator: iterates over the hidden regions, within some bounds,
  36  * returning *absolute* positions
  37  *
  38  * - getBoundedStartIterator: iterates over the start positions of hidden
  39  * regions, within some bounds, returning *visible* positions
  40  *
  41  * - getVisContigsIterator: iterates over visible regions in a range, returning
  42  * *absolute* positions
  43  *
  44  * - getVisibleColsIterator: iterates over the visible *columns*
  45  *
  46  * For performance reasons, provide bounds where possible. Note that column
  47  * numbering begins at 0 throughout this class.
  48  *
  49  * @author kmourao
  50  */
  51
  52 /* Implementation notes:
  53  *
  54  * Methods which change the hiddenColumns collection should use a writeLock to
  55  * prevent other threads accessing the hiddenColumns collection while changes
  56  * are being made. They should also reset the hidden columns cursor, and either
  57  * update the hidden columns count, or set it to 0 (so that it will later be
  58  * updated when needed).
  59  *
  60  *
  61  * Methods which only need read access to the hidden columns collection should
  62  * use a readLock to prevent other threads changing the hidden columns
  63  * collection while it is in use.
  64  */
  65 public class HiddenColumns
  66 {
  67   private static final int HASH_MULTIPLIER = 31;
  68
  69   private static final ReentrantReadWriteLock LOCK = new ReentrantReadWriteLock();
  70
  71   /*
  72    * Cursor which tracks the last used hidden columns region, and the number
  73    * of hidden columns up to (but not including) that region.
  74    */
  75   private HiddenColumnsCursor cursor = new HiddenColumnsCursor();
  76
  77   /*
  78    * cache of the number of hidden columns
  79    */
  80   private int numColumns = 0;
  81
  82   /*
  83    * list of hidden column [start, end] ranges; the list is maintained in
  84    * ascending start column order
  85    */
  86   private List<int[]> hiddenColumns = new ArrayList<>();
  87
  88   /**
  89    * Constructor
  90    */
  91   public HiddenColumns()
  92   {
  93   }
  94
  95   /**
  96    * Copy constructor
  97    *
  98    * @param copy
  99    *          the HiddenColumns object to copy from
 100    */
 101   public HiddenColumns(HiddenColumns copy)
 102   {
 103     this(copy, Integer.MIN_VALUE, Integer.MAX_VALUE, 0);
 104   }
 105
 106   /**
 107    * Copy constructor within bounds and with offset. Copies hidden column
 108    * regions fully contained between start and end, and offsets positions by
 109    * subtracting offset.
 110    *
 111    * @param copy
 112    *          HiddenColumns instance to copy from
 113    * @param start
 114    *          lower bound to copy from
 115    * @param end
 116    *          upper bound to copy to
 117    * @param offset
 118    *          offset to subtract from each region boundary position
 119    *
 120    */
 121   public HiddenColumns(HiddenColumns copy, int start, int end, int offset)
 122   {
 123     try
 124     {
 125       LOCK.writeLock().lock();
 126       if (copy != null)
 127       {
 128         numColumns = 0;
 129         Iterator<int[]> it = copy.getBoundedIterator(start, end);
 130         while (it.hasNext())
 131         {
 132           int[] region = it.next();
 133           // still need to check boundaries because iterator returns
 134           // all overlapping regions and we need contained regions
 135           if (region[0] >= start && region[1] <= end)
 136           {
 137             hiddenColumns.add(
 138                     new int[]
 139             { region[0] - offset, region[1] - offset });
 140             numColumns += region[1] - region[0] + 1;
 141           }
 142         }
 143         cursor = new HiddenColumnsCursor(hiddenColumns);
 144       }
 145     } finally
 146     {
 147       LOCK.writeLock().unlock();
 148     }
 149   }
 150
 151   /**
 152    * Adds the specified column range to the hidden columns collection
 153    *
 154    * @param start
 155    *          start of range to add (absolute position in alignment)
 156    * @param end
 157    *          end of range to add (absolute position in alignment)
 158    */
 159   public void hideColumns(int start, int end)
 160   {
 161     try
 162     {
 163       LOCK.writeLock().lock();
 164
 165       int previndex = 0;
 166       int prevHiddenCount = 0;
 167       int regionindex = 0;
 168       if (!hiddenColumns.isEmpty())
 169       {
 170         // set up cursor reset values
 171         HiddenCursorPosition cursorPos = cursor.findRegionForColumn(start);
 172         regionindex = cursorPos.getRegionIndex();
 173
 174         if (regionindex > 0)
 175         {
 176           // get previous index and hidden count for updating the cursor later
 177           previndex = regionindex - 1;
 178           int[] prevRegion = hiddenColumns.get(previndex);
 179           prevHiddenCount = cursorPos.getHiddenSoFar()
 180                   - (prevRegion[1] - prevRegion[0] + 1);
 181         }
 182       }
 183
 184       /*
 185        * new range follows everything else; check first to avoid looping over whole hiddenColumns collection
 186        */
 187       if (hiddenColumns.isEmpty()
 188               || start > hiddenColumns.get(hiddenColumns.size() - 1)[1])
 189       {
 190         hiddenColumns.add(new int[] { start, end });
 191       }
 192       else
 193       {
 194         /*
 195          * traverse existing hidden ranges and insert / amend / append as
 196          * appropriate
 197          */
 198         boolean added = false;
 199         if (regionindex > 0)
 200         {
 201           added = insertRangeAtRegion(regionindex - 1, start, end);
 202         }
 203         if (!added && regionindex < hiddenColumns.size())
 204         {
 205           insertRangeAtRegion(regionindex, start, end);
 206         }
 207       }
 208
 209       // reset the cursor to just before our insertion point: this saves
 210       // a lot of reprocessing in large alignments
 211       cursor = new HiddenColumnsCursor(hiddenColumns, previndex,
 212               prevHiddenCount);
 213
 214       // reset the number of columns so they will be recounted
 215       numColumns = 0;
 216
 217     } finally
 218     {
 219       LOCK.writeLock().unlock();
 220     }
 221   }
 222
 223   /**
 224    * Insert [start, range] at the region at index i in hiddenColumns, if
 225    * feasible
 226    *
 227    * @param i
 228    *          index to insert at
 229    * @param start
 230    *          start of range to insert
 231    * @param end
 232    *          end of range to insert
 233    * @return true if range was successfully inserted
 234    */
 235   private boolean insertRangeAtRegion(int i, int start, int end)
 236   {
 237     boolean added = false;
 238
 239     int[] region = hiddenColumns.get(i);
 240     if (end < region[0] - 1)
 241     {
 242       /*
 243        * insert discontiguous preceding range
 244        */
 245       hiddenColumns.add(i, new int[] { start, end });
 246       added = true;
 247     }
 248     else if (end <= region[1])
 249     {
 250       /*
 251        * new range overlaps existing, or is contiguous preceding it - adjust
 252        * start column
 253        */
 254       region[0] = Math.min(region[0], start);
 255       added = true;
 256     }
 257     else if (start <= region[1] + 1)
 258     {
 259       /*
 260        * new range overlaps existing, or is contiguous following it - adjust
 261        * start and end columns
 262        */
 263       region[0] = Math.min(region[0], start);
 264       region[1] = Math.max(region[1], end);
 265
 266       /*
 267        * also update or remove any subsequent ranges
 268        * that are overlapped
 269        */
 270       while (i < hiddenColumns.size() - 1)
 271       {
 272         int[] nextRegion = hiddenColumns.get(i + 1);
 273         if (nextRegion[0] > end + 1)
 274         {
 275           /*
 276            * gap to next hidden range - no more to update
 277            */
 278           break;
 279         }
 280         region[1] = Math.max(nextRegion[1], end);
 281
 282         // in theory hiddenColumns.subList(i + 1, i + 2).clear() is faster than
 283         // hiddenColumns.remove(i+1) but benchmarking results a bit ambivalent
 284         hiddenColumns.remove(i + 1);
 285       }
 286       added = true;
 287     }
 288     return added;
 289   }
 290
 291   /**
 292    * hide a list of ranges
 293    *
 294    * @param ranges
 295    */
 296   public void hideList(List<int[]> ranges)
 297   {
 298     try
 299     {
 300       LOCK.writeLock().lock();
 301       for (int[] r : ranges)
 302       {
 303         hideColumns(r[0], r[1]);
 304       }
 305       cursor = new HiddenColumnsCursor(hiddenColumns);
 306       numColumns = 0;
 307     } finally
 308     {
 309       LOCK.writeLock().unlock();
 310     }
 311   }
 312
 313   /**
 314    * Unhides, and adds to the selection list, all hidden columns
 315    */
 316   public void revealAllHiddenColumns(ColumnSelection sel)
 317   {
 318     try
 319     {
 320       LOCK.writeLock().lock();
 321
 322       for (int[] region : hiddenColumns)
 323       {
 324         for (int j = region[0]; j < region[1] + 1; j++)
 325         {
 326           sel.addElement(j);
 327         }
 328       }
 329       hiddenColumns.clear();
 330       cursor = new HiddenColumnsCursor(hiddenColumns);
 331       numColumns = 0;
 332
 333     } finally
 334     {
 335       LOCK.writeLock().unlock();
 336     }
 337   }
 338
 339   /**
 340    * Reveals, and marks as selected, the hidden column range with the given
 341    * start column
 342    *
 343    * @param start
 344    *          the start column to look for
 345    * @param sel
 346    *          the column selection to add the hidden column range to
 347    */
 348   public void revealHiddenColumns(int start, ColumnSelection sel)
 349   {
 350     try
 351     {
 352       LOCK.writeLock().lock();
 353
 354       if (!hiddenColumns.isEmpty())
 355       {
 356         int regionIndex = cursor.findRegionForColumn(start)
 357                 .getRegionIndex();
 358
 359         if (regionIndex != -1 && regionIndex != hiddenColumns.size())
 360         {
 361           // regionIndex is the region which either contains start
 362           // or lies to the right of start
 363           int[] region = hiddenColumns.get(regionIndex);
 364           if (start == region[0])
 365           {
 366             for (int j = region[0]; j < region[1] + 1; j++)
 367             {
 368               sel.addElement(j);
 369             }
 370             int colsToRemove = region[1] - region[0] + 1;
 371             hiddenColumns.remove(regionIndex);
 372
 373             if (hiddenColumns.isEmpty())
 374             {
 375               numColumns = 0;
 376             }
 377             else
 378             {
 379               numColumns -= colsToRemove;
 380             }
 381             cursor.updateForDeletedRegion(hiddenColumns);
 382           }
 383         }
 384       }
 385     } finally
 386     {
 387       LOCK.writeLock().unlock();
 388     }
 389   }
 390
 391   /**
 392    * Output regions data as a string. String is in the format:
 393    * reg0[0]<between>reg0[1]<delimiter>reg1[0]<between>reg1[1] ... regn[1]
 394    *
 395    * @param delimiter
 396    *          string to delimit regions
 397    * @param betweenstring
 398    *          to put between start and end region values
 399    * @return regions formatted according to delimiter and between strings
 400    */
 401   public String regionsToString(String delimiter, String between)
 402   {
 403     try
 404     {
 405       LOCK.readLock().lock();
 406       StringBuilder regionBuilder = new StringBuilder();
 407
 408       boolean first = true;
 409       for (int[] range : hiddenColumns)
 410       {
 411         if (!first)
 412         {
 413           regionBuilder.append(delimiter);
 414         }
 415         else
 416         {
 417           first = false;
 418         }
 419         regionBuilder.append(range[0]).append(between).append(range[1]);
 420
 421       }
 422
 423       return regionBuilder.toString();
 424     } finally
 425     {
 426       LOCK.readLock().unlock();
 427     }
 428   }
 429
 430   /**
 431    * Find the number of hidden columns
 432    *
 433    * @return number of hidden columns
 434    */
 435   public int getSize()
 436   {
 437     try
 438     {
 439       LOCK.readLock().lock();
 440
 441       if (numColumns == 0)
 442       {
 443         // numColumns is out of date, so recalculate
 444         int size = 0;
 445
 446         for (int[] range : hiddenColumns)
 447         {
 448           size += range[1] - range[0] + 1;
 449         }
 450
 451         numColumns = size;
 452       }
 453
 454       return numColumns;
 455     } finally
 456     {
 457       LOCK.readLock().unlock();
 458     }
 459   }
 460
 461   /**
 462    * Get the number of distinct hidden regions
 463    *
 464    * @return number of regions
 465    */
 466   public int getNumberOfRegions()
 467   {
 468     try
 469     {
 470       LOCK.readLock().lock();
 471       return hiddenColumns.size();
 472     } finally
 473     {
 474       LOCK.readLock().unlock();
 475     }
 476   }
 477
 478   @Override
 479   public boolean equals(Object obj)
 480   {
 481     try
 482     {
 483       LOCK.readLock().lock();
 484
 485       if (!(obj instanceof HiddenColumns))
 486       {
 487         return false;
 488       }
 489       HiddenColumns that = (HiddenColumns) obj;
 490
 491       /*
 492        * check hidden columns are either both null, or match
 493        */
 494
 495       if (that.hiddenColumns.size() != this.hiddenColumns.size())
 496       {
 497         return false;
 498       }
 499
 500       Iterator<int[]> it = this.iterator();
 501       Iterator<int[]> thatit = that.iterator();
 502       while (it.hasNext())
 503       {
 504         if (!(Arrays.equals(it.next(), thatit.next())))
 505         {
 506           return false;
 507         }
 508       }
 509       return true;
 510
 511     } finally
 512     {
 513       LOCK.readLock().unlock();
 514     }
 515   }
 516
 517   /**
 518    * Return absolute column index for a visible column index
 519    *
 520    * @param column
 521    *          int column index in alignment view (count from zero)
 522    * @return alignment column index for column
 523    */
 524   public int visibleToAbsoluteColumn(int column)
 525   {
 526     try
 527     {
 528       LOCK.readLock().lock();
 529       int result = column;
 530
 531       if (!hiddenColumns.isEmpty())
 532       {
 533         result += cursor.findRegionForVisColumn(column).getHiddenSoFar();
 534       }
 535
 536       return result;
 537     } finally
 538     {
 539       LOCK.readLock().unlock();
 540     }
 541   }
 542
 543   /**
 544    * Use this method to find out where a column will appear in the visible
 545    * alignment when hidden columns exist. If the column is not visible, then the
 546    * index of the next visible column on the left will be returned (or 0 if
 547    * there is no visible column on the left)
 548    *
 549    * @param hiddenColumn
 550    *          the column index in the full alignment including hidden columns
 551    * @return the position of the column in the visible alignment
 552    */
 553   public int absoluteToVisibleColumn(int hiddenColumn)
 554   {
 555     try
 556     {
 557       LOCK.readLock().lock();
 558       int result = hiddenColumn;
 559
 560       if (!hiddenColumns.isEmpty())
 561       {
 562         HiddenCursorPosition cursorPos = cursor
 563                 .findRegionForColumn(hiddenColumn);
 564         int index = cursorPos.getRegionIndex();
 565         int hiddenBeforeCol = cursorPos.getHiddenSoFar();
 566
 567         // just subtract hidden cols count - this works fine if column is
 568         // visible
 569         result = hiddenColumn - hiddenBeforeCol;
 570
 571         // now check in case column is hidden - it will be in the returned
 572         // hidden region
 573         if (index < hiddenColumns.size())
 574         {
 575           int[] region = hiddenColumns.get(index);
 576           if (hiddenColumn >= region[0] && hiddenColumn <= region[1])
 577           {
 578             // actually col is hidden, return region[0]-1
 579             // unless region[0]==0 in which case return 0
 580             if (region[0] == 0)
 581             {
 582               result = 0;
 583             }
 584             else
 585             {
 586               result = region[0] - 1 - hiddenBeforeCol;
 587             }
 588           }
 589         }
 590       }
 591
 592       return result; // return the shifted position after removing hidden
 593                      // columns.
 594     } finally
 595     {
 596       LOCK.readLock().unlock();
 597     }
 598   }
 599
 600   /**
 601    * Find the visible column which is a given visible number of columns to the
 602    * left (negative visibleDistance) or right (positive visibleDistance) of
 603    * startColumn. If startColumn is not visible, we use the visible column at
 604    * the left boundary of the hidden region containing startColumn.
 605    *
 606    * @param visibleDistance
 607    *          the number of visible columns to offset by (left offset = negative
 608    *          value; right offset = positive value)
 609    * @param startColumn
 610    *          the position of the column to start from (absolute position)
 611    * @return the position of the column which is <visibleDistance> away
 612    *         (absolute position)
 613    */
 614   public int offsetByVisibleColumns(int visibleDistance, int startColumn)
 615   {
 616     try
 617     {
 618       LOCK.readLock().lock();
 619       int start = absoluteToVisibleColumn(startColumn);
 620       return visibleToAbsoluteColumn(start + visibleDistance);
 621
 622     } finally
 623     {
 624       LOCK.readLock().unlock();
 625     }
 626   }
 627
 628   /**
 629    * This method returns the rightmost limit of a region of an alignment with
 630    * hidden columns. In otherwords, the next hidden column.
 631    *
 632    * @param alPos
 633    *          the absolute (visible) alignmentPosition to find the next hidden
 634    *          column for
 635    * @return the index of the next hidden column, or alPos if there is no next
 636    *         hidden column
 637    */
 638   public int getNextHiddenBoundary(boolean left, int alPos)
 639   {
 640     try
 641     {
 642       LOCK.readLock().lock();
 643       if (!hiddenColumns.isEmpty())
 644       {
 645         int index = cursor.findRegionForColumn(alPos).getRegionIndex();
 646
 647         if (left && index > 0)
 648         {
 649           int[] region = hiddenColumns.get(index - 1);
 650           return region[1];
 651         }
 652         else if (!left && index < hiddenColumns.size())
 653         {
 654           int[] region = hiddenColumns.get(index);
 655           if (alPos < region[0])
 656           {
 657             return region[0];
 658           }
 659           else if ((alPos <= region[1])
 660                   && (index + 1 < hiddenColumns.size()))
 661           {
 662             // alPos is within a hidden region, return the next one
 663             // if there is one
 664             region = hiddenColumns.get(index + 1);
 665             return region[0];
 666           }
 667         }
 668       }
 669       return alPos;
 670     } finally
 671     {
 672       LOCK.readLock().unlock();
 673     }
 674   }
 675
 676   /**
 677    * Answers if a column in the alignment is visible
 678    *
 679    * @param column
 680    *          absolute position of column in the alignment
 681    * @return true if column is visible
 682    */
 683   public boolean isVisible(int column)
 684   {
 685     try
 686     {
 687       LOCK.readLock().lock();
 688
 689       int regionindex = cursor.findRegionForColumn(column).getRegionIndex();
 690       if (regionindex > -1 && regionindex < hiddenColumns.size())
 691       {
 692         int[] region = hiddenColumns.get(regionindex);
 693         // already know that column <= region[1] as cursor returns containing
 694         // region or region to right
 695         if (column >= region[0])
 696         {
 697           return false;
 698         }
 699       }
 700       return true;
 701
 702     } finally
 703     {
 704       LOCK.readLock().unlock();
 705     }
 706   }
 707
 708   /**
 709    *
 710    * @return true if there are columns hidden
 711    */
 712   public boolean hasHiddenColumns()
 713   {
 714     try
 715     {
 716       LOCK.readLock().lock();
 717
 718       // we don't use getSize()>0 here because it has to iterate over
 719       // the full hiddenColumns collection and so will be much slower
 720       return (!hiddenColumns.isEmpty());
 721     } finally
 722     {
 723       LOCK.readLock().unlock();
 724     }
 725   }
 726
 727   /**
 728    *
 729    * @return true if there is more than one hidden column region
 730    */
 731   public boolean hasMultiHiddenColumnRegions()
 732   {
 733     try
 734     {
 735       LOCK.readLock().lock();
 736       return !hiddenColumns.isEmpty() && hiddenColumns.size() > 1;
 737     } finally
 738     {
 739       LOCK.readLock().unlock();
 740     }
 741   }
 742
 743
 744   /**
 745    * Returns a hashCode built from hidden column ranges
 746    */
 747   @Override
 748   public int hashCode()
 749   {
 750     try
 751     {
 752       LOCK.readLock().lock();
 753       int hashCode = 1;
 754
 755       for (int[] hidden : hiddenColumns)
 756       {
 757         hashCode = HASH_MULTIPLIER * hashCode + hidden[0];
 758         hashCode = HASH_MULTIPLIER * hashCode + hidden[1];
 759       }
 760       return hashCode;
 761     } finally
 762     {
 763       LOCK.readLock().unlock();
 764     }
 765   }
 766
 767   /**
 768    * Hide columns corresponding to the marked bits
 769    *
 770    * @param inserts
 771    *          - columns mapped to bits starting from zero
 772    */
 773   public void hideColumns(BitSet inserts)
 774   {
 775     try
 776     {
 777       LOCK.writeLock().lock();
 778       for (int firstSet = inserts
 779               .nextSetBit(0), lastSet = 0; firstSet >= 0; firstSet = inserts
 780                       .nextSetBit(lastSet))
 781       {
 782         lastSet = inserts.nextClearBit(firstSet);
 783         hideColumns(firstSet, lastSet - 1);
 784       }
 785       cursor = new HiddenColumnsCursor(hiddenColumns);
 786       numColumns = 0;
 787     } finally
 788     {
 789       LOCK.writeLock().unlock();
 790     }
 791   }
 792
 793   /**
 794    * Hide columns corresponding to the marked bits, within the range
 795    * [start,end]. Entries in tohide which are outside [start,end] are ignored.
 796    *
 797    * @param tohide
 798    *          columns mapped to bits starting from zero
 799    * @param start
 800    *          start of range to hide columns within
 801    * @param end
 802    *          end of range to hide columns within
 803    */
 804   public void hideColumns(BitSet tohide, int start, int end)
 805   {
 806     clearHiddenColumnsInRange(start, end);
 807
 808     // make sure only bits between start and end are set
 809     if (!tohide.isEmpty())
 810     {
 811       tohide.clear(0, start);
 812       tohide.clear(Math.min(end + 1, tohide.length() + 1),
 813               tohide.length() + 1);
 814     }
 815
 816     hideColumns(tohide);
 817   }
 818
 819   /**
 820    * Make all columns in the range [start,end] visible
 821    *
 822    * @param start
 823    *          start of range to show columns
 824    * @param end
 825    *          end of range to show columns
 826    */
 827   private void clearHiddenColumnsInRange(int start, int end)
 828   {
 829     try
 830     {
 831       LOCK.writeLock().lock();
 832
 833       if (!hiddenColumns.isEmpty())
 834       {
 835         HiddenCursorPosition pos = cursor.findRegionForColumn(start);
 836         int index = pos.getRegionIndex();
 837         int startindex = index; // first index in hiddenColumns to remove
 838
 839         if (index != -1 && index != hiddenColumns.size())
 840         {
 841           // regionIndex is the region which either contains start
 842           // or lies to the right of start
 843           int[] region = hiddenColumns.get(index);
 844           if (region[0] < start && region[1] >= start)
 845           {
 846             // region contains start, truncate so that it ends just before start
 847             region[1] = start - 1;
 848             startindex++;
 849           }
 850         }
 851
 852         pos = cursor.findRegionForColumn(end);
 853         index = pos.getRegionIndex();
 854         int endindex = index - 1; // last index in hiddenColumns to remove
 855
 856         if (index != -1 && index != hiddenColumns.size())
 857         {
 858           // regionIndex is the region which either contains end
 859           // or lies to the right of end
 860           int[] region = hiddenColumns.get(index);
 861           if (region[0] <= end && region[1] > end)
 862           {
 863             // region contains end, truncate so that it starts just after end
 864             region[0] = end + 1;
 865           }
 866         }
 867
 868         hiddenColumns.subList(startindex, endindex + 1).clear();
 869         cursor = new HiddenColumnsCursor(hiddenColumns);
 870         numColumns = 0;
 871       }
 872     } finally
 873     {
 874       LOCK.writeLock().unlock();
 875     }
 876   }
 877
 878   /**
 879    *
 880    * @param updates
 881    *          BitSet where hidden columns will be marked
 882    */
 883   protected void andNot(BitSet updates)
 884   {
 885     try
 886     {
 887       LOCK.writeLock().lock();
 888
 889       BitSet hiddenBitSet = new BitSet();
 890       for (int[] range : hiddenColumns)
 891       {
 892         hiddenBitSet.set(range[0], range[1] + 1);
 893       }
 894       hiddenBitSet.andNot(updates);
 895       hiddenColumns.clear();
 896       hideColumns(hiddenBitSet);
 897     } finally
 898     {
 899       LOCK.writeLock().unlock();
 900     }
 901   }
 902
 903   /**
 904    * Calculate the visible start and end index of an alignment.
 905    *
 906    * @param width
 907    *          full alignment width
 908    * @return integer array where: int[0] = startIndex, and int[1] = endIndex
 909    */
 910   public int[] getVisibleStartAndEndIndex(int width)
 911   {
 912     try
 913     {
 914       LOCK.readLock().lock();
 915
 916       int firstVisible = 0;
 917       int lastVisible = width - 1;
 918
 919       if (!hiddenColumns.isEmpty())
 920       {
 921         // first visible col with index 0, convert to absolute index
 922         firstVisible = visibleToAbsoluteColumn(0);
 923
 924         // last visible column is either immediately to left of
 925         // last hidden region, or is just the last column in the alignment
 926         int[] lastregion = hiddenColumns.get(hiddenColumns.size() - 1);
 927         if (lastregion[1] == width - 1)
 928         {
 929           // last region is at very end of alignment
 930           // last visible column immediately precedes it
 931           lastVisible = lastregion[0] - 1;
 932         }
 933       }
 934       return new int[] { firstVisible, lastVisible };
 935
 936     } finally
 937     {
 938       LOCK.readLock().unlock();
 939     }
 940   }
 941
 942   /**
 943    * Finds the hidden region (if any) which starts or ends at res
 944    *
 945    * @param res
 946    *          visible residue position, unadjusted for hidden columns
 947    * @return region as [start,end] or null if no matching region is found. If
 948    *         res is adjacent to two regions, returns the left region.
 949    */
 950   public int[] getRegionWithEdgeAtRes(int res)
 951   {
 952     try
 953     {
 954       LOCK.readLock().lock();
 955       int adjres = visibleToAbsoluteColumn(res);
 956
 957       int[] reveal = null;
 958
 959       if (!hiddenColumns.isEmpty())
 960       {
 961         // look for a region ending just before adjres
 962         int regionindex = cursor.findRegionForColumn(adjres - 1)
 963                 .getRegionIndex();
 964         if (regionindex < hiddenColumns.size()
 965                 && hiddenColumns.get(regionindex)[1] == adjres - 1)
 966         {
 967           reveal = hiddenColumns.get(regionindex);
 968         }
 969         // check if the region ends just after adjres
 970         else if (regionindex < hiddenColumns.size()
 971                 && hiddenColumns.get(regionindex)[0] == adjres + 1)
 972         {
 973           reveal = hiddenColumns.get(regionindex);
 974         }
 975       }
 976       return reveal;
 977
 978     } finally
 979     {
 980       LOCK.readLock().unlock();
 981     }
 982   }
 983
 984   /**
 985    * Return an iterator over the hidden regions
 986    */
 987   public Iterator<int[]> iterator()
 988   {
 989     try
 990     {
 991       LOCK.readLock().lock();
 992       return new HiddenColsIterator(hiddenColumns);
 993     } finally
 994     {
 995       LOCK.readLock().unlock();
 996     }
 997   }
 998
 999   /**
1000    * Return a bounded iterator over the hidden regions
1001    *
1002    * @param start
1003    *          position to start from (inclusive, absolute column position)
1004    * @param end
1005    *          position to end at (inclusive, absolute column position)
1006    * @return
1007    */
1008   public Iterator<int[]> getBoundedIterator(int start, int end)
1009   {
1010     try
1011     {
1012       LOCK.readLock().lock();
1013       return new HiddenColsIterator(start, end, hiddenColumns);
1014     } finally
1015     {
1016       LOCK.readLock().unlock();
1017     }
1018   }
1019
1020   /**
1021    * Return a bounded iterator over the *visible* start positions of hidden
1022    * regions
1023    *
1024    * @param start
1025    *          position to start from (inclusive, visible column position)
1026    * @param end
1027    *          position to end at (inclusive, visible column position)
1028    */
1029   public Iterator<Integer> getBoundedStartIterator(int start, int end)
1030   {
1031     try
1032     {
1033       LOCK.readLock().lock();
1034
1035       // get absolute position of column in alignment
1036       int absoluteStart = visibleToAbsoluteColumn(start);
1037
1038       // Get cursor position and supply it to the iterator:
1039       // Since we want visible region start, we look for a cursor for the
1040       // (absoluteStart-1), then if absoluteStart is the start of a visible
1041       // region we'll get the cursor pointing to the region before, which is
1042       // what we want
1043       HiddenCursorPosition pos = cursor
1044               .findRegionForColumn(absoluteStart - 1);
1045
1046       return new BoundedStartRegionIterator(pos, start, end,
1047               hiddenColumns);
1048     } finally
1049     {
1050       LOCK.readLock().unlock();
1051     }
1052   }
1053
1054   /**
1055    * Return an iterator over visible *columns* (not regions) between the given
1056    * start and end boundaries
1057    *
1058    * @param start
1059    *          first column (inclusive)
1060    * @param end
1061    *          last column (inclusive)
1062    */
1063   public Iterator<Integer> getVisibleColsIterator(int start, int end)
1064   {
1065     try
1066     {
1067       LOCK.readLock().lock();
1068       return new VisibleColsIterator(start, end, hiddenColumns);
1069     } finally
1070     {
1071       LOCK.readLock().unlock();
1072     }
1073   }
1074
1075   /**
1076    * return an iterator over visible segments between the given start and end
1077    * boundaries
1078    *
1079    * @param start
1080    *          first column, inclusive from 0
1081    * @param end
1082    *          last column - not inclusive
1083    * @param useVisibleCoords
1084    *          if true, start and end are visible column positions, not absolute
1085    *          positions*
1086    */
1087   public VisibleContigsIterator getVisContigsIterator(int start,
1088           int end,
1089           boolean useVisibleCoords)
1090   {
1091     int adjstart = start;
1092     int adjend = end;
1093     if (useVisibleCoords)
1094     {
1095       adjstart = visibleToAbsoluteColumn(start);
1096       adjend = visibleToAbsoluteColumn(end);
1097     }
1098
1099     try
1100     {
1101       LOCK.readLock().lock();
1102       return new VisibleContigsIterator(adjstart, adjend, hiddenColumns);
1103     } finally
1104     {
1105       LOCK.readLock().unlock();
1106     }
1107   }
1108 }