2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.datamodel;
23 import jalview.util.Comparison;
24 import jalview.util.ShiftList;
25 import jalview.viewmodel.annotationfilter.AnnotationFilterParameter;
26 import jalview.viewmodel.annotationfilter.AnnotationFilterParameter.SearchableAnnotationField;
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;
35 * Data class holding the selected columns and hidden column ranges for a view.
38 public class ColumnSelection
41 * A class to hold an efficient representation of selected columns
46 * list of selected columns (ordered by selection order, not column order)
48 private List<Integer> order;
51 * an unmodifiable view of the selected columns list
53 private List<Integer> _uorder;
56 * bitfield for column selection - allows quick lookup
58 private BitSet selected;
65 order = new ArrayList<Integer>();
66 _uorder = Collections.unmodifiableList(order);
67 selected = new BitSet();
75 IntList(IntList other)
81 for (int i = 0; i < j; i++)
83 add(other.elementAt(i));
89 * adds a new column i to the selection - only if i is not already selected
97 order.add(Integer.valueOf(i));
111 Integer colInt = new Integer(col);
113 if (selected.get(col))
115 // if this ever changes to List.remove(), ensure Integer not int
117 // as List.remove(int i) removes the i'th item which is wrong
118 order.remove(colInt);
123 boolean contains(Integer colInt)
125 return selected.get(colInt);
130 return order.isEmpty();
134 * Returns a read-only view of the selected columns list
138 List<Integer> getList()
149 * gets the column that was selected first, second or i'th
159 protected boolean pruneColumnList(final List<int[]> shifts)
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)
167 int c = order.get(i++).intValue();
170 if (sr[1] + sr[0] >= c)
171 { // sr[1] -ve means inseriton.
190 * shift every selected column at or above start by change
193 * - leftmost column to be shifted
197 void compensateForEdits(int start, int change)
199 BitSet mask = new BitSet();
200 for (int i = 0; i < order.size(); i++)
202 int temp = order.get(i);
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));
212 // lastly update the bitfield all at once
216 boolean isSelected(int column)
218 return selected.get(column);
223 return selected.length() - 1;
228 return selected.get(0) ? 0 : selected.nextSetBit(0);
232 * @return a series of selection intervals along the range
234 List<int[]> getRanges()
236 List<int[]> rlist = new ArrayList<int[]>();
237 if (selected.isEmpty())
241 int next = selected.nextSetBit(0), clear = -1;
244 clear = selected.nextClearBit(next);
245 rlist.add(new int[] { next, clear - 1 });
246 next = selected.nextSetBit(clear);
252 public int hashCode()
254 // TODO Auto-generated method stub
255 return selected.hashCode();
259 public boolean equals(Object obj)
261 if (obj instanceof IntList)
263 return ((IntList) obj).selected.equals(selected);
269 IntList selection = new IntList();
272 * list of hidden column [start, end] ranges; the list is maintained in
273 * ascending start column order
275 Vector<int[]> hiddenColumns;
278 * Add a column to the selection
283 public void addElement(int col)
289 * clears column selection
297 * Removes value 'col' from the selection (not the col'th item)
300 * index of column to be removed
302 public void removeElement(int col)
304 selection.remove(col);
308 * removes a range of columns from the selection
311 * int - first column in range to be removed
315 public void removeElements(int start, int end)
318 for (int i = start; i < end; i++)
320 colInt = new Integer(i);
321 if (selection.contains(colInt))
323 selection.remove(colInt);
329 * Returns a read-only view of the (possibly empty) list of selected columns
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.
335 * The list is not thread-safe: iterating over it could result in
336 * ConcurrentModificationException if it is modified by another thread.
338 public List<Integer> getSelected()
340 return selection.getList();
344 * @return list of int arrays containing start and end column position for
345 * runs of selected columns ordered from right to left.
347 public List<int[]> getSelectedRanges()
349 return selection.getRanges();
355 * index to search for in column selection
357 * @return true if col is selected
359 public boolean contains(int col)
361 return (col > -1) ? selection.isSelected(col) : false;
365 * Answers true if no columns are selected, else false
367 public boolean isEmpty()
369 return selection == null || selection.isEmpty();
373 * rightmost selected column
375 * @return rightmost column in alignment that is selected
379 if (selection.isEmpty())
383 return selection.getMaxColumn();
387 * Leftmost column in selection
389 * @return column index of leftmost column in selection
393 if (selection.isEmpty())
397 return selection.getMinColumn();
401 * propagate shift in alignment columns to column selection
406 * shift in edit (+ve for removal, or -ve for inserts)
408 public List<int[]> compensateForEdit(int start, int change)
410 List<int[]> deletedHiddenColumns = null;
411 selection.compensateForEdits(start, change);
413 if (hiddenColumns != null)
415 deletedHiddenColumns = new ArrayList<int[]>();
416 int hSize = hiddenColumns.size();
417 for (int i = 0; i < hSize; i++)
419 int[] region = hiddenColumns.elementAt(i);
420 if (region[0] > start && start + change > region[1])
422 deletedHiddenColumns.add(region);
424 hiddenColumns.removeElementAt(i);
430 if (region[0] > start)
443 this.revealHiddenColumns(0);
446 return deletedHiddenColumns;
450 * propagate shift in alignment columns to column selection special version of
451 * compensateForEdit - allowing for edits within hidden regions
456 * shift in edit (+ve for removal, or -ve for inserts)
458 private void compensateForDelEdits(int start, int change)
461 selection.compensateForEdits(start, change);
463 if (hiddenColumns != null)
465 for (int i = 0; i < hiddenColumns.size(); i++)
467 int[] region = hiddenColumns.elementAt(i);
468 if (region[0] >= start)
472 if (region[1] >= start)
476 if (region[1] < region[0])
478 hiddenColumns.removeElementAt(i--);
494 * Adjust hidden column boundaries based on a series of column additions or
495 * deletions in visible regions.
500 public ShiftList compensateForEdits(ShiftList shiftrecord)
502 if (shiftrecord != null)
504 final List<int[]> shifts = shiftrecord.getShifts();
505 if (shifts != null && shifts.size() > 0)
508 for (int i = 0, j = shifts.size(); i < j; i++)
510 int[] sh = shifts.get(i);
511 // compensateForEdit(shifted+sh[0], sh[1]);
512 compensateForDelEdits(shifted + sh[0], sh[1]);
516 return shiftrecord.getInverse();
522 * removes intersection of position,length ranges in deletions from the
523 * start,end regions marked in intervals.
529 private boolean pruneIntervalVector(final List<int[]> shifts,
530 Vector<int[]> intervals)
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)
538 boolean trailinghn = hr[1] >= sr[0];
543 hr = intervals.elementAt(++i);
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
556 sr = shifts.get(++s);
564 boolean leadinghn = hr[0] >= sr[0];
565 boolean leadinghc = hr[0] < endshift;
566 boolean trailinghc = hr[1] < endshift;
570 { // deleted hidden region.
571 intervals.removeElementAt(i);
576 hr = intervals.elementAt(i);
582 hr[0] = endshift; // clip c terminal region
583 leadinghn = !leadinghn;
599 // sr contained in hr
602 sr = shifts.get(++s);
612 return pruned; // true if any interval was removed or modified by
617 * remove any hiddenColumns or selected columns and shift remaining based on a
618 * series of position, range deletions.
622 public void pruneDeletions(ShiftList deletions)
624 if (deletions != null)
626 final List<int[]> shifts = deletions.getShifts();
627 if (shifts != null && shifts.size() > 0)
629 // delete any intervals intersecting.
630 if (hiddenColumns != null)
632 pruneIntervalVector(shifts, hiddenColumns);
633 if (hiddenColumns != null && hiddenColumns.size() == 0)
635 hiddenColumns = null;
638 if (selection != null && selection.size() > 0)
640 selection.pruneColumnList(shifts);
641 if (selection != null && selection.size() == 0)
646 // and shift the rest.
647 this.compensateForEdits(deletions);
653 * This Method is used to return all the HiddenColumn regions
655 * @return empty list or List of hidden column intervals
657 public List<int[]> getHiddenColumns()
659 return hiddenColumns == null ? Collections.<int[]> emptyList()
664 * Return absolute column index for a visible column index
667 * int column index in alignment view (count from zero)
668 * @return alignment column index for column
670 public int adjustForHiddenColumns(int column)
673 if (hiddenColumns != null)
675 for (int i = 0; i < hiddenColumns.size(); i++)
677 int[] region = hiddenColumns.elementAt(i);
678 if (result >= region[0])
680 result += region[1] - region[0] + 1;
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.
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
696 public int findColumnPosition(int hiddenColumn)
698 int result = hiddenColumn;
699 if (hiddenColumns != null)
705 region = hiddenColumns.elementAt(index++);
706 if (hiddenColumn > region[1])
708 result -= region[1] + 1 - region[0];
710 } while ((hiddenColumn > region[1]) && (index < hiddenColumns.size()));
712 if (hiddenColumn >= region[0] && hiddenColumn <= region[1])
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
721 // However, if the region begins at 0 we cannot return region[0]-1
729 return result - (hiddenColumn - region[0] + 1);
733 return result; // return the shifted position after removing hidden columns.
737 * Find the visible column which is a given visible number of columns to the
738 * left of another visible column. i.e. for a startColumn x, the column which
739 * is distance 1 away will be column x-1.
741 * @param visibleDistance
742 * the number of visible columns to offset by
744 * the column to start from
745 * @return the position of the column in the visible alignment
747 public int subtractVisibleColumns(int visibleDistance, int startColumn)
749 int distance = visibleDistance;
751 // in case startColumn is in a hidden region, move it to the left
752 int start = adjustForHiddenColumns(findColumnPosition(startColumn));
754 // get index of hidden region to left of start
755 int index = getHiddenIndexLeft(start);
758 // no hidden regions to left of startColumn
759 return start - distance;
762 // walk backwards through the alignment subtracting the counts of visible
763 // columns from distance
766 int nextstart = start;
768 while ((index > -1) && (distance - gap > 0))
770 // subtract the gap to right of region from distance
774 // calculate the next gap
775 region = hiddenColumns.get(index);
776 gap = start - region[1];
778 // set start to just to left of current region
779 nextstart = region[0] - 1;
783 if (distance - gap > 0)
785 // fell out of loop because there are no more hidden regions
787 return nextstart - distance;
789 return start - distance;
794 * Use this method to determine where the next hiddenRegion starts
796 * @param hiddenRegion
797 * index of hidden region (counts from 0)
798 * @return column number in visible view
800 public int findHiddenRegionPosition(int hiddenRegion)
803 if (hiddenColumns != null)
809 int[] region = hiddenColumns.elementAt(index);
810 if (hiddenRegion == 0)
815 gaps += region[1] + 1 - region[0];
816 result = region[1] + 1;
818 } while (index <= hiddenRegion);
827 * THis method returns the rightmost limit of a region of an alignment with
828 * hidden columns. In otherwords, the next hidden column.
833 public int getHiddenBoundaryRight(int alPos)
835 if (hiddenColumns != null)
840 int[] region = hiddenColumns.elementAt(index);
841 if (alPos < region[0])
847 } while (index < hiddenColumns.size());
855 * This method returns the leftmost limit of a region of an alignment with
856 * hidden columns. In otherwords, the previous hidden column.
861 public int getHiddenBoundaryLeft(int alPos)
863 if (hiddenColumns != null)
865 int index = hiddenColumns.size() - 1;
868 int[] region = hiddenColumns.elementAt(index);
869 if (alPos > region[1])
875 } while (index > -1);
883 * This method returns the index of the hidden region to the left of a column
884 * position. If the column is in a hidden region it returns the index of the
885 * region to the left. If there is no hidden region to the left it returns -1.
890 private int getHiddenIndexLeft(int pos)
892 if (hiddenColumns != null)
894 int index = hiddenColumns.size() - 1;
897 int[] region = hiddenColumns.elementAt(index);
904 } while (index > -1);
911 public void hideSelectedColumns()
913 synchronized (selection)
915 for (int[] selregions : selection.getRanges())
917 hideColumns(selregions[0], selregions[1]);
925 * Adds the specified column range to the hidden columns
930 public void hideColumns(int start, int end)
932 if (hiddenColumns == null)
934 hiddenColumns = new Vector<int[]>();
938 * traverse existing hidden ranges and insert / amend / append as
941 for (int i = 0; i < hiddenColumns.size(); i++)
943 int[] region = hiddenColumns.elementAt(i);
945 if (end < region[0] - 1)
948 * insert discontiguous preceding range
950 hiddenColumns.insertElementAt(new int[] { start, end }, i);
954 if (end <= region[1])
957 * new range overlaps existing, or is contiguous preceding it - adjust
960 region[0] = Math.min(region[0], start);
964 if (start <= region[1] + 1)
967 * new range overlaps existing, or is contiguous following it - adjust
968 * start and end columns
970 region[0] = Math.min(region[0], start);
971 region[1] = Math.max(region[1], end);
974 * also update or remove any subsequent ranges
975 * that are overlapped
977 while (i < hiddenColumns.size() - 1)
979 int[] nextRegion = hiddenColumns.get(i + 1);
980 if (nextRegion[0] > end + 1)
983 * gap to next hidden range - no more to update
987 region[1] = Math.max(nextRegion[1], end);
988 hiddenColumns.remove(i + 1);
995 * remaining case is that the new range follows everything else
997 hiddenColumns.addElement(new int[] { start, end });
1001 * Hides the specified column and any adjacent selected columns
1006 public void hideColumns(int col)
1009 * deselect column (whether selected or not!)
1014 * find adjacent selected columns
1016 int min = col - 1, max = col + 1;
1017 while (contains(min))
1023 while (contains(max))
1030 * min, max are now the closest unselected columns
1039 hideColumns(min, max);
1043 * Unhides, and adds to the selection list, all hidden columns
1045 public void revealAllHiddenColumns()
1047 if (hiddenColumns != null)
1049 for (int i = 0; i < hiddenColumns.size(); i++)
1051 int[] region = hiddenColumns.elementAt(i);
1052 for (int j = region[0]; j < region[1] + 1; j++)
1059 hiddenColumns = null;
1063 * Reveals, and marks as selected, the hidden column range with the given
1068 public void revealHiddenColumns(int start)
1070 for (int i = 0; i < hiddenColumns.size(); i++)
1072 int[] region = hiddenColumns.elementAt(i);
1073 if (start == region[0])
1075 for (int j = region[0]; j < region[1] + 1; j++)
1080 hiddenColumns.removeElement(region);
1084 if (hiddenColumns.size() == 0)
1086 hiddenColumns = null;
1090 public boolean isVisible(int column)
1092 if (hiddenColumns != null)
1094 for (int[] region : hiddenColumns)
1096 if (column >= region[0] && column <= region[1])
1111 public ColumnSelection(ColumnSelection copy)
1115 selection = new IntList(copy.selection);
1116 if (copy.hiddenColumns != null)
1118 hiddenColumns = new Vector<int[]>(copy.hiddenColumns.size());
1119 for (int i = 0, j = copy.hiddenColumns.size(); i < j; i++)
1122 rh = copy.hiddenColumns.elementAt(i);
1125 cp = new int[rh.length];
1126 System.arraycopy(rh, 0, cp, 0, rh.length);
1127 hiddenColumns.addElement(cp);
1137 public ColumnSelection()
1141 public String[] getVisibleSequenceStrings(int start, int end,
1144 int i, iSize = seqs.length;
1145 String selections[] = new String[iSize];
1146 if (hiddenColumns != null && hiddenColumns.size() > 0)
1148 for (i = 0; i < iSize; i++)
1150 StringBuffer visibleSeq = new StringBuffer();
1151 List<int[]> regions = getHiddenColumns();
1153 int blockStart = start, blockEnd = end;
1155 int hideStart, hideEnd;
1157 for (int j = 0; j < regions.size(); j++)
1159 region = regions.get(j);
1160 hideStart = region[0];
1161 hideEnd = region[1];
1163 if (hideStart < start)
1168 blockStart = Math.min(blockStart, hideEnd + 1);
1169 blockEnd = Math.min(blockEnd, hideStart);
1171 if (blockStart > blockEnd)
1176 visibleSeq.append(seqs[i].getSequence(blockStart, blockEnd));
1178 blockStart = hideEnd + 1;
1182 if (end > blockStart)
1184 visibleSeq.append(seqs[i].getSequence(blockStart, end));
1187 selections[i] = visibleSeq.toString();
1192 for (i = 0; i < iSize; i++)
1194 selections[i] = seqs[i].getSequenceAsString(start, end);
1202 * return all visible segments between the given start and end boundaries
1205 * (first column inclusive from 0)
1207 * (last column - not inclusive)
1208 * @return int[] {i_start, i_end, ..} where intervals lie in
1209 * start<=i_start<=i_end<end
1211 public int[] getVisibleContigs(int start, int end)
1213 if (hiddenColumns != null && hiddenColumns.size() > 0)
1215 List<int[]> visiblecontigs = new ArrayList<int[]>();
1216 List<int[]> regions = getHiddenColumns();
1220 int hideStart, hideEnd;
1222 for (int j = 0; vstart < end && j < regions.size(); j++)
1224 region = regions.get(j);
1225 hideStart = region[0];
1226 hideEnd = region[1];
1228 if (hideEnd < vstart)
1232 if (hideStart > vstart)
1234 visiblecontigs.add(new int[] { vstart, hideStart - 1 });
1236 vstart = hideEnd + 1;
1241 visiblecontigs.add(new int[] { vstart, end - 1 });
1243 int[] vcontigs = new int[visiblecontigs.size() * 2];
1244 for (int i = 0, j = visiblecontigs.size(); i < j; i++)
1246 int[] vc = visiblecontigs.get(i);
1247 visiblecontigs.set(i, null);
1248 vcontigs[i * 2] = vc[0];
1249 vcontigs[i * 2 + 1] = vc[1];
1251 visiblecontigs.clear();
1256 return new int[] { start, end - 1 };
1261 * Locate the first and last position visible for this sequence. if seq isn't
1262 * visible then return the position of the left and right of the hidden
1263 * boundary region, and the corresponding alignment column indices for the
1264 * extent of the sequence
1267 * @return int[] { visible start, visible end, first seqpos, last seqpos,
1268 * alignment index for seq start, alignment index for seq end }
1270 public int[] locateVisibleBoundsOfSequence(SequenceI seq)
1272 int fpos = seq.getStart(), lpos = seq.getEnd();
1275 if (hiddenColumns == null || hiddenColumns.size() == 0)
1277 int ifpos = seq.findIndex(fpos) - 1, ilpos = seq.findIndex(lpos) - 1;
1278 return new int[] { ifpos, ilpos, fpos, lpos, ifpos, ilpos };
1281 // Simply walk along the sequence whilst watching for hidden column
1283 List<int[]> regions = getHiddenColumns();
1284 int spos = fpos, lastvispos = -1, rcount = 0, hideStart = seq
1285 .getLength(), hideEnd = -1;
1286 int visPrev = 0, visNext = 0, firstP = -1, lastP = -1;
1287 boolean foundStart = false;
1288 for (int p = 0, pLen = seq.getLength(); spos <= seq.getEnd()
1291 if (!Comparison.isGap(seq.getCharAt(p)))
1293 // keep track of first/last column
1294 // containing sequence data regardless of visibility
1300 // update hidden region start/end
1301 while (hideEnd < p && rcount < regions.size())
1303 int[] region = regions.get(rcount++);
1305 visNext += region[0] - visPrev;
1306 hideStart = region[0];
1307 hideEnd = region[1];
1311 hideStart = seq.getLength();
1313 // update visible boundary for sequence
1325 // look for next sequence position
1331 return new int[] { findColumnPosition(start),
1332 findColumnPosition(lastvispos), fpos, lpos, firstP, lastP };
1334 // otherwise, sequence was completely hidden
1335 return new int[] { visPrev, visNext, 0, 0, firstP, lastP };
1339 * delete any columns in alignmentAnnotation that are hidden (including
1340 * sequence associated annotation).
1342 * @param alignmentAnnotation
1344 public void makeVisibleAnnotation(AlignmentAnnotation alignmentAnnotation)
1346 makeVisibleAnnotation(-1, -1, alignmentAnnotation);
1350 * delete any columns in alignmentAnnotation that are hidden (including
1351 * sequence associated annotation).
1354 * remove any annotation to the right of this column
1356 * remove any annotation to the left of this column
1357 * @param alignmentAnnotation
1358 * the annotation to operate on
1360 public void makeVisibleAnnotation(int start, int end,
1361 AlignmentAnnotation alignmentAnnotation)
1363 if (alignmentAnnotation.annotations == null)
1367 if (start == end && end == -1)
1370 end = alignmentAnnotation.annotations.length;
1372 if (hiddenColumns != null && hiddenColumns.size() > 0)
1374 // then mangle the alignmentAnnotation annotation array
1375 Vector<Annotation[]> annels = new Vector<Annotation[]>();
1376 Annotation[] els = null;
1377 List<int[]> regions = getHiddenColumns();
1378 int blockStart = start, blockEnd = end;
1380 int hideStart, hideEnd, w = 0;
1382 for (int j = 0; j < regions.size(); j++)
1384 region = regions.get(j);
1385 hideStart = region[0];
1386 hideEnd = region[1];
1388 if (hideStart < start)
1393 blockStart = Math.min(blockStart, hideEnd + 1);
1394 blockEnd = Math.min(blockEnd, hideStart);
1396 if (blockStart > blockEnd)
1401 annels.addElement(els = new Annotation[blockEnd - blockStart]);
1402 System.arraycopy(alignmentAnnotation.annotations, blockStart, els,
1405 blockStart = hideEnd + 1;
1409 if (end > blockStart)
1411 annels.addElement(els = new Annotation[end - blockStart + 1]);
1412 if ((els.length + blockStart) <= alignmentAnnotation.annotations.length)
1414 // copy just the visible segment of the annotation row
1415 System.arraycopy(alignmentAnnotation.annotations, blockStart,
1416 els, 0, els.length);
1420 // copy to the end of the annotation row
1421 System.arraycopy(alignmentAnnotation.annotations, blockStart,
1423 (alignmentAnnotation.annotations.length - blockStart));
1432 alignmentAnnotation.annotations = new Annotation[w];
1435 for (Annotation[] chnk : annels)
1437 System.arraycopy(chnk, 0, alignmentAnnotation.annotations, w,
1444 alignmentAnnotation.restrict(start, end);
1449 * Invert the column selection from first to end-1. leaves hiddenColumns
1450 * untouched (and unselected)
1455 public void invertColumnSelection(int first, int width)
1457 boolean hasHidden = hiddenColumns != null && hiddenColumns.size() > 0;
1458 for (int i = first; i < width; i++)
1466 if (!hasHidden || isVisible(i))
1475 * add in any unselected columns from the given column selection, excluding
1476 * any that are hidden.
1480 public void addElementsFrom(ColumnSelection colsel)
1482 if (colsel != null && !colsel.isEmpty())
1484 for (Integer col : colsel.getSelected())
1486 if (hiddenColumns != null && isVisible(col.intValue()))
1495 * set the selected columns the given column selection, excluding any columns
1500 public void setElementsFrom(ColumnSelection colsel)
1502 selection = new IntList();
1503 if (colsel.selection != null && colsel.selection.size() > 0)
1505 if (hiddenColumns != null && hiddenColumns.size() > 0)
1507 // only select visible columns in this columns selection
1508 addElementsFrom(colsel);
1512 // add everything regardless
1513 for (Integer col : colsel.getSelected())
1522 * Add gaps into the sequences aligned to profileseq under the given
1527 * - alignment to have gaps inserted into it
1529 * - alignment view where sequence corresponding to profileseq is
1531 * @return new Column selection for new alignment view, with insertions into
1532 * profileseq marked as hidden.
1534 public static ColumnSelection propagateInsertions(SequenceI profileseq,
1535 AlignmentI al, AlignmentView input)
1539 // return propagateInsertions(profileseq, al, )
1540 char gc = al.getGapCharacter();
1541 Object[] alandcolsel = input.getAlignmentAndColumnSelection(gc);
1542 ColumnSelection nview = (ColumnSelection) alandcolsel[1];
1543 SequenceI origseq = ((SequenceI[]) alandcolsel[0])[profsqpos];
1544 nview.propagateInsertions(profileseq, al, origseq);
1551 * - sequence in al which corresponds to origseq
1553 * - alignment which is to have gaps inserted into it
1555 * - sequence corresponding to profileseq which defines gap map for
1558 public void propagateInsertions(SequenceI profileseq, AlignmentI al,
1561 char gc = al.getGapCharacter();
1562 // recover mapping between sequence's non-gap positions and positions
1564 pruneDeletions(ShiftList.parseMap(origseq.gapMap()));
1565 int[] viscontigs = getVisibleContigs(0, profileseq.getLength());
1568 // input.pruneDeletions(ShiftList.parseMap(((SequenceI[])
1569 // alandcolsel[0])[0].gapMap()))
1570 // add profile to visible contigs
1571 for (int v = 0; v < viscontigs.length; v += 2)
1573 if (viscontigs[v] > spos)
1575 StringBuffer sb = new StringBuffer();
1576 for (int s = 0, ns = viscontigs[v] - spos; s < ns; s++)
1580 for (int s = 0, ns = al.getHeight(); s < ns; s++)
1582 SequenceI sqobj = al.getSequenceAt(s);
1583 if (sqobj != profileseq)
1585 String sq = al.getSequenceAt(s).getSequenceAsString();
1586 if (sq.length() <= spos + offset)
1589 int diff = spos + offset - sq.length() - 1;
1594 while ((diff = spos + offset - sq.length() - 1) > 0)
1597 // + ((diff >= sb.length()) ? sb.toString() : sb
1598 // .substring(0, diff));
1599 if (diff >= sb.length())
1601 sq += sb.toString();
1605 char[] buf = new char[diff];
1606 sb.getChars(0, diff, buf, 0);
1607 sq += buf.toString();
1611 sq += sb.toString();
1615 al.getSequenceAt(s).setSequence(
1616 sq.substring(0, spos + offset) + sb.toString()
1617 + sq.substring(spos + offset));
1621 // offset+=sb.length();
1623 spos = viscontigs[v + 1] + 1;
1625 if ((offset + spos) < profileseq.getLength())
1627 // pad the final region with gaps.
1628 StringBuffer sb = new StringBuffer();
1629 for (int s = 0, ns = profileseq.getLength() - spos - offset; s < ns; s++)
1633 for (int s = 0, ns = al.getHeight(); s < ns; s++)
1635 SequenceI sqobj = al.getSequenceAt(s);
1636 if (sqobj == profileseq)
1640 String sq = sqobj.getSequenceAsString();
1642 int diff = origseq.getLength() - sq.length();
1646 // + ((diff >= sb.length()) ? sb.toString() : sb
1647 // .substring(0, diff));
1648 if (diff >= sb.length())
1650 sq += sb.toString();
1654 char[] buf = new char[diff];
1655 sb.getChars(0, diff, buf, 0);
1656 sq += buf.toString();
1658 diff = origseq.getLength() - sq.length();
1666 * @return true if there are columns marked
1668 public boolean hasSelectedColumns()
1670 return (selection != null && selection.size() > 0);
1675 * @return true if there are columns hidden
1677 public boolean hasHiddenColumns()
1679 return hiddenColumns != null && hiddenColumns.size() > 0;
1684 * @return true if there are more than one set of columns hidden
1686 public boolean hasManyHiddenColumns()
1688 return hiddenColumns != null && hiddenColumns.size() > 1;
1692 * mark the columns corresponding to gap characters as hidden in the column
1697 public void hideInsertionsFor(SequenceI sr)
1699 List<int[]> inserts = sr.getInsertions();
1700 for (int[] r : inserts)
1702 hideColumns(r[0], r[1]);
1706 public boolean filterAnnotations(Annotation[] annotations,
1707 AnnotationFilterParameter filterParams)
1709 // JBPNote - this method needs to be refactored to become independent of
1710 // viewmodel package
1711 this.revealAllHiddenColumns();
1716 if (annotations[count] != null)
1719 boolean itemMatched = false;
1721 if (filterParams.getThresholdType() == AnnotationFilterParameter.ThresholdType.ABOVE_THRESHOLD
1722 && annotations[count].value >= filterParams
1723 .getThresholdValue())
1727 if (filterParams.getThresholdType() == AnnotationFilterParameter.ThresholdType.BELOW_THRESHOLD
1728 && annotations[count].value <= filterParams
1729 .getThresholdValue())
1734 if (filterParams.isFilterAlphaHelix()
1735 && annotations[count].secondaryStructure == 'H')
1740 if (filterParams.isFilterBetaSheet()
1741 && annotations[count].secondaryStructure == 'E')
1746 if (filterParams.isFilterTurn()
1747 && annotations[count].secondaryStructure == 'S')
1752 String regexSearchString = filterParams.getRegexString();
1753 if (regexSearchString != null
1754 && !filterParams.getRegexSearchFields().isEmpty())
1756 List<SearchableAnnotationField> fields = filterParams
1757 .getRegexSearchFields();
1760 if (fields.contains(SearchableAnnotationField.DISPLAY_STRING)
1761 && annotations[count].displayCharacter
1762 .matches(regexSearchString))
1766 } catch (java.util.regex.PatternSyntaxException pse)
1768 if (annotations[count].displayCharacter
1769 .equals(regexSearchString))
1774 if (fields.contains(SearchableAnnotationField.DESCRIPTION)
1775 && annotations[count].description != null
1776 && annotations[count].description
1777 .matches(regexSearchString))
1785 this.addElement(count);
1789 } while (count < annotations.length);
1794 * Returns a hashCode built from selected columns and hidden column ranges
1797 public int hashCode()
1799 int hashCode = selection.hashCode();
1800 if (hiddenColumns != null)
1802 for (int[] hidden : hiddenColumns)
1804 hashCode = 31 * hashCode + hidden[0];
1805 hashCode = 31 * hashCode + hidden[1];
1812 * Answers true if comparing to a ColumnSelection with the same selected
1813 * columns and hidden columns, else false
1816 public boolean equals(Object obj)
1818 if (!(obj instanceof ColumnSelection))
1822 ColumnSelection that = (ColumnSelection) obj;
1825 * check columns selected are either both null, or match
1827 if (this.selection == null)
1829 if (that.selection != null)
1834 if (!this.selection.equals(that.selection))
1840 * check hidden columns are either both null, or match
1842 if (this.hiddenColumns == null)
1844 return (that.hiddenColumns == null);
1846 if (that.hiddenColumns == null
1847 || that.hiddenColumns.size() != this.hiddenColumns.size())
1852 for (int[] thisRange : hiddenColumns)
1854 int[] thatRange = that.hiddenColumns.get(i++);
1855 if (thisRange[0] != thatRange[0] || thisRange[1] != thatRange[1])
1864 * Updates the column selection depending on the parameters, and returns true
1865 * if any change was made to the selection
1867 * @param markedColumns
1868 * a set identifying marked columns (base 0)
1870 * the first column of the range to operate over (base 0)
1872 * the last column of the range to operate over (base 0)
1874 * if true, deselect marked columns and select unmarked
1875 * @param extendCurrent
1876 * if true, extend rather than replacing the current column selection
1878 * if true, toggle the selection state of marked columns
1882 public boolean markColumns(BitSet markedColumns, int startCol,
1883 int endCol, boolean invert, boolean extendCurrent, boolean toggle)
1885 boolean changed = false;
1886 if (!extendCurrent && !toggle)
1888 changed = !this.isEmpty();
1893 // invert only in the currently selected sequence region
1894 int i = markedColumns.nextClearBit(startCol);
1895 int ibs = markedColumns.nextSetBit(startCol);
1896 while (i >= startCol && i <= endCol)
1898 if (ibs < 0 || i < ibs)
1901 if (toggle && contains(i))
1912 i = markedColumns.nextClearBit(ibs);
1913 ibs = markedColumns.nextSetBit(i);
1919 int i = markedColumns.nextSetBit(startCol);
1920 while (i >= startCol && i <= endCol)
1923 if (toggle && contains(i))
1931 i = markedColumns.nextSetBit(i + 1);
1938 * Adjusts column selections, and the given selection group, to match the
1939 * range of a stretch (e.g. mouse drag) operation
1941 * Method refactored from ScalePanel.mouseDragged
1944 * current column position, adjusted for hidden columns
1946 * current selection group
1948 * start position of the stretch group
1950 * end position of the stretch group
1952 public void stretchGroup(int res, SequenceGroup sg, int min, int max)
1959 if (res > sg.getStartRes())
1961 // expand selection group to the right
1964 if (res < sg.getStartRes())
1966 // expand selection group to the left
1967 sg.setStartRes(res);
1971 * expand or shrink column selection to match the
1972 * range of the drag operation
1974 for (int col = min; col <= max; col++)
1976 if (col < sg.getStartRes() || col > sg.getEndRes())
1978 // shrinking drag - remove from selection
1983 // expanding drag - add to selection