2 * Jalview - A Sequence Alignment Editor and Viewer
\r
3 * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
\r
5 * This program is free software; you can redistribute it and/or
\r
6 * modify it under the terms of the GNU General Public License
\r
7 * as published by the Free Software Foundation; either version 2
\r
8 * of the License, or (at your option) any later version.
\r
10 * This program is distributed in the hope that it will be useful,
\r
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
13 * GNU General Public License for more details.
\r
15 * You should have received a copy of the GNU General Public License
\r
16 * along with this program; if not, write to the Free Software
\r
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
\r
19 package jalview.datamodel;
\r
21 import jalview.util.ShiftList;
\r
26 * NOTE: Columns are zero based.
\r
28 public class ColumnSelection
\r
30 Vector selected = new Vector();
\r
32 //Vector of int [] {startCol, endCol}
\r
33 Vector hiddenColumns;
\r
36 * Add a column to the selection
\r
38 * @param col index of column
\r
40 public void addElement(int col)
\r
42 Integer column = new Integer(col);
\r
43 if (!selected.contains(column))
\r
45 selected.addElement(column);
\r
50 * clears column selection
\r
54 selected.removeAllElements();
\r
58 * removes col from selection
\r
60 * @param col index of column to be removed
\r
62 public void removeElement(int col)
\r
64 Integer colInt = new Integer(col);
\r
66 if (selected.contains(colInt))
\r
68 selected.removeElement(colInt);
\r
73 * removes a range of columns from the selection
\r
74 * @param start int - first column in range to be removed
\r
75 * @param end int - last col
\r
77 public void removeElements(int start, int end)
\r
80 for(int i=start; i<end; i++)
\r
82 colInt = new Integer(i);
\r
83 if (selected.contains(colInt))
\r
85 selected.removeElement(colInt);
\r
91 * @return Vector containing selected columns as Integers
\r
93 public Vector getSelected()
\r
100 * @param col index to search for in column selection
\r
102 * @return true if Integer(col) is in selection.
\r
104 public boolean contains(int col)
\r
106 return selected.contains(new Integer(col));
\r
112 * @param i DOCUMENT ME!
\r
114 * @return DOCUMENT ME!
\r
116 public int columnAt(int i)
\r
118 return ((Integer) selected.elementAt(i)).intValue();
\r
124 * @return DOCUMENT ME!
\r
128 return selected.size();
\r
134 * @return DOCUMENT ME!
\r
136 public int getMax()
\r
140 for (int i = 0; i < selected.size(); i++)
\r
142 if (columnAt(i) > max)
\r
154 * @return DOCUMENT ME!
\r
156 public int getMin()
\r
158 int min = 1000000000;
\r
160 for (int i = 0; i < selected.size(); i++)
\r
162 if (columnAt(i) < min)
\r
173 * propagate shift in alignment columns to column selection
\r
175 * @param start beginning of edit
\r
176 * @param left shift in edit (+ve for removal, or -ve for inserts)
\r
178 public void compensateForEdit(int start, int change)
\r
180 for (int i = 0; i < size(); i++)
\r
182 int temp = columnAt(i);
\r
186 selected.setElementAt(new Integer(temp - change), i);
\r
190 if(hiddenColumns!=null)
\r
192 for(int i=0; i<hiddenColumns.size(); i++)
\r
194 int[] region = (int[]) hiddenColumns.elementAt(i);
\r
195 if(region[0] > start)
\r
197 region[0] -= change;
\r
198 region[1] -= change;
\r
208 * propagate shift in alignment columns to column selection
\r
209 * special version of compensateForEdit - allowing for edits within hidden regions
\r
210 * @param start beginning of edit
\r
211 * @param left shift in edit (+ve for removal, or -ve for inserts)
\r
213 private void compensateForDelEdits(int start, int change)
\r
215 for (int i = 0; i < size(); i++)
\r
217 int temp = columnAt(i);
\r
221 selected.setElementAt(new Integer(temp - change), i);
\r
225 if(hiddenColumns!=null)
\r
227 for(int i=0; i<hiddenColumns.size(); i++)
\r
229 int[] region = (int[]) hiddenColumns.elementAt(i);
\r
230 if(region[0] >= start)
\r
232 region[0] -= change;
\r
234 if (region[1]>= start) {
\r
235 region[1] -=change;
\r
237 if (region[1]<region[0]) {
\r
238 hiddenColumns.removeElementAt(i--);
\r
249 * Adjust hidden column boundaries based on a series of column
\r
250 * additions or deletions in visible regions.
\r
251 * @param shiftrecord
\r
254 public ShiftList compensateForEdits(ShiftList shiftrecord) {
\r
255 if (shiftrecord!=null) {
\r
256 Vector shifts = shiftrecord.shifts;
\r
257 if (shifts!=null && shifts.size()>0) {
\r
259 for (int i=0,j=shifts.size(); i<j; i++) {
\r
260 int[] sh = (int[]) shifts.elementAt(i);
\r
261 //compensateForEdit(shifted+sh[0], sh[1]);
\r
262 compensateForDelEdits(shifted+sh[0], sh[1]);
\r
266 return shiftrecord.getInverse();
\r
271 * removes intersection of position,length ranges in deletions
\r
272 * from the start,end regions marked in intervals.
\r
277 private boolean pruneIntervalVector(Vector deletions, Vector intervals) {
\r
278 boolean pruned=false;
\r
279 int i=0,j=intervals.size()-1, s=0, t=deletions.size()-1;
\r
280 int hr[]=(int[]) intervals.elementAt(i);
\r
281 int sr[]=(int[]) deletions.elementAt(s);
\r
282 while (i<=j && s<=t) {
\r
283 boolean trailinghn=hr[1]>=sr[0];
\r
286 hr=(int[]) intervals.elementAt(++i);
\r
291 int endshift=sr[0]+sr[1]; // deletion ranges - -ve means an insert
\r
292 if (endshift<hr[0] || endshift<sr[0]) { // leadinghc disjoint or not a deletion
\r
294 sr=(int[]) deletions.elementAt(++s);
\r
299 boolean leadinghn=hr[0]>=sr[0];
\r
300 boolean leadinghc=hr[0]<endshift;
\r
301 boolean trailinghc=hr[1]<endshift;
\r
303 if (trailinghc) {// deleted hidden region.
\r
304 intervals.removeElementAt(i);
\r
308 hr=(int[]) intervals.elementAt(i);
\r
312 hr[0]=endshift; // clip c terminal region
\r
313 leadinghn=!leadinghn;
\r
324 // sr contained in hr
\r
326 sr=(int[]) deletions.elementAt(++s);
\r
333 return pruned; // true if any interval was removed or modified by operations.
\r
335 private boolean pruneColumnList(Vector deletion, Vector list) {
\r
336 int s=0,t=deletion.size();
\r
337 int[] sr=(int[])list.elementAt(s++);
\r
338 boolean pruned=false;
\r
339 int i=0, j=list.size();
\r
340 while (i<j && s<=t) {
\r
341 int c=((Integer)list.elementAt(i++)).intValue();
\r
343 if (sr[1]+sr[0]>=c) { // sr[1] -ve means inseriton.
\r
344 list.removeElementAt(--i);
\r
348 sr = (int[])deletion.elementAt(s);
\r
356 * remove any hiddenColumns or selected columns and shift remaining
\r
357 * based on a series of position, range deletions.
\r
360 public void pruneDeletions(ShiftList deletions) {
\r
361 if (deletions!=null) {
\r
362 Vector shifts=deletions.shifts;
\r
363 if (shifts!=null && shifts.size()>0) {
\r
364 // delete any intervals intersecting.
\r
365 if (hiddenColumns!=null) {
\r
366 pruneIntervalVector(shifts, hiddenColumns);
\r
367 if (hiddenColumns!=null && hiddenColumns.size()==0) {
\r
368 hiddenColumns=null;
\r
371 if (selected!=null && selected.size()>0) {
\r
372 pruneColumnList(shifts, selected);
\r
373 if (selected!=null && selected.size()==0)
\r
376 // and shift the rest.
\r
377 this.compensateForEdits(deletions);
\r
382 * This Method is used to return all the HiddenColumn regions
\r
383 * less than the given index.
\r
387 public Vector getHiddenColumns()
\r
389 return hiddenColumns;
\r
392 * Return absolute column index for a visible column index
\r
393 * @param column int column index in alignment view
\r
394 * @return alignment column index for column
\r
396 public int adjustForHiddenColumns(int column)
\r
398 int result = column;
\r
399 if (hiddenColumns != null)
\r
401 for (int i = 0; i < hiddenColumns.size(); i++)
\r
403 int[] region = (int[]) hiddenColumns.elementAt(i);
\r
404 if (result >= region[0])
\r
406 result += region[1] - region[0] + 1;
\r
414 * Use this method to find out where a visible column is in the alignment
\r
415 * when hidden columns exist
\r
416 * @param hiddenColumn int
\r
419 public int findColumnPosition(int hiddenColumn)
\r
421 int result = hiddenColumn;
\r
422 if (hiddenColumns != null)
\r
428 int[] region = (int[]) hiddenColumns.elementAt(index);
\r
429 if (hiddenColumn > region[1])
\r
431 result -= region[1]+1-region[0];
\r
435 while (index < hiddenColumns.size());
\r
444 * Use this method to determine where the next hiddenRegion starts
\r
446 public int findHiddenRegionPosition(int hiddenRegion)
\r
449 if (hiddenColumns != null)
\r
455 int[] region = (int[]) hiddenColumns.elementAt(index);
\r
456 if(hiddenRegion==0)
\r
461 gaps += region[1] +1 - region[0];
\r
462 result = region[1] +1;
\r
465 while(index < hiddenRegion+1);
\r
474 * THis method returns the rightmost limit of a
\r
475 * region of an alignment with hidden columns.
\r
476 * In otherwords, the next hidden column.
\r
479 public int getHiddenBoundaryRight(int alPos)
\r
481 if (hiddenColumns != null)
\r
486 int[] region = (int[]) hiddenColumns.elementAt(index);
\r
487 if(alPos < region[0])
\r
492 while(index < hiddenColumns.size());
\r
499 * THis method returns the rightmost limit of a
\r
500 * region of an alignment with hidden columns.
\r
501 * In otherwords, the next hidden column.
\r
504 public int getHiddenBoundaryLeft(int alPos)
\r
506 if (hiddenColumns != null)
\r
508 int index = hiddenColumns.size()-1;
\r
511 int[] region = (int[]) hiddenColumns.elementAt(index);
\r
512 if(alPos > region[1])
\r
524 public void hideSelectedColumns()
\r
528 int column = ( (Integer) getSelected().firstElement()).intValue();
\r
529 hideColumns(column);
\r
534 public void hideColumns(int start, int end)
\r
536 if(hiddenColumns==null)
\r
537 hiddenColumns = new Vector();
\r
539 boolean added = false;
\r
540 boolean overlap = false;
\r
542 for (int i = 0; i < hiddenColumns.size(); i++)
\r
544 int[] region = (int[]) hiddenColumns.elementAt(i);
\r
545 if ( start<=region[1] && end>=region[0])
\r
547 hiddenColumns.removeElementAt(i);
\r
551 else if (end < region[0] && start < region[0])
\r
553 hiddenColumns.insertElementAt(new int[]
\r
562 hideColumns(start, end);
\r
565 hiddenColumns.addElement(new int[] {start, end});
\r
570 * This method will find a range of selected columns
\r
571 * around the column specified
\r
574 public void hideColumns(int col)
\r
576 // First find out range of columns to hide
\r
577 int min = col, max = col+1;
\r
578 while( contains(min) )
\r
579 { removeElement(min); min --; }
\r
581 while( contains(max) )
\r
582 { removeElement(max); max ++; }
\r
586 hideColumns(min, max);
\r
589 public void revealAllHiddenColumns()
\r
591 if(hiddenColumns!=null)
\r
593 for (int i = 0; i < hiddenColumns.size(); i++)
\r
595 int[] region = (int[]) hiddenColumns.elementAt(i);
\r
596 for (int j = region[0]; j < region[1]+1; j++)
\r
603 hiddenColumns = null;
\r
606 public void revealHiddenColumns(int res)
\r
608 for(int i=0; i<hiddenColumns.size(); i++)
\r
610 int [] region = (int[])hiddenColumns.elementAt(i);
\r
611 if( res == region[0])
\r
613 for (int j = region[0]; j < region[1]+1; j++)
\r
618 hiddenColumns.removeElement(region);
\r
622 if(hiddenColumns.size()==0)
\r
623 hiddenColumns = null;
\r
626 public boolean isVisible(int column)
\r
628 for(int i=0; i<hiddenColumns.size(); i++)
\r
630 int [] region = (int[])hiddenColumns.elementAt(i);
\r
631 if( column >= region[0] && column <= region[1])
\r
642 public ColumnSelection(ColumnSelection copy) {
\r
644 if (copy.selected!=null) {
\r
645 selected = new Vector();
\r
646 for (int i=0,j=copy.selected.size(); i<j; i++) {
\r
647 selected.setElementAt( ((Integer) copy.selected.elementAt(i)), i);
\r
650 if (copy.hiddenColumns!=null) {
\r
651 hiddenColumns=new Vector();
\r
652 for (int i=0,j=copy.hiddenColumns.size(); i<j; i++) {
\r
654 rh = (int[])copy.hiddenColumns.elementAt(i);
\r
656 cp = new int[rh.length];
\r
657 System.arraycopy(rh, 0, cp, 0, rh.length);
\r
658 hiddenColumns.setElementAt(cp, i);
\r
667 public ColumnSelection()
\r
671 public String[] getVisibleSequenceStrings(int start, int end, SequenceI[] seqs) {
\r
672 int i,iSize=seqs.length;
\r
673 String selection[] = new String[iSize];
\r
674 if (hiddenColumns!=null && hiddenColumns.size()>0)
\r
676 for (i=0; i<iSize; i++) {
\r
677 StringBuffer visibleSeq = new StringBuffer();
\r
678 Vector regions = getHiddenColumns();
\r
680 int blockStart = start, blockEnd=end;
\r
682 int hideStart, hideEnd;
\r
684 for (int j = 0; j < regions.size(); j++)
\r
686 region = (int[]) regions.elementAt(j);
\r
687 hideStart = region[0];
\r
688 hideEnd = region[1];
\r
690 if(hideStart < start)
\r
695 blockStart = Math.min(blockStart, hideEnd+1);
\r
696 blockEnd = Math.min(blockEnd, hideStart);
\r
698 if(blockStart>blockEnd)
\r
704 visibleSeq.append(seqs[i].getSequence(blockStart, blockEnd));
\r
706 blockStart = hideEnd+1;
\r
711 visibleSeq.append(seqs[i].getSequence(blockStart, end));
\r
713 selection[i] = visibleSeq.toString();
\r
718 for(i=0; i<iSize; i++)
\r
720 selection[i] = seqs[i].getSequence(start, end);
\r
727 * return all visible segments between the given start and end boundaries
\r
729 * @param start (first column inclusive from 0)
\r
730 * @param end (last column - not inclusive)
\r
731 * @return int[] {i_start, i_end, ..} where intervals lie in start<=i_start<=i_end<end
\r
733 public int[] getVisibleContigs(int start, int end) {
\r
734 if (hiddenColumns!=null && hiddenColumns.size()>0)
\r
736 Vector visiblecontigs=new Vector();
\r
737 Vector regions = getHiddenColumns();
\r
739 int vstart = start;
\r
741 int hideStart, hideEnd;
\r
743 for (int j = 0; vstart<end && j < regions.size(); j++)
\r
745 region = (int[]) regions.elementAt(j);
\r
746 hideStart = region[0];
\r
747 hideEnd = region[1];
\r
749 if(hideEnd < vstart)
\r
753 if (hideStart>vstart) {
\r
754 visiblecontigs.addElement(new int[] {vstart, hideStart-1});
\r
760 visiblecontigs.addElement(new int[] { vstart, end-1});
\r
761 int[] vcontigs = new int[visiblecontigs.size()*2];
\r
762 for (int i=0,j=visiblecontigs.size(); i<j; i++) {
\r
763 int [] vc = (int[]) visiblecontigs.elementAt(i);
\r
764 visiblecontigs.setElementAt(null, i);
\r
765 vcontigs[i*2] = vc[0];
\r
766 vcontigs[i*2+1] = vc[1];
\r
768 visiblecontigs.removeAllElements();
\r
773 return new int[] { start, end-1 };
\r