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: must be kept up to date by methods
  79    * which add or remove hidden columns
  80    */
  81   private int numColumns = 0;
  82
  83   /*
  84    * list of hidden column [start, end] ranges; the list is maintained in
  85    * ascending start column order
  86    */
  87   private List<int[]> hiddenColumns = new ArrayList<>();
  88
  89   /**
  90    * Constructor
  91    */
  92   public HiddenColumns()
  93   {
  94   }
  95
  96   /**
  97    * Copy constructor
  98    *
  99    * @param copy
 100    *          the HiddenColumns object to copy from
 101    */
 102   public HiddenColumns(HiddenColumns copy)
 103   {
 104     this(copy, Integer.MIN_VALUE, Integer.MAX_VALUE, 0);
 105   }
 106
 107   /**
 108    * Copy constructor within bounds and with offset. Copies hidden column
 109    * regions fully contained between start and end, and offsets positions by
 110    * subtracting offset.
 111    *
 112    * @param copy
 113    *          HiddenColumns instance to copy from
 114    * @param start
 115    *          lower bound to copy from
 116    * @param end
 117    *          upper bound to copy to
 118    * @param offset
 119    *          offset to subtract from each region boundary position
 120    *
 121    */
 122   public HiddenColumns(HiddenColumns copy, int start, int end, int offset)
 123   {
 124     try
 125     {
 126       LOCK.writeLock().lock();
 127       if (copy != null)
 128       {
 129         numColumns = 0;
 130         Iterator<int[]> it = copy.getBoundedIterator(start, end);
 131         while (it.hasNext())
 132         {
 133           int[] region = it.next();
 134           // still need to check boundaries because iterator returns
 135           // all overlapping regions and we need contained regions
 136           if (region[0] >= start && region[1] <= end)
 137           {
 138             hiddenColumns.add(
 139                     new int[]
 140             { region[0] - offset, region[1] - offset });
 141             numColumns += region[1] - region[0] + 1;
 142           }
 143         }
 144         cursor = new HiddenColumnsCursor(hiddenColumns);
 145       }
 146     } finally
 147     {
 148       LOCK.writeLock().unlock();
 149     }
 150   }
 151
 152   /**
 153    * Adds the specified column range to the hidden columns collection
 154    *
 155    * @param start
 156    *          start of range to add (absolute position in alignment)
 157    * @param end
 158    *          end of range to add (absolute position in alignment)
 159    */
 160   public void hideColumns(int start, int end)
 161   {
 162     try
 163     {
 164       LOCK.writeLock().lock();
 165
 166       int previndex = 0;
 167       int prevHiddenCount = 0;
 168       int regionindex = 0;
 169       if (!hiddenColumns.isEmpty())
 170       {
 171         // set up cursor reset values
 172         HiddenCursorPosition cursorPos = cursor.findRegionForColumn(start, false);
 173         regionindex = cursorPos.getRegionIndex();
 174
 175         if (regionindex > 0)
 176         {
 177           // get previous index and hidden count for updating the cursor later
 178           previndex = regionindex - 1;
 179           int[] prevRegion = hiddenColumns.get(previndex);
 180           prevHiddenCount = cursorPos.getHiddenSoFar()
 181                   - (prevRegion[1] - prevRegion[0] + 1);
 182         }
 183       }
 184
 185       // new range follows everything else; check first to avoid looping over
 186       // whole hiddenColumns collection
 187       if (hiddenColumns.isEmpty()
 188               || start > hiddenColumns.get(hiddenColumns.size() - 1)[1])
 189       {
 190         hiddenColumns.add(new int[] { start, end });
 191         numColumns += end - start + 1;
 192       }
 193       else
 194       {
 195         /*
 196          * traverse existing hidden ranges and insert / amend / append as
 197          * appropriate
 198          */
 199         boolean added = false;
 200         if (regionindex > 0)
 201         {
 202           added = insertRangeAtRegion(regionindex - 1, start, end);
 203         }
 204         if (!added && regionindex < hiddenColumns.size())
 205         {
 206           insertRangeAtRegion(regionindex, start, end);
 207         }
 208       }
 209
 210       // reset the cursor to just before our insertion point: this saves
 211       // a lot of reprocessing in large alignments
 212       cursor = new HiddenColumnsCursor(hiddenColumns, previndex,
 213               prevHiddenCount);
 214     } finally
 215     {
 216       LOCK.writeLock().unlock();
 217     }
 218   }
 219
 220   /**
 221    * Insert [start, range] at the region at index i in hiddenColumns, if
 222    * feasible
 223    *
 224    * @param i
 225    *          index to insert at
 226    * @param start
 227    *          start of range to insert
 228    * @param end
 229    *          end of range to insert
 230    * @return true if range was successfully inserted
 231    */
 232   private boolean insertRangeAtRegion(int i, int start, int end)
 233   {
 234     boolean added = false;
 235
 236     int[] region = hiddenColumns.get(i);
 237     if (end < region[0] - 1)
 238     {
 239       /*
 240        * insert discontiguous preceding range
 241        */
 242       hiddenColumns.add(i, new int[] { start, end });
 243       numColumns += end - start + 1;
 244       added = true;
 245     }
 246     else if (end <= region[1])
 247     {
 248       /*
 249        * new range overlaps existing, or is contiguous preceding it - adjust
 250        * start column
 251        */
 252       int oldstart = region[0];
 253       region[0] = Math.min(region[0], start);
 254       numColumns += oldstart - region[0]; // new columns are between old and
 255                                               // adjusted starts
 256       added = true;
 257     }
 258     else if (start <= region[1] + 1)
 259     {
 260       /*
 261        * new range overlaps existing, or is contiguous following it - adjust
 262        * start and end columns
 263        */
 264       insertRangeAtOverlap(i, start, end, region);
 265       added = true;
 266     }
 267     return added;
 268   }
 269
 270   /**
 271    * Insert a range whose start position overlaps an existing region and/or is
 272    * contiguous to the right of the region
 273    *
 274    * @param i
 275    *          index to insert at
 276    * @param start
 277    *          start of range to insert
 278    * @param end
 279    *          end of range to insert
 280    * @param region
 281    *          the overlapped/continued region
 282    */
 283   private void insertRangeAtOverlap(int i, int start, int end, int[] region)
 284   {
 285     int oldstart = region[0];
 286     int oldend = region[1];
 287     region[0] = Math.min(region[0], start);
 288     region[1] = Math.max(region[1], end);
 289
 290     numColumns += oldstart - region[0];
 291
 292     /*
 293      * also update or remove any subsequent ranges
 294      * that are overlapped
 295      */
 296     int endi = i;
 297     while (endi < hiddenColumns.size() - 1)
 298     {
 299       int[] nextRegion = hiddenColumns.get(endi + 1);
 300       if (nextRegion[0] > end + 1)
 301       {
 302         /*
 303          * gap to next hidden range - no more to update
 304          */
 305         break;
 306       }
 307       numColumns -= nextRegion[1] - nextRegion[0] + 1;
 308       region[1] = Math.max(nextRegion[1], end);
 309       endi++;
 310     }
 311     numColumns += region[1] - oldend;
 312     hiddenColumns.subList(i + 1, endi + 1).clear();
 313   }
 314
 315   /**
 316    * hide a list of ranges
 317    *
 318    * @param ranges
 319    */
 320   public void hideList(List<int[]> ranges)
 321   {
 322     try
 323     {
 324       LOCK.writeLock().lock();
 325       for (int[] r : ranges)
 326       {
 327         hideColumns(r[0], r[1]);
 328       }
 329       cursor = new HiddenColumnsCursor(hiddenColumns);
 330
 331     } finally
 332     {
 333       LOCK.writeLock().unlock();
 334     }
 335   }
 336
 337   /**
 338    * Unhides, and adds to the selection list, all hidden columns
 339    */
 340   public void revealAllHiddenColumns(ColumnSelection sel)
 341   {
 342     try
 343     {
 344       LOCK.writeLock().lock();
 345
 346       for (int[] region : hiddenColumns)
 347       {
 348         for (int j = region[0]; j < region[1] + 1; j++)
 349         {
 350           sel.addElement(j);
 351         }
 352       }
 353       hiddenColumns.clear();
 354       cursor = new HiddenColumnsCursor(hiddenColumns);
 355       numColumns = 0;
 356
 357     } finally
 358     {
 359       LOCK.writeLock().unlock();
 360     }
 361   }
 362
 363   /**
 364    * Reveals, and marks as selected, the hidden column range with the given
 365    * start column
 366    *
 367    * @param start
 368    *          the start column to look for
 369    * @param sel
 370    *          the column selection to add the hidden column range to
 371    */
 372   public void revealHiddenColumns(int start, ColumnSelection sel)
 373   {
 374     try
 375     {
 376       LOCK.writeLock().lock();
 377
 378       if (!hiddenColumns.isEmpty())
 379       {
 380         int regionIndex = cursor.findRegionForColumn(start, false)
 381                 .getRegionIndex();
 382
 383         if (regionIndex != -1 && regionIndex != hiddenColumns.size())
 384         {
 385           // regionIndex is the region which either contains start
 386           // or lies to the right of start
 387           int[] region = hiddenColumns.get(regionIndex);
 388           if (start == region[0])
 389           {
 390             for (int j = region[0]; j < region[1] + 1; j++)
 391             {
 392               sel.addElement(j);
 393             }
 394             int colsToRemove = region[1] - region[0] + 1;
 395             hiddenColumns.remove(regionIndex);
 396             numColumns -= colsToRemove;
 397           }
 398         }
 399       }
 400     } finally
 401     {
 402       LOCK.writeLock().unlock();
 403     }
 404   }
 405
 406   /**
 407    * Output regions data as a string. String is in the format:
 408    * reg0[0]<between>reg0[1]<delimiter>reg1[0]<between>reg1[1] ... regn[1]
 409    *
 410    * @param delimiter
 411    *          string to delimit regions
 412    * @param betweenstring
 413    *          to put between start and end region values
 414    * @return regions formatted according to delimiter and between strings
 415    */
 416   public String regionsToString(String delimiter, String between)
 417   {
 418     try
 419     {
 420       LOCK.readLock().lock();
 421       StringBuilder regionBuilder = new StringBuilder();
 422
 423       boolean first = true;
 424       for (int[] range : hiddenColumns)
 425       {
 426         if (!first)
 427         {
 428           regionBuilder.append(delimiter);
 429         }
 430         else
 431         {
 432           first = false;
 433         }
 434         regionBuilder.append(range[0]).append(between).append(range[1]);
 435
 436       }
 437
 438       return regionBuilder.toString();
 439     } finally
 440     {
 441       LOCK.readLock().unlock();
 442     }
 443   }
 444
 445   /**
 446    * Find the number of hidden columns
 447    *
 448    * @return number of hidden columns
 449    */
 450   public int getSize()
 451   {
 452     return numColumns;
 453   }
 454
 455   /**
 456    * Get the number of distinct hidden regions
 457    *
 458    * @return number of regions
 459    */
 460   public int getNumberOfRegions()
 461   {
 462     try
 463     {
 464       LOCK.readLock().lock();
 465       return hiddenColumns.size();
 466     } finally
 467     {
 468       LOCK.readLock().unlock();
 469     }
 470   }
 471
 472   @Override
 473   public boolean equals(Object obj)
 474   {
 475     try
 476     {
 477       LOCK.readLock().lock();
 478
 479       if (!(obj instanceof HiddenColumns))
 480       {
 481         return false;
 482       }
 483       HiddenColumns that = (HiddenColumns) obj;
 484
 485       /*
 486        * check hidden columns are either both null, or match
 487        */
 488
 489       if (that.hiddenColumns.size() != this.hiddenColumns.size())
 490       {
 491         return false;
 492       }
 493
 494       Iterator<int[]> it = this.iterator();
 495       Iterator<int[]> thatit = that.iterator();
 496       while (it.hasNext())
 497       {
 498         if (!(Arrays.equals(it.next(), thatit.next())))
 499         {
 500           return false;
 501         }
 502       }
 503       return true;
 504
 505     } finally
 506     {
 507       LOCK.readLock().unlock();
 508     }
 509   }
 510
 511   /**
 512    * Return absolute column index for a visible column index
 513    *
 514    * @param column
 515    *          int column index in alignment view (count from zero)
 516    * @return alignment column index for column
 517    */
 518   public int visibleToAbsoluteColumn(int column)
 519   {
 520     try
 521     {
 522       LOCK.readLock().lock();
 523       int result = column;
 524
 525       if (!hiddenColumns.isEmpty())
 526       {
 527         result += cursor.findRegionForColumn(column, true)
 528                 .getHiddenSoFar();
 529       }
 530
 531       return result;
 532     } finally
 533     {
 534       LOCK.readLock().unlock();
 535     }
 536   }
 537
 538   /**
 539    * Use this method to find out where a column will appear in the visible
 540    * alignment when hidden columns exist. If the column is not visible, then the
 541    * index of the next visible column on the left will be returned (or 0 if
 542    * there is no visible column on the left)
 543    *
 544    * @param hiddenColumn
 545    *          the column index in the full alignment including hidden columns
 546    * @return the position of the column in the visible alignment
 547    */
 548   public int absoluteToVisibleColumn(int hiddenColumn)
 549   {
 550     try
 551     {
 552       LOCK.readLock().lock();
 553       int result = hiddenColumn;
 554
 555       if (!hiddenColumns.isEmpty())
 556       {
 557         HiddenCursorPosition cursorPos = cursor
 558                 .findRegionForColumn(hiddenColumn, false);
 559         int index = cursorPos.getRegionIndex();
 560         int hiddenBeforeCol = cursorPos.getHiddenSoFar();
 561
 562         // just subtract hidden cols count - this works fine if column is
 563         // visible
 564         result = hiddenColumn - hiddenBeforeCol;
 565
 566         // now check in case column is hidden - it will be in the returned
 567         // hidden region
 568         if (index < hiddenColumns.size())
 569         {
 570           int[] region = hiddenColumns.get(index);
 571           if (hiddenColumn >= region[0] && hiddenColumn <= region[1])
 572           {
 573             // actually col is hidden, return region[0]-1
 574             // unless region[0]==0 in which case return 0
 575             if (region[0] == 0)
 576             {
 577               result = 0;
 578             }
 579             else
 580             {
 581               result = region[0] - 1 - hiddenBeforeCol;
 582             }
 583           }
 584         }
 585       }
 586
 587       return result; // return the shifted position after removing hidden
 588                      // columns.
 589     } finally
 590     {
 591       LOCK.readLock().unlock();
 592     }
 593   }
 594
 595   /**
 596    * Find the visible column which is a given visible number of columns to the
 597    * left (negative visibleDistance) or right (positive visibleDistance) of
 598    * startColumn. If startColumn is not visible, we use the visible column at
 599    * the left boundary of the hidden region containing startColumn.
 600    *
 601    * @param visibleDistance
 602    *          the number of visible columns to offset by (left offset = negative
 603    *          value; right offset = positive value)
 604    * @param startColumn
 605    *          the position of the column to start from (absolute position)
 606    * @return the position of the column which is <visibleDistance> away
 607    *         (absolute position)
 608    */
 609   public int offsetByVisibleColumns(int visibleDistance, int startColumn)
 610   {
 611     try
 612     {
 613       LOCK.readLock().lock();
 614       int start = absoluteToVisibleColumn(startColumn);
 615       return visibleToAbsoluteColumn(start + visibleDistance);
 616
 617     } finally
 618     {
 619       LOCK.readLock().unlock();
 620     }
 621   }
 622
 623   /**
 624    * This method returns the rightmost limit of a region of an alignment with
 625    * hidden columns. In otherwords, the next hidden column.
 626    *
 627    * @param alPos
 628    *          the absolute (visible) alignmentPosition to find the next hidden
 629    *          column for
 630    * @return the index of the next hidden column, or alPos if there is no next
 631    *         hidden column
 632    */
 633   public int getNextHiddenBoundary(boolean left, int alPos)
 634   {
 635     try
 636     {
 637       LOCK.readLock().lock();
 638       if (!hiddenColumns.isEmpty())
 639       {
 640         int index = cursor.findRegionForColumn(alPos, false)
 641                 .getRegionIndex();
 642
 643         if (left && index > 0)
 644         {
 645           int[] region = hiddenColumns.get(index - 1);
 646           return region[1];
 647         }
 648         else if (!left && index < hiddenColumns.size())
 649         {
 650           int[] region = hiddenColumns.get(index);
 651           if (alPos < region[0])
 652           {
 653             return region[0];
 654           }
 655           else if ((alPos <= region[1])
 656                   && (index + 1 < hiddenColumns.size()))
 657           {
 658             // alPos is within a hidden region, return the next one
 659             // if there is one
 660             region = hiddenColumns.get(index + 1);
 661             return region[0];
 662           }
 663         }
 664       }
 665       return alPos;
 666     } finally
 667     {
 668       LOCK.readLock().unlock();
 669     }
 670   }
 671
 672   /**
 673    * Answers if a column in the alignment is visible
 674    *
 675    * @param column
 676    *          absolute position of column in the alignment
 677    * @return true if column is visible
 678    */
 679   public boolean isVisible(int column)
 680   {
 681     try
 682     {
 683       LOCK.readLock().lock();
 684
 685       int regionindex = cursor.findRegionForColumn(column, false)
 686               .getRegionIndex();
 687       if (regionindex > -1 && regionindex < hiddenColumns.size())
 688       {
 689         int[] region = hiddenColumns.get(regionindex);
 690         // already know that column <= region[1] as cursor returns containing
 691         // region or region to right
 692         if (column >= region[0])
 693         {
 694           return false;
 695         }
 696       }
 697       return true;
 698
 699     } finally
 700     {
 701       LOCK.readLock().unlock();
 702     }
 703   }
 704
 705   /**
 706    *
 707    * @return true if there are columns hidden
 708    */
 709   public boolean hasHiddenColumns()
 710   {
 711     try
 712     {
 713       LOCK.readLock().lock();
 714
 715       // we don't use getSize()>0 here because it has to iterate over
 716       // the full hiddenColumns collection and so will be much slower
 717       return (!hiddenColumns.isEmpty());
 718     } finally
 719     {
 720       LOCK.readLock().unlock();
 721     }
 722   }
 723
 724   /**
 725    *
 726    * @return true if there is more than one hidden column region
 727    */
 728   public boolean hasMultiHiddenColumnRegions()
 729   {
 730     try
 731     {
 732       LOCK.readLock().lock();
 733       return !hiddenColumns.isEmpty() && hiddenColumns.size() > 1;
 734     } finally
 735     {
 736       LOCK.readLock().unlock();
 737     }
 738   }
 739
 740
 741   /**
 742    * Returns a hashCode built from hidden column ranges
 743    */
 744   @Override
 745   public int hashCode()
 746   {
 747     try
 748     {
 749       LOCK.readLock().lock();
 750       int hashCode = 1;
 751
 752       for (int[] hidden : hiddenColumns)
 753       {
 754         hashCode = HASH_MULTIPLIER * hashCode + hidden[0];
 755         hashCode = HASH_MULTIPLIER * hashCode + hidden[1];
 756       }
 757       return hashCode;
 758     } finally
 759     {
 760       LOCK.readLock().unlock();
 761     }
 762   }
 763
 764   /**
 765    * Hide columns corresponding to the marked bits
 766    *
 767    * @param inserts
 768    *          - columns mapped to bits starting from zero
 769    */
 770   public void hideColumns(BitSet inserts)
 771   {
 772     try
 773     {
 774       LOCK.writeLock().lock();
 775       for (int firstSet = inserts
 776               .nextSetBit(0), lastSet = 0; firstSet >= 0; firstSet = inserts
 777                       .nextSetBit(lastSet))
 778       {
 779         lastSet = inserts.nextClearBit(firstSet);
 780         hideColumns(firstSet, lastSet - 1);
 781       }
 782       cursor = new HiddenColumnsCursor(hiddenColumns);
 783     } finally
 784     {
 785       LOCK.writeLock().unlock();
 786     }
 787   }
 788
 789   /**
 790    * Hide columns corresponding to the marked bits, within the range
 791    * [start,end]. Entries in tohide which are outside [start,end] are ignored.
 792    *
 793    * @param tohide
 794    *          columns mapped to bits starting from zero
 795    * @param start
 796    *          start of range to hide columns within
 797    * @param end
 798    *          end of range to hide columns within
 799    */
 800   public void hideColumns(BitSet tohide, int start, int end)
 801   {
 802     clearHiddenColumnsInRange(start, end);
 803
 804     // make sure only bits between start and end are set
 805     if (!tohide.isEmpty())
 806     {
 807       tohide.clear(0, start);
 808       tohide.clear(Math.min(end + 1, tohide.length() + 1),
 809               tohide.length() + 1);
 810     }
 811
 812     hideColumns(tohide);
 813   }
 814
 815   /**
 816    * Make all columns in the range [start,end] visible
 817    *
 818    * @param start
 819    *          start of range to show columns
 820    * @param end
 821    *          end of range to show columns
 822    */
 823   private void clearHiddenColumnsInRange(int start, int end)
 824   {
 825     try
 826     {
 827       LOCK.writeLock().lock();
 828
 829       if (!hiddenColumns.isEmpty())
 830       {
 831         HiddenCursorPosition pos = cursor.findRegionForColumn(start, false);
 832         int index = pos.getRegionIndex();
 833
 834         if (index != -1 && index != hiddenColumns.size())
 835         {
 836           // regionIndex is the region which either contains start
 837           // or lies to the right of start
 838           int[] region = hiddenColumns.get(index);
 839           if (region[0] < start && region[1] >= start)
 840           {
 841             // region contains start, truncate so that it ends just before start
 842             numColumns -= region[1] - start + 1;
 843             region[1] = start - 1;
 844             index++;
 845           }
 846
 847           int endi = index;
 848           while (endi < hiddenColumns.size())
 849           {
 850             region = hiddenColumns.get(endi);
 851
 852             if (region[1] > end)
 853             {
 854               if (region[0] <= end)
 855               {
 856                 // region contains end, truncate so it starts just after end
 857                 numColumns -= end - region[0] + 1;
 858                 region[0] = end + 1;
 859               }
 860               break;
 861             }
 862
 863             numColumns -= region[1] - region[0] + 1;
 864             endi++;
 865           }
 866           hiddenColumns.subList(index, endi).clear();
 867
 868         }
 869
 870         cursor = new HiddenColumnsCursor(hiddenColumns);
 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, false)
 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, false);
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 }