X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FColumnSelection.java;h=3ccaab869730a770f4463eee8cb7242f136b43c1;hb=a83adb45bdf9554e270921b4baad94defd314b36;hp=6b9f28d6fb114914e18144ada3f1a0e98e8b2b79;hpb=608832fec5a504b4c56e5837b2b3dfc1993fe734;p=jalview.git diff --git a/src/jalview/datamodel/ColumnSelection.java b/src/jalview/datamodel/ColumnSelection.java index 6b9f28d..3ccaab8 100644 --- a/src/jalview/datamodel/ColumnSelection.java +++ b/src/jalview/datamodel/ColumnSelection.java @@ -1,510 +1,807 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer - * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, either version 3 * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * + * + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * PURPOSE. See the GNU General Public License for more details. + * * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.datamodel; -import jalview.util.ShiftList; +import jalview.viewmodel.annotationfilter.AnnotationFilterParameter; +import jalview.viewmodel.annotationfilter.AnnotationFilterParameter.SearchableAnnotationField; -import java.util.*; +import java.util.ArrayList; +import java.util.BitSet; +import java.util.Collections; +import java.util.List; +import java.util.regex.PatternSyntaxException; /** - * NOTE: Columns are zero based. + * Data class holding the selected columns and hidden column ranges for a view. + * Ranges are base 1. */ public class ColumnSelection { - Vector selected = new Vector(); + /** + * A class to hold an efficient representation of selected columns + */ + private class IntList + { + /* + * list of selected columns (ordered by selection order, not column order) + */ + private List order; - //Vector of int [] {startCol, endCol} - Vector hiddenColumns; + /* + * an unmodifiable view of the selected columns list + */ + private List _uorder; /** - * Add a column to the selection - * - * @param col index of column + * bitfield for column selection - allows quick lookup */ - public void addElement(int col) - { - Integer column = new Integer(col); - if (!selected.contains(column)) - { - selected.addElement(column); - } - } + private BitSet selected; /** - * clears column selection + * Constructor */ - public void clear() + IntList() { - selected.removeAllElements(); + order = new ArrayList<>(); + _uorder = Collections.unmodifiableList(order); + selected = new BitSet(); } /** - * removes col from selection - * - * @param col index of column to be removed + * Copy constructor + * + * @param other */ - public void removeElement(int col) + IntList(IntList other) { - Integer colInt = new Integer(col); - - if (selected.contains(colInt)) + this(); + if (other != null) + { + int j = other.size(); + for (int i = 0; i < j; i++) { - selected.removeElement(colInt); + add(other.elementAt(i)); } + } } /** - * removes a range of columns from the selection - * @param start int - first column in range to be removed - * @param end int - last col + * adds a new column i to the selection - only if i is not already selected + * + * @param i */ - public void removeElements(int start, int end) + void add(int i) { - Integer colInt; - for(int i=start; i getList() { - int max = -1; - - for (int i = 0; i < selected.size(); i++) - { - if (columnAt(i) > max) - { - max = columnAt(i); - } - } - - return max; + return _uorder; } - /** - * DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public int getMin() + int size() { - int min = 1000000000; - - for (int i = 0; i < selected.size(); i++) - { - if (columnAt(i) < min) - { - min = columnAt(i); - } - } - - return min; + return order.size(); } - /** - * propagate shift in alignment columns to column selection - * - * @param start beginning of edit - * @param change shift in edit (-ve or +ve number of columns) + * gets the column that was selected first, second or i'th + * + * @param i + * @return */ - public void compensateForEdit(int start, int change) + int elementAt(int i) { - for (int i = 0; i < size(); i++) - { - int temp = columnAt(i); - - if (temp >= start) - { - selected.setElementAt(new Integer(temp - change), i); - } - } + return order.get(i); + } - if(hiddenColumns!=null) + protected boolean pruneColumnList(final List shifts) + { + int s = 0, t = shifts.size(); + int[] sr = shifts.get(s++); + boolean pruned = false; + int i = 0, j = order.size(); + while (i < j && s <= t) + { + int c = order.get(i++).intValue(); + if (sr[0] <= c) { - for(int i=0; i= c) + { // sr[1] -ve means inseriton. + order.remove(--i); + selected.clear(c); + j--; + } + else { - int[] region = (int[]) hiddenColumns.elementAt(i); - if(region[0] > start) + if (s < t) { - region[0] -= change; - region[1] -= change; + sr = shifts.get(s); } - if(region[0]<0) - region[0] = 0; - if(region[1] <0) - region[1] = 0; - } - } - } - public ShiftList compensateForEdits(ShiftList shiftrecord) { - if (shiftrecord!=null) { - Vector shifts = shiftrecord.shifts; - if (shifts!=null && shifts.size()>0) { - for (int i=0,j=shifts.size(); i= start) { - int[] region = (int[]) hiddenColumns.elementAt(i); - if (result >= region[0]) - { - result += region[1] - region[0] + 1; - } + // clear shifted bits and update List of selected columns + selected.clear(temp); + mask.set(temp - change); + order.set(i, new Integer(temp - change)); } } - return result; + // lastly update the bitfield all at once + selected.or(mask); + } + + boolean isSelected(int column) + { + return selected.get(column); + } + + int getMaxColumn() + { + return selected.length() - 1; + } + + int getMinColumn() + { + return selected.get(0) ? 0 : selected.nextSetBit(0); } /** - * Use this method to find out where a visible column is in the alignment - * when hidden columns exist - * @param hiddenColumn int - * @return int + * @return a series of selection intervals along the range */ - public int findColumnPosition(int hiddenColumn) + List getRanges() { - int result = hiddenColumn; - if (hiddenColumns != null) + List rlist = new ArrayList<>(); + if (selected.isEmpty()) { - int index = 0; - int gaps = 0; - do - { - int[] region = (int[]) hiddenColumns.elementAt(index); - if (hiddenColumn > region[1]) - { - result -= region[1]+1-region[0]; - } - index++; - } - while (index < hiddenColumns.size()); - - result -= gaps; + return rlist; + } + int next = selected.nextSetBit(0), clear = -1; + while (next != -1) + { + clear = selected.nextClearBit(next); + rlist.add(new int[] { next, clear - 1 }); + next = selected.nextSetBit(clear); } + return rlist; + } - return result; + @Override + public int hashCode() + { + // TODO Auto-generated method stub + return selected.hashCode(); } - /** - * Use this method to determine where the next hiddenRegion starts - */ - public int findHiddenRegionPosition(int hiddenRegion) + @Override + public boolean equals(Object obj) { - int result = 0; - if (hiddenColumns != null) + if (obj instanceof IntList) { - int index = 0; - int gaps = 0; - do - { - int[] region = (int[]) hiddenColumns.elementAt(index); - if(hiddenRegion==0) - { - return region[0]; - } + return ((IntList) obj).selected.equals(selected); + } + return false; + } + } - gaps += region[1] +1 - region[0]; - result = region[1] +1; - index++; - } - while(index < hiddenRegion+1); + private IntList selection = new IntList(); - result -= gaps; - } + /** + * Add a column to the selection + * + * @param col + * index of column + */ + public void addElement(int col) + { + selection.add(col); + } - return result; - } + /** + * clears column selection + */ + public void clear() + { + selection.clear(); + } - /** - * THis method returns the rightmost limit of a - * region of an alignment with hidden columns. - * In otherwords, the next hidden column. - * @param index int - */ - public int getHiddenBoundaryRight(int alPos) + /** + * Removes value 'col' from the selection (not the col'th item) + * + * @param col + * index of column to be removed + */ + public void removeElement(int col) + { + selection.remove(col); + } + + /** + * removes a range of columns from the selection + * + * @param start + * int - first column in range to be removed + * @param end + * int - last col + */ + public void removeElements(int start, int end) + { + Integer colInt; + for (int i = start; i < end; i++) { - if (hiddenColumns != null) + colInt = new Integer(i); + if (selection.contains(colInt)) { - int index = 0; - do - { - int[] region = (int[]) hiddenColumns.elementAt(index); - if(alPos < region[0]) - return region[0]; - - index++; - } - while(index < hiddenColumns.size()); + selection.remove(colInt); } + } + } + + /** + * Returns a read-only view of the (possibly empty) list of selected columns + *

+ * The list contains no duplicates but is not necessarily ordered. It also may + * include columns hidden from the current view. To modify (for example sort) + * the list, you should first make a copy. + *

+ * The list is not thread-safe: iterating over it could result in + * ConcurrentModificationException if it is modified by another thread. + */ + public List getSelected() + { + return selection.getList(); + } + + /** + * @return list of int arrays containing start and end column position for + * runs of selected columns ordered from right to left. + */ + public List getSelectedRanges() + { + return selection.getRanges(); + } + + /** + * + * @param col + * index to search for in column selection + * + * @return true if col is selected + */ + public boolean contains(int col) + { + return (col > -1) ? selection.isSelected(col) : false; + } - return alPos; + /** + * Answers true if no columns are selected, else false + */ + public boolean isEmpty() + { + return selection == null || selection.isEmpty(); + } + /** + * rightmost selected column + * + * @return rightmost column in alignment that is selected + */ + public int getMax() + { + if (selection.isEmpty()) + { + return -1; } - /** - * THis method returns the rightmost limit of a - * region of an alignment with hidden columns. - * In otherwords, the next hidden column. - * @param index int - */ - public int getHiddenBoundaryLeft(int alPos) + return selection.getMaxColumn(); + } + + /** + * Leftmost column in selection + * + * @return column index of leftmost column in selection + */ + public int getMin() + { + if (selection.isEmpty()) { - if (hiddenColumns != null) - { - int index = hiddenColumns.size()-1; - do - { - int[] region = (int[]) hiddenColumns.elementAt(index); - if(alPos > region[1]) - return region[1]; + return 1000000000; + } + return selection.getMinColumn(); + } - index--; - } - while(index >-1); + public void hideSelectedColumns(AlignmentI al) + { + synchronized (selection) + { + for (int[] selregions : selection.getRanges()) + { + al.getHiddenColumns().hideColumns(selregions[0], selregions[1]); } + selection.clear(); + } - return alPos; + } + /** + * Hides the specified column and any adjacent selected columns + * + * @param res + * int + */ + public void hideSelectedColumns(int col, HiddenColumns hidden) + { + /* + * deselect column (whether selected or not!) + */ + removeElement(col); + + /* + * find adjacent selected columns + */ + int min = col - 1, max = col + 1; + while (contains(min)) + { + removeElement(min); + min--; } - public void hideSelectedColumns() + while (contains(max)) { - while (size() > 0) - { - int column = ( (Integer) getSelected().firstElement()).intValue(); - hideColumns(column); - } + removeElement(max); + max++; + } + /* + * min, max are now the closest unselected columns + */ + min++; + max--; + if (min > max) + { + min = max; } - public void hideColumns(int start, int end) + hidden.hideColumns(min, max); + } + + /** + * Copy constructor + * + * @param copy + */ + public ColumnSelection(ColumnSelection copy) + { + if (copy != null) { - if(hiddenColumns==null) - hiddenColumns = new Vector(); + selection = new IntList(copy.selection); + } + } - boolean added = false; - boolean overlap = false; + /** + * ColumnSelection + */ + public ColumnSelection() + { + } - for (int i = 0; i < hiddenColumns.size(); i++) + /** + * Invert the column selection from first to end-1. leaves hiddenColumns + * untouched (and unselected) + * + * @param first + * @param end + */ + public void invertColumnSelection(int first, int width, AlignmentI al) + { + boolean hasHidden = al.getHiddenColumns().hasHiddenColumns(); + for (int i = first; i < width; i++) + { + if (contains(i)) { - int[] region = (int[]) hiddenColumns.elementAt(i); - if ( start<=region[1] && end>=region[0]) + removeElement(i); + } + else + { + if (!hasHidden || al.getHiddenColumns().isVisible(i)) { - hiddenColumns.removeElementAt(i); - overlap = true; - break; + addElement(i); } - else if (end < region[0] && start < region[0]) + } + } + } + + /** + * set the selected columns to the given column selection, excluding any + * columns that are hidden. + * + * @param colsel + */ + public void setElementsFrom(ColumnSelection colsel, + HiddenColumns hiddenColumns) + { + selection = new IntList(); + if (colsel.selection != null && colsel.selection.size() > 0) + { + if (hiddenColumns.hasHiddenColumns()) + { + // only select visible columns in this columns selection + for (Integer col : colsel.getSelected()) { - hiddenColumns.insertElementAt(new int[] - {start, end}, i); - added = true; - break; + if (hiddenColumns != null + && hiddenColumns.isVisible(col.intValue())) + { + selection.add(col); + } } } - - if(overlap) + else { - hideColumns(start, end); + // add everything regardless + for (Integer col : colsel.getSelected()) + { + addElement(col); + } } - else if (!added) - hiddenColumns.addElement(new int[] {start, end}); - } + } - /** - * This method will find a range of selected columns - * around the column specified - * @param res int - */ - public void hideColumns(int col) + /** + * + * @return true if there are columns marked + */ + public boolean hasSelectedColumns() + { + return (selection != null && selection.size() > 0); + } + + /** + * Selects columns where the given annotation matches the provided filter + * condition(s). Any existing column selections are first cleared. Answers the + * number of columns added. + * + * @param annotations + * @param filterParams + * @return + */ + public int filterAnnotations(Annotation[] annotations, + AnnotationFilterParameter filterParams) + { + // JBPNote - this method needs to be refactored to become independent of + // viewmodel package + this.clear(); + int addedCount = 0; + int column = 0; + do { - // First find out range of columns to hide - int min = col, max = col+1; - while( contains(min) ) - { removeElement(min); min --; } + Annotation ann = annotations[column]; + if (ann != null) + { + boolean matched = false; + + /* + * filter may have multiple conditions - + * these are or'd until a match is found + */ + if (filterParams + .getThresholdType() == AnnotationFilterParameter.ThresholdType.ABOVE_THRESHOLD + && ann.value > filterParams.getThresholdValue()) + { + matched = true; + } - while( contains(max) ) - { removeElement(max); max ++; } + if (!matched && filterParams + .getThresholdType() == AnnotationFilterParameter.ThresholdType.BELOW_THRESHOLD + && ann.value < filterParams.getThresholdValue()) + { + matched = true; + } - min++; max--; + if (!matched && filterParams.isFilterAlphaHelix() + && ann.secondaryStructure == 'H') + { + matched = true; + } - hideColumns(min, max); - } + if (!matched && filterParams.isFilterBetaSheet() + && ann.secondaryStructure == 'E') + { + matched = true; + } - public void revealAllHiddenColumns() - { - if(hiddenColumns!=null) - { - for (int i = 0; i < hiddenColumns.size(); i++) + if (!matched && filterParams.isFilterTurn() + && ann.secondaryStructure == 'S') { - int[] region = (int[]) hiddenColumns.elementAt(i); - for (int j = region[0]; j < region[1]+1; j++) + matched = true; + } + + String regexSearchString = filterParams.getRegexString(); + if (!matched && regexSearchString != null) + { + List fields = filterParams + .getRegexSearchFields(); + for (SearchableAnnotationField field : fields) { - addElement(j); + String compareTo = field == SearchableAnnotationField.DISPLAY_STRING + ? ann.displayCharacter // match 'Label' + : ann.description; // and/or 'Description' + if (compareTo != null) + { + try + { + if (compareTo.matches(regexSearchString)) + { + matched = true; + } + } catch (PatternSyntaxException pse) + { + if (compareTo.equals(regexSearchString)) + { + matched = true; + } + } + if (matched) + { + break; + } + } } } + + if (matched) + { + this.addElement(column); + addedCount++; + } } + column++; + } while (column < annotations.length); + + return addedCount; + } + + /** + * Returns a hashCode built from selected columns ranges + */ + @Override + public int hashCode() + { + return selection.hashCode(); + } - hiddenColumns = null; + /** + * Answers true if comparing to a ColumnSelection with the same selected + * columns and hidden columns, else false + */ + @Override + public boolean equals(Object obj) + { + if (!(obj instanceof ColumnSelection)) + { + return false; } + ColumnSelection that = (ColumnSelection) obj; - public void revealHiddenColumns(int res) + /* + * check columns selected are either both null, or match + */ + if (this.selection == null) { - for(int i=0; i= startCol && i <= endCol) { - int [] region = (int[])hiddenColumns.elementAt(i); - if( column >= region[0] && column <= region[1]) + if (ibs < 0 || i < ibs) { - return false; + changed = true; + if (toggle && contains(i)) + { + removeElement(i++); + } + else + { + addElement(i++); + } + } + else + { + i = markedColumns.nextClearBit(ibs); + ibs = markedColumns.nextSetBit(i); } } - return true; } - /** - * Copy constructor - * @param copy - */ - public ColumnSelection(ColumnSelection copy) { - if (copy!=null) { - if (copy.selected!=null) { - selected = new Vector(); - for (int i=0,j=copy.selected.size(); i= startCol && i <= endCol) + { + changed = true; + if (toggle && contains(i)) + { + removeElement(i); } - if (copy.hiddenColumns!=null) { - hiddenColumns=new Vector(); - for (int i=0,j=copy.hiddenColumns.size(); i + * Method refactored from ScalePanel.mouseDragged + * + * @param res + * current column position, adjusted for hidden columns + * @param sg + * current selection group + * @param min + * start position of the stretch group + * @param max + * end position of the stretch group */ - public ColumnSelection() + public void stretchGroup(int res, SequenceGroup sg, int min, int max) { + if (!contains(res)) + { + addElement(res); + } + + if (res > sg.getStartRes()) + { + // expand selection group to the right + sg.setEndRes(res); + } + if (res < sg.getStartRes()) + { + // expand selection group to the left + sg.setStartRes(res); + } + + /* + * expand or shrink column selection to match the + * range of the drag operation + */ + for (int col = min; col <= max; col++) + { + if (col < sg.getStartRes() || col > sg.getEndRes()) + { + // shrinking drag - remove from selection + removeElement(col); + } + else + { + // expanding drag - add to selection + addElement(col); + } + } } }