src/jalview/datamodel/ColumnSelection.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 jalview.util.Comparison;
  24 import jalview.util.ShiftList;
  25 import jalview.viewmodel.annotationfilter.AnnotationFilterParameter;
  26 import jalview.viewmodel.annotationfilter.AnnotationFilterParameter.SearchableAnnotationField;
  27
  28 import java.util.ArrayList;
  29 import java.util.BitSet;
  30 import java.util.Collections;
  31 import java.util.List;
  32 import java.util.Vector;
  33
  34 /**
  35  * Data class holding the selected columns and hidden column ranges for a view.
  36  * Ranges are base 1.
  37  */
  38 public class ColumnSelection
  39 {
  40   /**
  41    * A class to hold an efficient representation of selected columns
  42    */
  43   private class IntList
  44   {
  45     /*
  46      * list of selected columns (ordered by selection order, not column order)
  47      */
  48     private List<Integer> order;
  49
  50     /*
  51      * an unmodifiable view of the selected columns list
  52      */
  53     private List<Integer> _uorder;
  54
  55     /**
  56      * bitfield for column selection - allows quick lookup
  57      */
  58     private BitSet selected;
  59
  60     /**
  61      * Constructor
  62      */
  63     IntList()
  64     {
  65       order = new ArrayList<Integer>();
  66       _uorder = Collections.unmodifiableList(order);
  67       selected = new BitSet();
  68     }
  69
  70     /**
  71      * Copy constructor
  72      *
  73      * @param other
  74      */
  75     IntList(IntList other)
  76     {
  77       this();
  78       if (other != null)
  79       {
  80         int j = other.size();
  81         for (int i = 0; i < j; i++)
  82         {
  83           add(other.elementAt(i));
  84         }
  85       }
  86     }
  87
  88     /**
  89      * adds a new column i to the selection - only if i is not already selected
  90      *
  91      * @param i
  92      */
  93     void add(int i)
  94     {
  95       if (!selected.get(i))
  96       {
  97         order.add(Integer.valueOf(i));
  98         selected.set(i);
  99       }
 100     }
 101
 102     void clear()
 103     {
 104       order.clear();
 105       selected.clear();
 106     }
 107
 108     void remove(int col)
 109     {
 110
 111       Integer colInt = new Integer(col);
 112
 113       if (selected.get(col))
 114       {
 115         // if this ever changes to List.remove(), ensure Integer not int
 116         // argument
 117         // as List.remove(int i) removes the i'th item which is wrong
 118         order.remove(colInt);
 119         selected.clear(col);
 120       }
 121     }
 122
 123     boolean contains(Integer colInt)
 124     {
 125       return selected.get(colInt);
 126     }
 127
 128     boolean isEmpty()
 129     {
 130       return order.isEmpty();
 131     }
 132
 133     /**
 134      * Returns a read-only view of the selected columns list
 135      *
 136      * @return
 137      */
 138     List<Integer> getList()
 139     {
 140       return _uorder;
 141     }
 142
 143     int size()
 144     {
 145       return order.size();
 146     }
 147
 148     /**
 149      * gets the column that was selected first, second or i'th
 150      *
 151      * @param i
 152      * @return
 153      */
 154     int elementAt(int i)
 155     {
 156       return order.get(i);
 157     }
 158
 159     protected boolean pruneColumnList(final List<int[]> shifts)
 160     {
 161       int s = 0, t = shifts.size();
 162       int[] sr = shifts.get(s++);
 163       boolean pruned = false;
 164       int i = 0, j = order.size();
 165       while (i < j && s <= t)
 166       {
 167         int c = order.get(i++).intValue();
 168         if (sr[0] <= c)
 169         {
 170           if (sr[1] + sr[0] >= c)
 171           { // sr[1] -ve means inseriton.
 172             order.remove(--i);
 173             selected.clear(c);
 174             j--;
 175           }
 176           else
 177           {
 178             if (s < t)
 179             {
 180               sr = shifts.get(s);
 181             }
 182             s++;
 183           }
 184         }
 185       }
 186       return pruned;
 187     }
 188
 189     /**
 190      * shift every selected column at or above start by change
 191      *
 192      * @param start
 193      *          - leftmost column to be shifted
 194      * @param change
 195      *          - delta for shift
 196      */
 197     void compensateForEdits(int start, int change)
 198     {
 199       BitSet mask = new BitSet();
 200       for (int i = 0; i < order.size(); i++)
 201       {
 202         int temp = order.get(i);
 203
 204         if (temp >= start)
 205         {
 206           // clear shifted bits and update List of selected columns
 207           selected.clear(temp);
 208           mask.set(temp - change);
 209           order.set(i, new Integer(temp - change));
 210         }
 211       }
 212       // lastly update the bitfield all at once
 213       selected.or(mask);
 214     }
 215
 216     boolean isSelected(int column)
 217     {
 218       return selected.get(column);
 219     }
 220
 221     int getMaxColumn()
 222     {
 223       return selected.length() - 1;
 224     }
 225
 226     int getMinColumn()
 227     {
 228       return selected.get(0) ? 0 : selected.nextSetBit(0);
 229     }
 230
 231     /**
 232      * @return a series of selection intervals along the range
 233      */
 234     List<int[]> getRanges()
 235     {
 236       List<int[]> rlist = new ArrayList<int[]>();
 237       if (selected.isEmpty())
 238       {
 239         return rlist;
 240       }
 241       int next = selected.nextSetBit(0), clear = -1;
 242       while (next != -1)
 243       {
 244         clear = selected.nextClearBit(next);
 245         rlist.add(new int[] { next, clear - 1 });
 246         next = selected.nextSetBit(clear);
 247       }
 248       return rlist;
 249     }
 250
 251     @Override
 252     public int hashCode()
 253     {
 254       // TODO Auto-generated method stub
 255       return selected.hashCode();
 256     }
 257
 258     @Override
 259     public boolean equals(Object obj)
 260     {
 261       if (obj instanceof IntList)
 262       {
 263         return ((IntList) obj).selected.equals(selected);
 264       }
 265       return false;
 266     }
 267   }
 268
 269   IntList selection = new IntList();
 270
 271   /*
 272    * list of hidden column [start, end] ranges; the list is maintained in
 273    * ascending start column order
 274    */
 275   Vector<int[]> hiddenColumns;
 276
 277   /**
 278    * Add a column to the selection
 279    *
 280    * @param col
 281    *          index of column
 282    */
 283   public void addElement(int col)
 284   {
 285     selection.add(col);
 286   }
 287
 288   /**
 289    * clears column selection
 290    */
 291   public void clear()
 292   {
 293     selection.clear();
 294   }
 295
 296   /**
 297    * Removes value 'col' from the selection (not the col'th item)
 298    *
 299    * @param col
 300    *          index of column to be removed
 301    */
 302   public void removeElement(int col)
 303   {
 304     selection.remove(col);
 305   }
 306
 307   /**
 308    * removes a range of columns from the selection
 309    *
 310    * @param start
 311    *          int - first column in range to be removed
 312    * @param end
 313    *          int - last col
 314    */
 315   public void removeElements(int start, int end)
 316   {
 317     Integer colInt;
 318     for (int i = start; i < end; i++)
 319     {
 320       colInt = new Integer(i);
 321       if (selection.contains(colInt))
 322       {
 323         selection.remove(colInt);
 324       }
 325     }
 326   }
 327
 328   /**
 329    * Returns a read-only view of the (possibly empty) list of selected columns
 330    * <p>
 331    * The list contains no duplicates but is not necessarily ordered. It also may
 332    * include columns hidden from the current view. To modify (for example sort)
 333    * the list, you should first make a copy.
 334    * <p>
 335    * The list is not thread-safe: iterating over it could result in
 336    * ConcurrentModificationException if it is modified by another thread.
 337    */
 338   public List<Integer> getSelected()
 339   {
 340     return selection.getList();
 341   }
 342
 343   /**
 344    * @return list of int arrays containing start and end column position for
 345    *         runs of selected columns ordered from right to left.
 346    */
 347   public List<int[]> getSelectedRanges()
 348   {
 349     return selection.getRanges();
 350   }
 351
 352   /**
 353    *
 354    * @param col
 355    *          index to search for in column selection
 356    *
 357    * @return true if col is selected
 358    */
 359   public boolean contains(int col)
 360   {
 361     return (col > -1) ? selection.isSelected(col) : false;
 362   }
 363
 364   /**
 365    * Answers true if no columns are selected, else false
 366    */
 367   public boolean isEmpty()
 368   {
 369     return selection == null || selection.isEmpty();
 370   }
 371
 372   /**
 373    * rightmost selected column
 374    *
 375    * @return rightmost column in alignment that is selected
 376    */
 377   public int getMax()
 378   {
 379     if (selection.isEmpty())
 380     {
 381       return -1;
 382     }
 383     return selection.getMaxColumn();
 384   }
 385
 386   /**
 387    * Leftmost column in selection
 388    *
 389    * @return column index of leftmost column in selection
 390    */
 391   public int getMin()
 392   {
 393     if (selection.isEmpty())
 394     {
 395       return 1000000000;
 396     }
 397     return selection.getMinColumn();
 398   }
 399
 400   /**
 401    * propagate shift in alignment columns to column selection
 402    *
 403    * @param start
 404    *          beginning of edit
 405    * @param left
 406    *          shift in edit (+ve for removal, or -ve for inserts)
 407    */
 408   public List<int[]> compensateForEdit(int start, int change)
 409   {
 410     List<int[]> deletedHiddenColumns = null;
 411     selection.compensateForEdits(start, change);
 412
 413     if (hiddenColumns != null)
 414     {
 415       deletedHiddenColumns = new ArrayList<int[]>();
 416       int hSize = hiddenColumns.size();
 417       for (int i = 0; i < hSize; i++)
 418       {
 419         int[] region = hiddenColumns.elementAt(i);
 420         if (region[0] > start && start + change > region[1])
 421         {
 422           deletedHiddenColumns.add(region);
 423
 424           hiddenColumns.removeElementAt(i);
 425           i--;
 426           hSize--;
 427           continue;
 428         }
 429
 430         if (region[0] > start)
 431         {
 432           region[0] -= change;
 433           region[1] -= change;
 434         }
 435
 436         if (region[0] < 0)
 437         {
 438           region[0] = 0;
 439         }
 440
 441       }
 442
 443       this.revealHiddenColumns(0);
 444     }
 445
 446     return deletedHiddenColumns;
 447   }
 448
 449   /**
 450    * propagate shift in alignment columns to column selection special version of
 451    * compensateForEdit - allowing for edits within hidden regions
 452    *
 453    * @param start
 454    *          beginning of edit
 455    * @param left
 456    *          shift in edit (+ve for removal, or -ve for inserts)
 457    */
 458   private void compensateForDelEdits(int start, int change)
 459   {
 460
 461     selection.compensateForEdits(start, change);
 462
 463     if (hiddenColumns != null)
 464     {
 465       for (int i = 0; i < hiddenColumns.size(); i++)
 466       {
 467         int[] region = hiddenColumns.elementAt(i);
 468         if (region[0] >= start)
 469         {
 470           region[0] -= change;
 471         }
 472         if (region[1] >= start)
 473         {
 474           region[1] -= change;
 475         }
 476         if (region[1] < region[0])
 477         {
 478           hiddenColumns.removeElementAt(i--);
 479         }
 480
 481         if (region[0] < 0)
 482         {
 483           region[0] = 0;
 484         }
 485         if (region[1] < 0)
 486         {
 487           region[1] = 0;
 488         }
 489       }
 490     }
 491   }
 492
 493   /**
 494    * Adjust hidden column boundaries based on a series of column additions or
 495    * deletions in visible regions.
 496    *
 497    * @param shiftrecord
 498    * @return
 499    */
 500   public ShiftList compensateForEdits(ShiftList shiftrecord)
 501   {
 502     if (shiftrecord != null)
 503     {
 504       final List<int[]> shifts = shiftrecord.getShifts();
 505       if (shifts != null && shifts.size() > 0)
 506       {
 507         int shifted = 0;
 508         for (int i = 0, j = shifts.size(); i < j; i++)
 509         {
 510           int[] sh = shifts.get(i);
 511           // compensateForEdit(shifted+sh[0], sh[1]);
 512           compensateForDelEdits(shifted + sh[0], sh[1]);
 513           shifted -= sh[1];
 514         }
 515       }
 516       return shiftrecord.getInverse();
 517     }
 518     return null;
 519   }
 520
 521   /**
 522    * removes intersection of position,length ranges in deletions from the
 523    * start,end regions marked in intervals.
 524    *
 525    * @param shifts
 526    * @param intervals
 527    * @return
 528    */
 529   private boolean pruneIntervalVector(final List<int[]> shifts,
 530           Vector<int[]> intervals)
 531   {
 532     boolean pruned = false;
 533     int i = 0, j = intervals.size() - 1, s = 0, t = shifts.size() - 1;
 534     int hr[] = intervals.elementAt(i);
 535     int sr[] = shifts.get(s);
 536     while (i <= j && s <= t)
 537     {
 538       boolean trailinghn = hr[1] >= sr[0];
 539       if (!trailinghn)
 540       {
 541         if (i < j)
 542         {
 543           hr = intervals.elementAt(++i);
 544         }
 545         else
 546         {
 547           i++;
 548         }
 549         continue;
 550       }
 551       int endshift = sr[0] + sr[1]; // deletion ranges - -ve means an insert
 552       if (endshift < hr[0] || endshift < sr[0])
 553       { // leadinghc disjoint or not a deletion
 554         if (s < t)
 555         {
 556           sr = shifts.get(++s);
 557         }
 558         else
 559         {
 560           s++;
 561         }
 562         continue;
 563       }
 564       boolean leadinghn = hr[0] >= sr[0];
 565       boolean leadinghc = hr[0] < endshift;
 566       boolean trailinghc = hr[1] < endshift;
 567       if (leadinghn)
 568       {
 569         if (trailinghc)
 570         { // deleted hidden region.
 571           intervals.removeElementAt(i);
 572           pruned = true;
 573           j--;
 574           if (i <= j)
 575           {
 576             hr = intervals.elementAt(i);
 577           }
 578           continue;
 579         }
 580         if (leadinghc)
 581         {
 582           hr[0] = endshift; // clip c terminal region
 583           leadinghn = !leadinghn;
 584           pruned = true;
 585         }
 586       }
 587       if (!leadinghn)
 588       {
 589         if (trailinghc)
 590         {
 591           if (trailinghn)
 592           {
 593             hr[1] = sr[0] - 1;
 594             pruned = true;
 595           }
 596         }
 597         else
 598         {
 599           // sr contained in hr
 600           if (s < t)
 601           {
 602             sr = shifts.get(++s);
 603           }
 604           else
 605           {
 606             s++;
 607           }
 608           continue;
 609         }
 610       }
 611     }
 612     return pruned; // true if any interval was removed or modified by
 613     // operations.
 614   }
 615
 616   /**
 617    * remove any hiddenColumns or selected columns and shift remaining based on a
 618    * series of position, range deletions.
 619    *
 620    * @param deletions
 621    */
 622   public void pruneDeletions(ShiftList deletions)
 623   {
 624     if (deletions != null)
 625     {
 626       final List<int[]> shifts = deletions.getShifts();
 627       if (shifts != null && shifts.size() > 0)
 628       {
 629         // delete any intervals intersecting.
 630         if (hiddenColumns != null)
 631         {
 632           pruneIntervalVector(shifts, hiddenColumns);
 633           if (hiddenColumns != null && hiddenColumns.size() == 0)
 634           {
 635             hiddenColumns = null;
 636           }
 637         }
 638         if (selection != null && selection.size() > 0)
 639         {
 640           selection.pruneColumnList(shifts);
 641           if (selection != null && selection.size() == 0)
 642           {
 643             selection = null;
 644           }
 645         }
 646         // and shift the rest.
 647         this.compensateForEdits(deletions);
 648       }
 649     }
 650   }
 651
 652   /**
 653    * This Method is used to return all the HiddenColumn regions
 654    *
 655    * @return empty list or List of hidden column intervals
 656    */
 657   public List<int[]> getHiddenColumns()
 658   {
 659     return hiddenColumns == null ? Collections.<int[]> emptyList()
 660             : hiddenColumns;
 661   }
 662
 663   /**
 664    * Return absolute column index for a visible column index
 665    *
 666    * @param column
 667    *          int column index in alignment view (count from zero)
 668    * @return alignment column index for column
 669    */
 670   public int adjustForHiddenColumns(int column)
 671   {
 672     int result = column;
 673     if (hiddenColumns != null)
 674     {
 675       for (int i = 0; i < hiddenColumns.size(); i++)
 676       {
 677         int[] region = hiddenColumns.elementAt(i);
 678         if (result >= region[0])
 679         {
 680           result += region[1] - region[0] + 1;
 681         }
 682       }
 683     }
 684     return result;
 685   }
 686
 687   /**
 688    * Use this method to find out where a column will appear in the visible
 689    * alignment when hidden columns exist. If the column is not visible, then the
 690    * left-most visible column will always be returned.
 691    *
 692    * @param hiddenColumn
 693    *          the column index in the full alignment including hidden columns
 694    * @return the position of the column in the visible alignment
 695    */
 696   public int findColumnPosition(int hiddenColumn)
 697   {
 698     int result = hiddenColumn;
 699     if (hiddenColumns != null)
 700     {
 701       int index = 0;
 702       int[] region;
 703       do
 704       {
 705         region = hiddenColumns.elementAt(index++);
 706         if (hiddenColumn > region[1])
 707         {
 708           result -= region[1] + 1 - region[0];
 709         }
 710       } while ((hiddenColumn > region[1]) && (index < hiddenColumns.size()));
 711
 712       if (hiddenColumn >= region[0] && hiddenColumn <= region[1])
 713        {
 714          // Here the hidden column is within a region, so
 715          // we want to return the position of region[0]-1, adjusted for any
 716          // earlier hidden columns.
 717          // Calculate the difference between the actual hidden col position
 718          // and region[0]-1, and then subtract from result to convert result from
 719          // the adjusted hiddenColumn value to the adjusted region[0]-1 value
 720
 721          return result - (hiddenColumn - region[0] + 1);
 722       }
 723     }
 724     return result; // return the shifted position after removing hidden columns.
 725   }
 726
 727   /**
 728    * Use this method to determine where the next hiddenRegion starts
 729    *
 730    * @param hiddenRegion
 731    *          index of hidden region (counts from 0)
 732    * @return column number in visible view
 733    */
 734   public int findHiddenRegionPosition(int hiddenRegion)
 735   {
 736     int result = 0;
 737     if (hiddenColumns != null)
 738     {
 739       int index = 0;
 740       int gaps = 0;
 741       do
 742       {
 743         int[] region = hiddenColumns.elementAt(index);
 744         if (hiddenRegion == 0)
 745         {
 746           return region[0];
 747         }
 748
 749         gaps += region[1] + 1 - region[0];
 750         result = region[1] + 1;
 751         index++;
 752       } while (index <= hiddenRegion);
 753
 754       result -= gaps;
 755     }
 756
 757     return result;
 758   }
 759
 760   /**
 761    * THis method returns the rightmost limit of a region of an alignment with
 762    * hidden columns. In otherwords, the next hidden column.
 763    *
 764    * @param index
 765    *          int
 766    */
 767   public int getHiddenBoundaryRight(int alPos)
 768   {
 769     if (hiddenColumns != null)
 770     {
 771       int index = 0;
 772       do
 773       {
 774         int[] region = hiddenColumns.elementAt(index);
 775         if (alPos < region[0])
 776         {
 777           return region[0];
 778         }
 779
 780         index++;
 781       } while (index < hiddenColumns.size());
 782     }
 783
 784     return alPos;
 785
 786   }
 787
 788   /**
 789    * This method returns the leftmost limit of a region of an alignment with
 790    * hidden columns. In otherwords, the previous hidden column.
 791    *
 792    * @param index
 793    *          int
 794    */
 795   public int getHiddenBoundaryLeft(int alPos)
 796   {
 797     if (hiddenColumns != null)
 798     {
 799       int index = hiddenColumns.size() - 1;
 800       do
 801       {
 802         int[] region = hiddenColumns.elementAt(index);
 803         if (alPos > region[1])
 804         {
 805           return region[1];
 806         }
 807
 808         index--;
 809       } while (index > -1);
 810     }
 811
 812     return alPos;
 813
 814   }
 815
 816   public void hideSelectedColumns()
 817   {
 818     synchronized (selection)
 819     {
 820       for (int[] selregions : selection.getRanges())
 821       {
 822         hideColumns(selregions[0], selregions[1]);
 823       }
 824       selection.clear();
 825     }
 826
 827   }
 828
 829   /**
 830    * Adds the specified column range to the hidden columns
 831    *
 832    * @param start
 833    * @param end
 834    */
 835   public void hideColumns(int start, int end)
 836   {
 837     if (hiddenColumns == null)
 838     {
 839       hiddenColumns = new Vector<int[]>();
 840     }
 841
 842     /*
 843      * traverse existing hidden ranges and insert / amend / append as
 844      * appropriate
 845      */
 846     for (int i = 0; i < hiddenColumns.size(); i++)
 847     {
 848       int[] region = hiddenColumns.elementAt(i);
 849
 850       if (end < region[0] - 1)
 851       {
 852         /*
 853          * insert discontiguous preceding range
 854          */
 855         hiddenColumns.insertElementAt(new int[] { start, end }, i);
 856         return;
 857       }
 858
 859       if (end <= region[1])
 860       {
 861         /*
 862          * new range overlaps existing, or is contiguous preceding it - adjust
 863          * start column
 864          */
 865         region[0] = Math.min(region[0], start);
 866         return;
 867       }
 868
 869       if (start <= region[1] + 1)
 870       {
 871         /*
 872          * new range overlaps existing, or is contiguous following it - adjust
 873          * start and end columns
 874          */
 875         region[0] = Math.min(region[0], start);
 876         region[1] = Math.max(region[1], end);
 877
 878         /*
 879          * also update or remove any subsequent ranges
 880          * that are overlapped
 881          */
 882         while (i < hiddenColumns.size() - 1)
 883         {
 884           int[] nextRegion = hiddenColumns.get(i + 1);
 885           if (nextRegion[0] > end + 1)
 886           {
 887             /*
 888              * gap to next hidden range - no more to update
 889              */
 890             break;
 891           }
 892           region[1] = Math.max(nextRegion[1], end);
 893           hiddenColumns.remove(i + 1);
 894         }
 895         return;
 896       }
 897     }
 898
 899     /*
 900      * remaining case is that the new range follows everything else
 901      */
 902     hiddenColumns.addElement(new int[] { start, end });
 903   }
 904
 905   /**
 906    * Hides the specified column and any adjacent selected columns
 907    *
 908    * @param res
 909    *          int
 910    */
 911   public void hideColumns(int col)
 912   {
 913     /*
 914      * deselect column (whether selected or not!)
 915      */
 916     removeElement(col);
 917
 918     /*
 919      * find adjacent selected columns
 920      */
 921     int min = col - 1, max = col + 1;
 922     while (contains(min))
 923     {
 924       removeElement(min);
 925       min--;
 926     }
 927
 928     while (contains(max))
 929     {
 930       removeElement(max);
 931       max++;
 932     }
 933
 934     /*
 935      * min, max are now the closest unselected columns
 936      */
 937     min++;
 938     max--;
 939     if (min > max)
 940     {
 941       min = max;
 942     }
 943
 944     hideColumns(min, max);
 945   }
 946
 947   /**
 948    * Unhides, and adds to the selection list, all hidden columns
 949    */
 950   public void revealAllHiddenColumns()
 951   {
 952     if (hiddenColumns != null)
 953     {
 954       for (int i = 0; i < hiddenColumns.size(); i++)
 955       {
 956         int[] region = hiddenColumns.elementAt(i);
 957         for (int j = region[0]; j < region[1] + 1; j++)
 958         {
 959           addElement(j);
 960         }
 961       }
 962     }
 963
 964     hiddenColumns = null;
 965   }
 966
 967   /**
 968    * Reveals, and marks as selected, the hidden column range with the given
 969    * start column
 970    *
 971    * @param start
 972    */
 973   public void revealHiddenColumns(int start)
 974   {
 975     for (int i = 0; i < hiddenColumns.size(); i++)
 976     {
 977       int[] region = hiddenColumns.elementAt(i);
 978       if (start == region[0])
 979       {
 980         for (int j = region[0]; j < region[1] + 1; j++)
 981         {
 982           addElement(j);
 983         }
 984
 985         hiddenColumns.removeElement(region);
 986         break;
 987       }
 988     }
 989     if (hiddenColumns.size() == 0)
 990     {
 991       hiddenColumns = null;
 992     }
 993   }
 994
 995   public boolean isVisible(int column)
 996   {
 997     if (hiddenColumns != null)
 998     {
 999       for (int[] region : hiddenColumns)
1000       {
1001         if (column >= region[0] && column <= region[1])
1002         {
1003           return false;
1004         }
1005       }
1006     }
1007
1008     return true;
1009   }
1010
1011   /**
1012    * Copy constructor
1013    *
1014    * @param copy
1015    */
1016   public ColumnSelection(ColumnSelection copy)
1017   {
1018     if (copy != null)
1019     {
1020       selection = new IntList(copy.selection);
1021       if (copy.hiddenColumns != null)
1022       {
1023         hiddenColumns = new Vector<int[]>(copy.hiddenColumns.size());
1024         for (int i = 0, j = copy.hiddenColumns.size(); i < j; i++)
1025         {
1026           int[] rh, cp;
1027           rh = copy.hiddenColumns.elementAt(i);
1028           if (rh != null)
1029           {
1030             cp = new int[rh.length];
1031             System.arraycopy(rh, 0, cp, 0, rh.length);
1032             hiddenColumns.addElement(cp);
1033           }
1034         }
1035       }
1036     }
1037   }
1038
1039   /**
1040    * ColumnSelection
1041    */
1042   public ColumnSelection()
1043   {
1044   }
1045
1046   public String[] getVisibleSequenceStrings(int start, int end,
1047           SequenceI[] seqs)
1048   {
1049     int i, iSize = seqs.length;
1050     String selections[] = new String[iSize];
1051     if (hiddenColumns != null && hiddenColumns.size() > 0)
1052     {
1053       for (i = 0; i < iSize; i++)
1054       {
1055         StringBuffer visibleSeq = new StringBuffer();
1056         List<int[]> regions = getHiddenColumns();
1057
1058         int blockStart = start, blockEnd = end;
1059         int[] region;
1060         int hideStart, hideEnd;
1061
1062         for (int j = 0; j < regions.size(); j++)
1063         {
1064           region = regions.get(j);
1065           hideStart = region[0];
1066           hideEnd = region[1];
1067
1068           if (hideStart < start)
1069           {
1070             continue;
1071           }
1072
1073           blockStart = Math.min(blockStart, hideEnd + 1);
1074           blockEnd = Math.min(blockEnd, hideStart);
1075
1076           if (blockStart > blockEnd)
1077           {
1078             break;
1079           }
1080
1081           visibleSeq.append(seqs[i].getSequence(blockStart, blockEnd));
1082
1083           blockStart = hideEnd + 1;
1084           blockEnd = end;
1085         }
1086
1087         if (end > blockStart)
1088         {
1089           visibleSeq.append(seqs[i].getSequence(blockStart, end));
1090         }
1091
1092         selections[i] = visibleSeq.toString();
1093       }
1094     }
1095     else
1096     {
1097       for (i = 0; i < iSize; i++)
1098       {
1099         selections[i] = seqs[i].getSequenceAsString(start, end);
1100       }
1101     }
1102
1103     return selections;
1104   }
1105
1106   /**
1107    * return all visible segments between the given start and end boundaries
1108    *
1109    * @param start
1110    *          (first column inclusive from 0)
1111    * @param end
1112    *          (last column - not inclusive)
1113    * @return int[] {i_start, i_end, ..} where intervals lie in
1114    *         start<=i_start<=i_end<end
1115    */
1116   public int[] getVisibleContigs(int start, int end)
1117   {
1118     if (hiddenColumns != null && hiddenColumns.size() > 0)
1119     {
1120       List<int[]> visiblecontigs = new ArrayList<int[]>();
1121       List<int[]> regions = getHiddenColumns();
1122
1123       int vstart = start;
1124       int[] region;
1125       int hideStart, hideEnd;
1126
1127       for (int j = 0; vstart < end && j < regions.size(); j++)
1128       {
1129         region = regions.get(j);
1130         hideStart = region[0];
1131         hideEnd = region[1];
1132
1133         if (hideEnd < vstart)
1134         {
1135           continue;
1136         }
1137         if (hideStart > vstart)
1138         {
1139           visiblecontigs.add(new int[] { vstart, hideStart - 1 });
1140         }
1141         vstart = hideEnd + 1;
1142       }
1143
1144       if (vstart < end)
1145       {
1146         visiblecontigs.add(new int[] { vstart, end - 1 });
1147       }
1148       int[] vcontigs = new int[visiblecontigs.size() * 2];
1149       for (int i = 0, j = visiblecontigs.size(); i < j; i++)
1150       {
1151         int[] vc = visiblecontigs.get(i);
1152         visiblecontigs.set(i, null);
1153         vcontigs[i * 2] = vc[0];
1154         vcontigs[i * 2 + 1] = vc[1];
1155       }
1156       visiblecontigs.clear();
1157       return vcontigs;
1158     }
1159     else
1160     {
1161       return new int[] { start, end - 1 };
1162     }
1163   }
1164
1165   /**
1166    * Locate the first and last position visible for this sequence. if seq isn't
1167    * visible then return the position of the left and right of the hidden
1168    * boundary region, and the corresponding alignment column indices for the
1169    * extent of the sequence
1170    *
1171    * @param seq
1172    * @return int[] { visible start, visible end, first seqpos, last seqpos,
1173    *         alignment index for seq start, alignment index for seq end }
1174    */
1175   public int[] locateVisibleBoundsOfSequence(SequenceI seq)
1176   {
1177     int fpos = seq.getStart(), lpos = seq.getEnd();
1178     int start = 0;
1179
1180     if (hiddenColumns == null || hiddenColumns.size() == 0)
1181     {
1182       int ifpos = seq.findIndex(fpos) - 1, ilpos = seq.findIndex(lpos) - 1;
1183       return new int[] { ifpos, ilpos, fpos, lpos, ifpos, ilpos };
1184     }
1185
1186     // Simply walk along the sequence whilst watching for hidden column
1187     // boundaries
1188     List<int[]> regions = getHiddenColumns();
1189     int spos = fpos, lastvispos = -1, rcount = 0, hideStart = seq
1190             .getLength(), hideEnd = -1;
1191     int visPrev = 0, visNext = 0, firstP = -1, lastP = -1;
1192     boolean foundStart = false;
1193     for (int p = 0, pLen = seq.getLength(); spos <= seq.getEnd()
1194             && p < pLen; p++)
1195     {
1196       if (!Comparison.isGap(seq.getCharAt(p)))
1197       {
1198         // keep track of first/last column
1199         // containing sequence data regardless of visibility
1200         if (firstP == -1)
1201         {
1202           firstP = p;
1203         }
1204         lastP = p;
1205         // update hidden region start/end
1206         while (hideEnd < p && rcount < regions.size())
1207         {
1208           int[] region = regions.get(rcount++);
1209           visPrev = visNext;
1210           visNext += region[0] - visPrev;
1211           hideStart = region[0];
1212           hideEnd = region[1];
1213         }
1214         if (hideEnd < p)
1215         {
1216           hideStart = seq.getLength();
1217         }
1218         // update visible boundary for sequence
1219         if (p < hideStart)
1220         {
1221           if (!foundStart)
1222           {
1223             fpos = spos;
1224             start = p;
1225             foundStart = true;
1226           }
1227           lastvispos = p;
1228           lpos = spos;
1229         }
1230         // look for next sequence position
1231         spos++;
1232       }
1233     }
1234     if (foundStart)
1235     {
1236       return new int[] { findColumnPosition(start),
1237           findColumnPosition(lastvispos), fpos, lpos, firstP, lastP };
1238     }
1239     // otherwise, sequence was completely hidden
1240     return new int[] { visPrev, visNext, 0, 0, firstP, lastP };
1241   }
1242
1243   /**
1244    * delete any columns in alignmentAnnotation that are hidden (including
1245    * sequence associated annotation).
1246    *
1247    * @param alignmentAnnotation
1248    */
1249   public void makeVisibleAnnotation(AlignmentAnnotation alignmentAnnotation)
1250   {
1251     makeVisibleAnnotation(-1, -1, alignmentAnnotation);
1252   }
1253
1254   /**
1255    * delete any columns in alignmentAnnotation that are hidden (including
1256    * sequence associated annotation).
1257    *
1258    * @param start
1259    *          remove any annotation to the right of this column
1260    * @param end
1261    *          remove any annotation to the left of this column
1262    * @param alignmentAnnotation
1263    *          the annotation to operate on
1264    */
1265   public void makeVisibleAnnotation(int start, int end,
1266           AlignmentAnnotation alignmentAnnotation)
1267   {
1268     if (alignmentAnnotation.annotations == null)
1269     {
1270       return;
1271     }
1272     if (start == end && end == -1)
1273     {
1274       start = 0;
1275       end = alignmentAnnotation.annotations.length;
1276     }
1277     if (hiddenColumns != null && hiddenColumns.size() > 0)
1278     {
1279       // then mangle the alignmentAnnotation annotation array
1280       Vector<Annotation[]> annels = new Vector<Annotation[]>();
1281       Annotation[] els = null;
1282       List<int[]> regions = getHiddenColumns();
1283       int blockStart = start, blockEnd = end;
1284       int[] region;
1285       int hideStart, hideEnd, w = 0;
1286
1287       for (int j = 0; j < regions.size(); j++)
1288       {
1289         region = regions.get(j);
1290         hideStart = region[0];
1291         hideEnd = region[1];
1292
1293         if (hideStart < start)
1294         {
1295           continue;
1296         }
1297
1298         blockStart = Math.min(blockStart, hideEnd + 1);
1299         blockEnd = Math.min(blockEnd, hideStart);
1300
1301         if (blockStart > blockEnd)
1302         {
1303           break;
1304         }
1305
1306         annels.addElement(els = new Annotation[blockEnd - blockStart]);
1307         System.arraycopy(alignmentAnnotation.annotations, blockStart, els,
1308                 0, els.length);
1309         w += els.length;
1310         blockStart = hideEnd + 1;
1311         blockEnd = end;
1312       }
1313
1314       if (end > blockStart)
1315       {
1316         annels.addElement(els = new Annotation[end - blockStart + 1]);
1317         if ((els.length + blockStart) <= alignmentAnnotation.annotations.length)
1318         {
1319           // copy just the visible segment of the annotation row
1320           System.arraycopy(alignmentAnnotation.annotations, blockStart,
1321                   els, 0, els.length);
1322         }
1323         else
1324         {
1325           // copy to the end of the annotation row
1326           System.arraycopy(alignmentAnnotation.annotations, blockStart,
1327                   els, 0,
1328                   (alignmentAnnotation.annotations.length - blockStart));
1329         }
1330         w += els.length;
1331       }
1332       if (w == 0)
1333       {
1334         return;
1335       }
1336
1337       alignmentAnnotation.annotations = new Annotation[w];
1338       w = 0;
1339
1340       for (Annotation[] chnk : annels)
1341       {
1342         System.arraycopy(chnk, 0, alignmentAnnotation.annotations, w,
1343                 chnk.length);
1344         w += chnk.length;
1345       }
1346     }
1347     else
1348     {
1349       alignmentAnnotation.restrict(start, end);
1350     }
1351   }
1352
1353   /**
1354    * Invert the column selection from first to end-1. leaves hiddenColumns
1355    * untouched (and unselected)
1356    *
1357    * @param first
1358    * @param end
1359    */
1360   public void invertColumnSelection(int first, int width)
1361   {
1362     boolean hasHidden = hiddenColumns != null && hiddenColumns.size() > 0;
1363     for (int i = first; i < width; i++)
1364     {
1365       if (contains(i))
1366       {
1367         removeElement(i);
1368       }
1369       else
1370       {
1371         if (!hasHidden || isVisible(i))
1372         {
1373           addElement(i);
1374         }
1375       }
1376     }
1377   }
1378
1379   /**
1380    * add in any unselected columns from the given column selection, excluding
1381    * any that are hidden.
1382    *
1383    * @param colsel
1384    */
1385   public void addElementsFrom(ColumnSelection colsel)
1386   {
1387     if (colsel != null && !colsel.isEmpty())
1388     {
1389       for (Integer col : colsel.getSelected())
1390       {
1391         if (hiddenColumns != null && isVisible(col.intValue()))
1392         {
1393           selection.add(col);
1394         }
1395       }
1396     }
1397   }
1398
1399   /**
1400    * set the selected columns the given column selection, excluding any columns
1401    * that are hidden.
1402    *
1403    * @param colsel
1404    */
1405   public void setElementsFrom(ColumnSelection colsel)
1406   {
1407     selection = new IntList();
1408     if (colsel.selection != null && colsel.selection.size() > 0)
1409     {
1410       if (hiddenColumns != null && hiddenColumns.size() > 0)
1411       {
1412         // only select visible columns in this columns selection
1413         addElementsFrom(colsel);
1414       }
1415       else
1416       {
1417         // add everything regardless
1418         for (Integer col : colsel.getSelected())
1419         {
1420           addElement(col);
1421         }
1422       }
1423     }
1424   }
1425
1426   /**
1427    * Add gaps into the sequences aligned to profileseq under the given
1428    * AlignmentView
1429    *
1430    * @param profileseq
1431    * @param al
1432    *          - alignment to have gaps inserted into it
1433    * @param input
1434    *          - alignment view where sequence corresponding to profileseq is
1435    *          first entry
1436    * @return new Column selection for new alignment view, with insertions into
1437    *         profileseq marked as hidden.
1438    */
1439   public static ColumnSelection propagateInsertions(SequenceI profileseq,
1440           AlignmentI al, AlignmentView input)
1441   {
1442     int profsqpos = 0;
1443
1444     // return propagateInsertions(profileseq, al, )
1445     char gc = al.getGapCharacter();
1446     Object[] alandcolsel = input.getAlignmentAndColumnSelection(gc);
1447     ColumnSelection nview = (ColumnSelection) alandcolsel[1];
1448     SequenceI origseq = ((SequenceI[]) alandcolsel[0])[profsqpos];
1449     nview.propagateInsertions(profileseq, al, origseq);
1450     return nview;
1451   }
1452
1453   /**
1454    *
1455    * @param profileseq
1456    *          - sequence in al which corresponds to origseq
1457    * @param al
1458    *          - alignment which is to have gaps inserted into it
1459    * @param origseq
1460    *          - sequence corresponding to profileseq which defines gap map for
1461    *          modifying al
1462    */
1463   public void propagateInsertions(SequenceI profileseq, AlignmentI al,
1464           SequenceI origseq)
1465   {
1466     char gc = al.getGapCharacter();
1467     // recover mapping between sequence's non-gap positions and positions
1468     // mapping to view.
1469     pruneDeletions(ShiftList.parseMap(origseq.gapMap()));
1470     int[] viscontigs = getVisibleContigs(0, profileseq.getLength());
1471     int spos = 0;
1472     int offset = 0;
1473     // input.pruneDeletions(ShiftList.parseMap(((SequenceI[])
1474     // alandcolsel[0])[0].gapMap()))
1475     // add profile to visible contigs
1476     for (int v = 0; v < viscontigs.length; v += 2)
1477     {
1478       if (viscontigs[v] > spos)
1479       {
1480         StringBuffer sb = new StringBuffer();
1481         for (int s = 0, ns = viscontigs[v] - spos; s < ns; s++)
1482         {
1483           sb.append(gc);
1484         }
1485         for (int s = 0, ns = al.getHeight(); s < ns; s++)
1486         {
1487           SequenceI sqobj = al.getSequenceAt(s);
1488           if (sqobj != profileseq)
1489           {
1490             String sq = al.getSequenceAt(s).getSequenceAsString();
1491             if (sq.length() <= spos + offset)
1492             {
1493               // pad sequence
1494               int diff = spos + offset - sq.length() - 1;
1495               if (diff > 0)
1496               {
1497                 // pad gaps
1498                 sq = sq + sb;
1499                 while ((diff = spos + offset - sq.length() - 1) > 0)
1500                 {
1501                   // sq = sq
1502                   // + ((diff >= sb.length()) ? sb.toString() : sb
1503                   // .substring(0, diff));
1504                   if (diff >= sb.length())
1505                   {
1506                     sq += sb.toString();
1507                   }
1508                   else
1509                   {
1510                     char[] buf = new char[diff];
1511                     sb.getChars(0, diff, buf, 0);
1512                     sq += buf.toString();
1513                   }
1514                 }
1515               }
1516               sq += sb.toString();
1517             }
1518             else
1519             {
1520               al.getSequenceAt(s).setSequence(
1521                       sq.substring(0, spos + offset) + sb.toString()
1522                               + sq.substring(spos + offset));
1523             }
1524           }
1525         }
1526         // offset+=sb.length();
1527       }
1528       spos = viscontigs[v + 1] + 1;
1529     }
1530     if ((offset + spos) < profileseq.getLength())
1531     {
1532       // pad the final region with gaps.
1533       StringBuffer sb = new StringBuffer();
1534       for (int s = 0, ns = profileseq.getLength() - spos - offset; s < ns; s++)
1535       {
1536         sb.append(gc);
1537       }
1538       for (int s = 0, ns = al.getHeight(); s < ns; s++)
1539       {
1540         SequenceI sqobj = al.getSequenceAt(s);
1541         if (sqobj == profileseq)
1542         {
1543           continue;
1544         }
1545         String sq = sqobj.getSequenceAsString();
1546         // pad sequence
1547         int diff = origseq.getLength() - sq.length();
1548         while (diff > 0)
1549         {
1550           // sq = sq
1551           // + ((diff >= sb.length()) ? sb.toString() : sb
1552           // .substring(0, diff));
1553           if (diff >= sb.length())
1554           {
1555             sq += sb.toString();
1556           }
1557           else
1558           {
1559             char[] buf = new char[diff];
1560             sb.getChars(0, diff, buf, 0);
1561             sq += buf.toString();
1562           }
1563           diff = origseq.getLength() - sq.length();
1564         }
1565       }
1566     }
1567   }
1568
1569   /**
1570    *
1571    * @return true if there are columns marked
1572    */
1573   public boolean hasSelectedColumns()
1574   {
1575     return (selection != null && selection.size() > 0);
1576   }
1577
1578   /**
1579    *
1580    * @return true if there are columns hidden
1581    */
1582   public boolean hasHiddenColumns()
1583   {
1584     return hiddenColumns != null && hiddenColumns.size() > 0;
1585   }
1586
1587   /**
1588    *
1589    * @return true if there are more than one set of columns hidden
1590    */
1591   public boolean hasManyHiddenColumns()
1592   {
1593     return hiddenColumns != null && hiddenColumns.size() > 1;
1594   }
1595
1596   /**
1597    * mark the columns corresponding to gap characters as hidden in the column
1598    * selection
1599    *
1600    * @param sr
1601    */
1602   public void hideInsertionsFor(SequenceI sr)
1603   {
1604     List<int[]> inserts = sr.getInsertions();
1605     for (int[] r : inserts)
1606     {
1607       hideColumns(r[0], r[1]);
1608     }
1609   }
1610
1611   public boolean filterAnnotations(Annotation[] annotations,
1612           AnnotationFilterParameter filterParams)
1613   {
1614     // JBPNote - this method needs to be refactored to become independent of
1615     // viewmodel package
1616     this.revealAllHiddenColumns();
1617     this.clear();
1618     int count = 0;
1619     do
1620     {
1621       if (annotations[count] != null)
1622       {
1623
1624         boolean itemMatched = false;
1625
1626         if (filterParams.getThresholdType() == AnnotationFilterParameter.ThresholdType.ABOVE_THRESHOLD
1627                 && annotations[count].value >= filterParams
1628                         .getThresholdValue())
1629         {
1630           itemMatched = true;
1631         }
1632         if (filterParams.getThresholdType() == AnnotationFilterParameter.ThresholdType.BELOW_THRESHOLD
1633                 && annotations[count].value <= filterParams
1634                         .getThresholdValue())
1635         {
1636           itemMatched = true;
1637         }
1638
1639         if (filterParams.isFilterAlphaHelix()
1640                 && annotations[count].secondaryStructure == 'H')
1641         {
1642           itemMatched = true;
1643         }
1644
1645         if (filterParams.isFilterBetaSheet()
1646                 && annotations[count].secondaryStructure == 'E')
1647         {
1648           itemMatched = true;
1649         }
1650
1651         if (filterParams.isFilterTurn()
1652                 && annotations[count].secondaryStructure == 'S')
1653         {
1654           itemMatched = true;
1655         }
1656
1657         String regexSearchString = filterParams.getRegexString();
1658         if (regexSearchString != null
1659                 && !filterParams.getRegexSearchFields().isEmpty())
1660         {
1661           List<SearchableAnnotationField> fields = filterParams
1662                   .getRegexSearchFields();
1663           try
1664           {
1665             if (fields.contains(SearchableAnnotationField.DISPLAY_STRING)
1666                     && annotations[count].displayCharacter
1667                             .matches(regexSearchString))
1668             {
1669               itemMatched = true;
1670             }
1671           } catch (java.util.regex.PatternSyntaxException pse)
1672           {
1673             if (annotations[count].displayCharacter
1674                     .equals(regexSearchString))
1675             {
1676               itemMatched = true;
1677             }
1678           }
1679           if (fields.contains(SearchableAnnotationField.DESCRIPTION)
1680                   && annotations[count].description != null
1681                   && annotations[count].description
1682                           .matches(regexSearchString))
1683           {
1684             itemMatched = true;
1685           }
1686         }
1687
1688         if (itemMatched)
1689         {
1690           this.addElement(count);
1691         }
1692       }
1693       count++;
1694     } while (count < annotations.length);
1695     return false;
1696   }
1697
1698   /**
1699    * Returns a hashCode built from selected columns and hidden column ranges
1700    */
1701   @Override
1702   public int hashCode()
1703   {
1704     int hashCode = selection.hashCode();
1705     if (hiddenColumns != null)
1706     {
1707       for (int[] hidden : hiddenColumns)
1708       {
1709         hashCode = 31 * hashCode + hidden[0];
1710         hashCode = 31 * hashCode + hidden[1];
1711       }
1712     }
1713     return hashCode;
1714   }
1715
1716   /**
1717    * Answers true if comparing to a ColumnSelection with the same selected
1718    * columns and hidden columns, else false
1719    */
1720   @Override
1721   public boolean equals(Object obj)
1722   {
1723     if (!(obj instanceof ColumnSelection))
1724     {
1725       return false;
1726     }
1727     ColumnSelection that = (ColumnSelection) obj;
1728
1729     /*
1730      * check columns selected are either both null, or match
1731      */
1732     if (this.selection == null)
1733     {
1734       if (that.selection != null)
1735       {
1736         return false;
1737       }
1738     }
1739     if (!this.selection.equals(that.selection))
1740     {
1741       return false;
1742     }
1743
1744     /*
1745      * check hidden columns are either both null, or match
1746      */
1747     if (this.hiddenColumns == null)
1748     {
1749       return (that.hiddenColumns == null);
1750     }
1751     if (that.hiddenColumns == null
1752             || that.hiddenColumns.size() != this.hiddenColumns.size())
1753     {
1754       return false;
1755     }
1756     int i = 0;
1757     for (int[] thisRange : hiddenColumns)
1758     {
1759       int[] thatRange = that.hiddenColumns.get(i++);
1760       if (thisRange[0] != thatRange[0] || thisRange[1] != thatRange[1])
1761       {
1762         return false;
1763       }
1764     }
1765     return true;
1766   }
1767
1768   /**
1769    * Updates the column selection depending on the parameters, and returns true
1770    * if any change was made to the selection
1771    *
1772    * @param markedColumns
1773    *          a set identifying marked columns (base 0)
1774    * @param startCol
1775    *          the first column of the range to operate over (base 0)
1776    * @param endCol
1777    *          the last column of the range to operate over (base 0)
1778    * @param invert
1779    *          if true, deselect marked columns and select unmarked
1780    * @param extendCurrent
1781    *          if true, extend rather than replacing the current column selection
1782    * @param toggle
1783    *          if true, toggle the selection state of marked columns
1784    *
1785    * @return
1786    */
1787   public boolean markColumns(BitSet markedColumns, int startCol,
1788           int endCol, boolean invert, boolean extendCurrent, boolean toggle)
1789   {
1790     boolean changed = false;
1791     if (!extendCurrent && !toggle)
1792     {
1793       changed = !this.isEmpty();
1794       clear();
1795     }
1796     if (invert)
1797     {
1798       // invert only in the currently selected sequence region
1799       int i = markedColumns.nextClearBit(startCol);
1800       int ibs = markedColumns.nextSetBit(startCol);
1801       while (i >= startCol && i <= endCol)
1802       {
1803         if (ibs < 0 || i < ibs)
1804         {
1805           changed = true;
1806           if (toggle && contains(i))
1807           {
1808             removeElement(i++);
1809           }
1810           else
1811           {
1812             addElement(i++);
1813           }
1814         }
1815         else
1816         {
1817           i = markedColumns.nextClearBit(ibs);
1818           ibs = markedColumns.nextSetBit(i);
1819         }
1820       }
1821     }
1822     else
1823     {
1824       int i = markedColumns.nextSetBit(startCol);
1825       while (i >= startCol && i <= endCol)
1826       {
1827         changed = true;
1828         if (toggle && contains(i))
1829         {
1830           removeElement(i);
1831         }
1832         else
1833         {
1834           addElement(i);
1835         }
1836         i = markedColumns.nextSetBit(i + 1);
1837       }
1838     }
1839     return changed;
1840   }
1841
1842   /**
1843    * Adjusts column selections, and the given selection group, to match the
1844    * range of a stretch (e.g. mouse drag) operation
1845    * <p>
1846    * Method refactored from ScalePanel.mouseDragged
1847    *
1848    * @param res
1849    *          current column position, adjusted for hidden columns
1850    * @param sg
1851    *          current selection group
1852    * @param min
1853    *          start position of the stretch group
1854    * @param max
1855    *          end position of the stretch group
1856    */
1857   public void stretchGroup(int res, SequenceGroup sg, int min, int max)
1858   {
1859     if (!contains(res))
1860     {
1861       addElement(res);
1862     }
1863
1864     if (res > sg.getStartRes())
1865     {
1866       // expand selection group to the right
1867       sg.setEndRes(res);
1868     }
1869     if (res < sg.getStartRes())
1870     {
1871       // expand selection group to the left
1872       sg.setStartRes(res);
1873     }
1874
1875     /*
1876      * expand or shrink column selection to match the
1877      * range of the drag operation
1878      */
1879     for (int col = min; col <= max; col++)
1880     {
1881       if (col < sg.getStartRes() || col > sg.getEndRes())
1882       {
1883         // shrinking drag - remove from selection
1884         removeElement(col);
1885       }
1886       else
1887       {
1888         // expanding drag - add to selection
1889         addElement(col);
1890       }
1891     }
1892   }
1893 }