X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FHiddenColumns.java;h=2b5185fbe5ea7c4f6a2aa2c0f7531205fd68130f;hb=2a66892874abea357a5e5d9ef2f69919453c31d0;hp=be107211b95853ec93fb338956585ff94bff9fe9;hpb=ab67e99fb7336d0f4411488d9f843c720ab6b418;p=jalview.git diff --git a/src/jalview/datamodel/HiddenColumns.java b/src/jalview/datamodel/HiddenColumns.java index be10721..2b5185f 100644 --- a/src/jalview/datamodel/HiddenColumns.java +++ b/src/jalview/datamodel/HiddenColumns.java @@ -20,577 +20,620 @@ */ package jalview.datamodel; -import jalview.util.Comparison; -import jalview.util.ShiftList; - import java.util.ArrayList; import java.util.BitSet; -import java.util.Collections; +import java.util.Iterator; import java.util.List; -import java.util.Vector; import java.util.concurrent.locks.ReentrantReadWriteLock; +/** + * This class manages the collection of hidden columns associated with an + * alignment. To iterate over the collection, or over visible columns/regions, + * use an iterator obtained from one of: + * + * - getBoundedIterator: iterates over the hidden regions, within some bounds, + * returning absolute positions + * + * - getBoundedStartIterator: iterates over the start positions of hidden + * regions, within some bounds, returning visible positions + * + * - getVisContigsIterator: iterates over visible regions in a range, returning + * absolute positions + * + * - getVisibleColsIterator: iterates over the visible *columns* + * + * For performance reasons, provide bounds where possible. Note that column + * numbering begins at 0 throughout this class. + * + * @author kmourao + * + */ public class HiddenColumns { + private static final int HASH_MULTIPLIER = 31; + private static final ReentrantReadWriteLock LOCK = new ReentrantReadWriteLock(); - + + /* + * Cursor which tracks the last used hidden columns region, and the number + * of hidden columns up to (but not including) that region. + */ + private HiddenColumnsCursor cursor = new HiddenColumnsCursor(); + + /* + * cache of the number of hidden columns + */ + private int numColumns = 0; + /* * list of hidden column [start, end] ranges; the list is maintained in * ascending start column order */ - private Vector hiddenColumns; + private List hiddenColumns; /** - * This Method is used to return all the HiddenColumn regions - * - * @return empty list or List of hidden column intervals + * Constructor */ - public List getHiddenRegions() + public HiddenColumns() { - return hiddenColumns == null ? Collections. emptyList() - : hiddenColumns; } + /* + * Methods which change the hiddenColumns collection. These methods should + * use a writeLock to prevent other threads accessing the hiddenColumns + * collection while changes are being made. They should also reset the hidden + * columns cursor, and either update the hidden columns count, or set it to 0 + * (so that it will later be updated when needed). + */ + /** - * Output regions data as a string. String is in the format: - * reg0[0]reg0[1]reg1[0]reg1[1] ... regn[1] + * Copy constructor * - * @param delimiter - * string to delimit regions - * @param betweenstring - * to put between start and end region values - * @return regions formatted according to delimiter and between strings + * @param copy + * the HiddenColumns object to copy from */ - public String regionsToString(String delimiter, String between) + public HiddenColumns(HiddenColumns copy) { - try - { - LOCK.readLock().lock(); - StringBuilder regionBuilder = new StringBuilder(); - for (int[] range : hiddenColumns) - { - regionBuilder.append(delimiter).append(range[0]).append(between) - .append(range[1]); - } - - regionBuilder.deleteCharAt(0); - return regionBuilder.toString(); - } finally - { - LOCK.readLock().unlock(); - } + this(copy, Integer.MIN_VALUE, Integer.MAX_VALUE, 0); } /** - * Find the number of hidden columns + * Copy constructor within bounds and with offset. Copies hidden column + * regions fully contained between start and end, and offsets positions by + * subtracting offset. + * + * @param copy + * HiddenColumns instance to copy from + * @param start + * lower bound to copy from + * @param end + * upper bound to copy to + * @param offset + * offset to subtract from each region boundary position * - * @return number of hidden columns */ - public int getSize() + public HiddenColumns(HiddenColumns copy, int start, int end, int offset) { try { - LOCK.readLock().lock(); - int size = 0; - if (hasHidden()) + LOCK.writeLock().lock(); + if (copy != null) { - for (int[] range : hiddenColumns) + hiddenColumns = new ArrayList<>(); + numColumns = 0; + Iterator it = copy.getBoundedIterator(start, end); + while (it.hasNext()) { - size += range[1] - range[0] + 1; + int[] region = it.next(); + // still need to check boundaries because iterator returns + // all overlapping regions and we need contained regions + if (region[0] >= start && region[1] <= end) + { + hiddenColumns.add( + new int[] + { region[0] - offset, region[1] - offset }); + numColumns += region[1] - region[0] + 1; + } } + cursor.resetCursor(hiddenColumns); } - return size; - } - finally + } finally { - LOCK.readLock().unlock(); + LOCK.writeLock().unlock(); } } /** - * Answers if there are any hidden columns + * Adds the specified column range to the hidden columns collection * - * @return true if there are hidden columns + * @param start + * start of range to add (absolute position in alignment) + * @param end + * end of range to add (absolute position in alignment) */ - public boolean hasHidden() - { - try - { - LOCK.readLock().lock(); - return (hiddenColumns != null) && (!hiddenColumns.isEmpty()); - } finally - { - LOCK.readLock().unlock(); - } - - } - - @Override - public boolean equals(Object obj) + public void hideColumns(int start, int end) { + boolean wasAlreadyLocked = false; try { - LOCK.readLock().lock(); + // check if the write lock was already locked by this thread, + // as this method can be called internally in loops within HiddenColumns + if (!LOCK.isWriteLockedByCurrentThread()) + { + LOCK.writeLock().lock(); + } + else + { + wasAlreadyLocked = true; + } - if (!(obj instanceof HiddenColumns)) + int previndex = 0; + int prevHiddenCount = 0; + int regionindex = 0; + if (hiddenColumns == null) { - return false; + hiddenColumns = new ArrayList<>(); + } + else + { + // set up cursor reset values + HiddenCursorPosition cursorPos = cursor.findRegionForColumn(start); + regionindex = cursorPos.getRegionIndex(); + + if (regionindex > 0) + { + // get previous index and hidden count for updating the cursor later + previndex = regionindex - 1; + int[] prevRegion = hiddenColumns.get(previndex); + prevHiddenCount = cursorPos.getHiddenSoFar() + - (prevRegion[1] - prevRegion[0] + 1); + } } - HiddenColumns that = (HiddenColumns) obj; /* - * check hidden columns are either both null, or match + * new range follows everything else; check first to avoid looping over whole hiddenColumns collection */ - if (this.hiddenColumns == null) - { - return (that.hiddenColumns == null); - } - if (that.hiddenColumns == null - || that.hiddenColumns.size() != this.hiddenColumns.size()) + if (hiddenColumns.isEmpty() + || start > hiddenColumns.get(hiddenColumns.size() - 1)[1]) { - return false; + hiddenColumns.add(new int[] { start, end }); } - int i = 0; - for (int[] thisRange : hiddenColumns) + else { - int[] thatRange = that.hiddenColumns.get(i++); - if (thisRange[0] != thatRange[0] || thisRange[1] != thatRange[1]) + /* + * traverse existing hidden ranges and insert / amend / append as + * appropriate + */ + boolean added = false; + if (regionindex > 0) { - return false; + added = insertRangeAtRegion(regionindex - 1, start, end); + } + if (!added && regionindex < hiddenColumns.size()) + { + insertRangeAtRegion(regionindex, start, end); } } - return true; + + // reset the cursor to just before our insertion point: this saves + // a lot of reprocessing in large alignments + cursor.resetCursor(hiddenColumns, previndex, prevHiddenCount); + + // reset the number of columns so they will be recounted + numColumns = 0; + } finally { - LOCK.readLock().unlock(); + if (!wasAlreadyLocked) + { + LOCK.writeLock().unlock(); + } } } /** - * Return absolute column index for a visible column index + * Insert [start, range] at the region at index i in hiddenColumns, if + * feasible * - * @param column - * int column index in alignment view (count from zero) - * @return alignment column index for column + * @param i + * index to insert at + * @param start + * start of range to insert + * @param end + * end of range to insert + * @return true if range was successfully inserted */ - public int adjustForHiddenColumns(int column) + private boolean insertRangeAtRegion(int i, int start, int end) { - try + boolean added = false; + + int[] region = hiddenColumns.get(i); + if (end < region[0] - 1) { - LOCK.readLock().lock(); - int result = column; - if (hiddenColumns != null) + /* + * insert discontiguous preceding range + */ + hiddenColumns.add(i, new int[] { start, end }); + added = true; + } + else if (end <= region[1]) + { + /* + * new range overlaps existing, or is contiguous preceding it - adjust + * start column + */ + region[0] = Math.min(region[0], start); + added = true; + } + else if (start <= region[1] + 1) + { + /* + * new range overlaps existing, or is contiguous following it - adjust + * start and end columns + */ + region[0] = Math.min(region[0], start); + region[1] = Math.max(region[1], end); + + /* + * also update or remove any subsequent ranges + * that are overlapped + */ + while (i < hiddenColumns.size() - 1) { - for (int i = 0; i < hiddenColumns.size(); i++) + int[] nextRegion = hiddenColumns.get(i + 1); + if (nextRegion[0] > end + 1) { - int[] region = hiddenColumns.elementAt(i); - if (result >= region[0]) - { - result += region[1] - region[0] + 1; - } + /* + * gap to next hidden range - no more to update + */ + break; } + region[1] = Math.max(nextRegion[1], end); + + // in theory this is faster than hiddenColumns.remove(i+1) + // benchmarking results a bit ambivalent + hiddenColumns.subList(i + 1, i + 2).clear(); } - return result; - } finally - { - LOCK.readLock().unlock(); + added = true; } + return added; } /** - * Use this method to find out where a column will appear in the visible - * alignment when hidden columns exist. If the column is not visible, then the - * left-most visible column will always be returned. + * mark the columns corresponding to gap characters as hidden in the column + * selection * - * @param hiddenColumn - * the column index in the full alignment including hidden columns - * @return the position of the column in the visible alignment + * @param insertions */ - public int findColumnPosition(int hiddenColumn) + public void hideInsertionsFor(List inserts) { try { - LOCK.readLock().lock(); - int result = hiddenColumn; - if (hiddenColumns != null) + LOCK.writeLock().lock(); + for (int[] r : inserts) { - int index = 0; - int[] region; - do - { - region = hiddenColumns.elementAt(index++); - if (hiddenColumn > region[1]) - { - result -= region[1] + 1 - region[0]; - } - } while ((hiddenColumn > region[1]) - && (index < hiddenColumns.size())); - - if (hiddenColumn >= region[0] && hiddenColumn <= region[1]) - { - // Here the hidden column is within a region, so - // we want to return the position of region[0]-1, adjusted for any - // earlier hidden columns. - // Calculate the difference between the actual hidden col position - // and region[0]-1, and then subtract from result to convert result - // from - // the adjusted hiddenColumn value to the adjusted region[0]-1 value - - // However, if the region begins at 0 we cannot return region[0]-1 - // just return 0 - if (region[0] == 0) - { - return 0; - } - else - { - return result - (hiddenColumn - region[0] + 1); - } - } + hideColumns(r[0], r[1]); } - return result; // return the shifted position after removing hidden - // columns. + cursor.resetCursor(hiddenColumns); + numColumns = 0; } finally { - LOCK.readLock().unlock(); + LOCK.writeLock().unlock(); } } /** - * Find the visible column which is a given visible number of columns to the - * left of another visible column. i.e. for a startColumn x, the column which - * is distance 1 away will be column x-1. - * - * @param visibleDistance - * the number of visible columns to offset by - * @param startColumn - * the column to start from - * @return the position of the column in the visible alignment + * Unhides, and adds to the selection list, all hidden columns */ - public int subtractVisibleColumns(int visibleDistance, int startColumn) + public void revealAllHiddenColumns(ColumnSelection sel) { try { - - LOCK.readLock().lock(); - int distance = visibleDistance; - - // in case startColumn is in a hidden region, move it to the left - int start = adjustForHiddenColumns(findColumnPosition(startColumn)); - - // get index of hidden region to left of start - int index = getHiddenIndexLeft(start); - if (index == -1) - { - // no hidden regions to left of startColumn - return start - distance; - } - - // walk backwards through the alignment subtracting the counts of visible - // columns from distance - int[] region; - int gap = 0; - int nextstart = start; - - while ((index > -1) && (distance - gap > 0)) - { - // subtract the gap to right of region from distance - distance -= gap; - start = nextstart; - - // calculate the next gap - region = hiddenColumns.get(index); - gap = start - region[1]; - - // set start to just to left of current region - nextstart = region[0] - 1; - index--; - } - - if (distance - gap > 0) - { - // fell out of loop because there are no more hidden regions - distance -= gap; - return nextstart - distance; - } - return start - distance; + LOCK.writeLock().lock(); + if (hiddenColumns != null) + { + Iterator it = hiddenColumns.iterator(); + while (it.hasNext()) + { + int[] region = it.next(); + for (int j = region[0]; j < region[1] + 1; j++) + { + sel.addElement(j); + } + } + hiddenColumns = null; + cursor.resetCursor(hiddenColumns); + numColumns = 0; + } } finally { - LOCK.readLock().unlock(); + LOCK.writeLock().unlock(); } - } /** - * Use this method to determine the set of hiddenRegion start positions + * Reveals, and marks as selected, the hidden column range with the given + * start column * - * @return list of column number in visible view where hidden regions start + * @param start + * the start column to look for + * @param sel + * the column selection to add the hidden column range to */ - public List findHiddenRegionPositions() + public void revealHiddenColumns(int start, ColumnSelection sel) { try { - LOCK.readLock().lock(); - List positions = new ArrayList<>( - hiddenColumns.size()); + LOCK.writeLock().lock(); - positions.add(hiddenColumns.elementAt(0)[0]); - for (int i = 1; i < hiddenColumns.size(); ++i) + if (hiddenColumns != null) { + int regionIndex = cursor.findRegionForColumn(start) + .getRegionIndex(); - int result = 0; - if (hiddenColumns != null) + if (regionIndex != -1 && regionIndex != hiddenColumns.size()) { - int index = 0; - int gaps = 0; - do + // regionIndex is the region which either contains start + // or lies to the right of start + int[] region = hiddenColumns.get(regionIndex); + if (start == region[0]) { - int[] region = hiddenColumns.elementAt(index); - gaps += region[1] + 1 - region[0]; - result = region[1] + 1; - index++; - } while (index <= i); + for (int j = region[0]; j < region[1] + 1; j++) + { + sel.addElement(j); + } + int colsToRemove = region[1] - region[0] + 1; + hiddenColumns.remove(regionIndex); - result -= gaps; + if (hiddenColumns.isEmpty()) + { + hiddenColumns = null; + numColumns = 0; + } + else + { + numColumns -= colsToRemove; + } + cursor.updateForDeletedRegion(hiddenColumns); + } } - positions.add(result); } - - return positions; - } - finally + } finally { - LOCK.readLock().unlock(); + LOCK.writeLock().unlock(); } } /** - * This method returns the rightmost limit of a region of an alignment with - * hidden columns. In otherwords, the next hidden column. + * Add gaps into the sequences aligned to profileseq under the given + * AlignmentView * - * @param index - * int + * @param profileseq + * sequence in al which sequences are aligned to + * @param al + * alignment to have gaps inserted into it + * @param input + * alignment view where sequence corresponding to profileseq is first + * entry + * @return new HiddenColumns for new alignment view, with insertions into + * profileseq marked as hidden. */ - public int getHiddenBoundaryRight(int alPos) + public static HiddenColumns propagateInsertions(SequenceI profileseq, + AlignmentI al, AlignmentView input) { - try - { - LOCK.readLock().lock(); - if (hiddenColumns != null) - { - int index = 0; - do - { - int[] region = hiddenColumns.elementAt(index); - if (alPos < region[0]) - { - return region[0]; - } - - index++; - } while (index < hiddenColumns.size()); - } - - return alPos; - } finally - { - LOCK.readLock().unlock(); - } + int profsqpos = 0; + char gc = al.getGapCharacter(); + Object[] alandhidden = input.getAlignmentAndHiddenColumns(gc); + HiddenColumns nview = (HiddenColumns) alandhidden[1]; + SequenceI origseq = ((SequenceI[]) alandhidden[0])[profsqpos]; + nview.propagateInsertions(profileseq, al, origseq); + return nview; } /** - * This method returns the leftmost limit of a region of an alignment with - * hidden columns. In otherwords, the previous hidden column. * - * @param index - * int + * @param profileseq + * sequence in al which corresponds to origseq + * @param al + * alignment which is to have gaps inserted into it + * @param origseq + * sequence corresponding to profileseq which defines gap map for + * modifying al */ - public int getHiddenBoundaryLeft(int alPos) + private void propagateInsertions(SequenceI profileseq, AlignmentI al, + SequenceI origseq) { try { - LOCK.readLock().lock(); + LOCK.writeLock().lock(); - if (hiddenColumns != null) - { - int index = hiddenColumns.size() - 1; - do + char gc = al.getGapCharacter(); + + // take the set of hidden columns, and the set of gaps in origseq, + // and remove all the hidden gaps from hiddenColumns + + // first get the gaps as a Bitset + BitSet gaps = origseq.gapBitset(); + + // now calculate hidden ^ not(gap) + BitSet hidden = new BitSet(); + markHiddenRegions(hidden); + hidden.andNot(gaps); + hiddenColumns = null; + this.hideColumns(hidden); + + // for each sequence in the alignment, except the profile sequence, + // insert gaps corresponding to each hidden region but where each hidden + // column region is shifted backwards by the number of preceding visible + // gaps update hidden columns at the same time + Iterator regions = hiddenColumns.iterator(); + List newhidden = new ArrayList<>(); + + int numGapsBefore = 0; + int gapPosition = 0; + while (regions.hasNext()) { - int[] region = hiddenColumns.elementAt(index); - if (alPos > region[1]) + // get region coordinates accounting for gaps + // we can rely on gaps not being *in* hidden regions because we already + // removed those + int[] region = regions.next(); + while (gapPosition < region[0]) { - return region[1]; + gapPosition++; + if (gaps.get(gapPosition)) + { + numGapsBefore++; + } } - index--; - } while (index > -1); - } + int left = region[0] - numGapsBefore; + int right = region[1] - numGapsBefore; + newhidden.add(new int[] { left, right }); + + // make a string with number of gaps = length of hidden region + StringBuffer sb = new StringBuffer(); + for (int s = 0; s < right - left + 1; s++) + { + sb.append(gc); + } + padGaps(sb, left, profileseq, al); - return alPos; + } + hiddenColumns = newhidden; + cursor.resetCursor(hiddenColumns); + numColumns = 0; } finally { - LOCK.readLock().unlock(); + LOCK.writeLock().unlock(); } } /** - * This method returns the index of the hidden region to the left of a column - * position. If the column is in a hidden region it returns the index of the - * region to the left. If there is no hidden region to the left it returns -1. + * Pad gaps in all sequences in alignment except profileseq * - * @param pos - * int + * @param sb + * gap string to insert + * @param left + * position to insert at + * @param profileseq + * sequence not to pad + * @param al + * alignment to pad sequences in */ - private int getHiddenIndexLeft(int pos) + private void padGaps(StringBuffer sb, int pos, SequenceI profileseq, + AlignmentI al) { - try - { - - LOCK.readLock().lock(); - if (hiddenColumns != null) + // loop over the sequences and pad with gaps where required + for (int s = 0, ns = al.getHeight(); s < ns; s++) { - int index = hiddenColumns.size() - 1; - do + SequenceI sqobj = al.getSequenceAt(s); + if (sqobj != profileseq) { - int[] region = hiddenColumns.elementAt(index); - if (pos > region[1]) + String sq = al.getSequenceAt(s).getSequenceAsString(); + if (sq.length() <= pos) { - return index; + // pad sequence + int diff = pos - sq.length() - 1; + if (diff > 0) + { + // pad gaps + sq = sq + sb; + while ((diff = pos - sq.length() - 1) > 0) + { + if (diff >= sb.length()) + { + sq += sb.toString(); + } + else + { + char[] buf = new char[diff]; + sb.getChars(0, diff, buf, 0); + sq += buf.toString(); + } + } + } + sq += sb.toString(); } - - index--; - } while (index > -1); - } - - return -1; - } finally - { - LOCK.readLock().unlock(); + else + { + al.getSequenceAt(s).setSequence( + sq.substring(0, pos) + sb.toString() + sq.substring(pos)); + } + } } - } - /** - * Adds the specified column range to the hidden columns - * - * @param start - * @param end + /* + * Methods which only need read access to the hidden columns collection. + * These methods should use a readLock to prevent other threads changing + * the hidden columns collection while it is in use. */ - public void hideColumns(int start, int end) - { - hideColumns(start, end, false); - } /** - * Adds the specified column range to the hidden columns + * Output regions data as a string. String is in the format: + * reg0[0]reg0[1]reg1[0]reg1[1] ... regn[1] * - * @param start - * @param end + * @param delimiter + * string to delimit regions + * @param betweenstring + * to put between start and end region values + * @return regions formatted according to delimiter and between strings */ - private void hideColumns(int start, int end, boolean alreadyLocked) + public String regionsToString(String delimiter, String between) { try { - - if (!alreadyLocked) - { - LOCK.writeLock().lock(); - } - - if (hiddenColumns == null) - { - hiddenColumns = new Vector<>(); - } - - /* - * traverse existing hidden ranges and insert / amend / append as - * appropriate - */ - for (int i = 0; i < hiddenColumns.size(); i++) + LOCK.readLock().lock(); + StringBuilder regionBuilder = new StringBuilder(); + if (hiddenColumns != null) { - int[] region = hiddenColumns.elementAt(i); - - if (end < region[0] - 1) - { - /* - * insert discontiguous preceding range - */ - hiddenColumns.insertElementAt(new int[] { start, end }, i); - return; - } - - if (end <= region[1]) - { - /* - * new range overlaps existing, or is contiguous preceding it - adjust - * start column - */ - region[0] = Math.min(region[0], start); - return; - } - - if (start <= region[1] + 1) + Iterator it = hiddenColumns.iterator(); + while (it.hasNext()) { - /* - * new range overlaps existing, or is contiguous following it - adjust - * start and end columns - */ - region[0] = Math.min(region[0], start); - region[1] = Math.max(region[1], end); - - /* - * also update or remove any subsequent ranges - * that are overlapped - */ - while (i < hiddenColumns.size() - 1) + int[] range = it.next(); + regionBuilder.append(delimiter).append(range[0]).append(between) + .append(range[1]); + if (!it.hasNext()) { - int[] nextRegion = hiddenColumns.get(i + 1); - if (nextRegion[0] > end + 1) - { - /* - * gap to next hidden range - no more to update - */ - break; - } - region[1] = Math.max(nextRegion[1], end); - hiddenColumns.remove(i + 1); + regionBuilder.deleteCharAt(0); } - return; } - } - - /* - * remaining case is that the new range follows everything else - */ - hiddenColumns.addElement(new int[] { start, end }); + } + return regionBuilder.toString(); } finally { - if (!alreadyLocked) - { - LOCK.writeLock().unlock(); - } + LOCK.readLock().unlock(); } } - public boolean isVisible(int column) + /** + * Find the number of hidden columns + * + * @return number of hidden columns + */ + public int getSize() { try { LOCK.readLock().lock(); - if (hiddenColumns != null) - { - for (int[] region : hiddenColumns) + if (numColumns == 0 && hiddenColumns != null) { - if (column >= region[0] && column <= region[1]) + // numColumns is out of date, so recalculate + int size = 0; + + Iterator it = hiddenColumns.iterator(); + while (it.hasNext()) { - return false; + int[] range = it.next(); + size += range[1] - range[0] + 1; } + + numColumns = size; } - } - return true; + return numColumns; } finally { LOCK.readLock().unlock(); @@ -598,91 +641,91 @@ public class HiddenColumns } /** - * ColumnSelection - */ - public HiddenColumns() - { - } - - /** - * Copy constructor + * Get the number of distinct hidden regions * - * @param copy + * @return number of regions */ - public HiddenColumns(HiddenColumns copy) + public int getNumberOfRegions() { try { - LOCK.readLock().lock(); - if (copy != null) + int num = 0; + if (hasHiddenColumns()) { - if (copy.hiddenColumns != null) - { - hiddenColumns = copy.copyHiddenRegions(); - } + num = hiddenColumns.size(); } - } - finally + return num; + } finally { LOCK.readLock().unlock(); } } - private Vector copyHiddenRegions() + @Override + public boolean equals(Object obj) { - Vector copy = new Vector<>(hiddenColumns.size()); - for (int i = 0, j = hiddenColumns.size(); i < j; i++) + try { - int[] rh; - int[] cp; - rh = hiddenColumns.elementAt(i); - if (rh != null) + LOCK.readLock().lock(); + + if (!(obj instanceof HiddenColumns)) { - cp = new int[rh.length]; - System.arraycopy(rh, 0, cp, 0, rh.length); - copy.addElement(cp); + return false; } - } - return copy; - } + HiddenColumns that = (HiddenColumns) obj; - private ArrayList copyHiddenRegionsToArrayList() - { - ArrayList copy = new ArrayList<>(hiddenColumns.size()); - for (int i = 0, j = hiddenColumns.size(); i < j; i++) - { - int[] rh; - int[] cp; - rh = hiddenColumns.elementAt(i); - if (rh != null) + /* + * check hidden columns are either both null, or match + */ + if (this.hiddenColumns == null) { - cp = new int[rh.length]; - System.arraycopy(rh, 0, cp, 0, rh.length); - copy.add(cp); + return (that.hiddenColumns == null); + } + if (that.hiddenColumns == null + || that.hiddenColumns.size() != this.hiddenColumns.size()) + { + return false; } - } - return copy; - } - public Vector getHiddenColumnsCopy() - { - try - { - LOCK.readLock().lock(); - return copyHiddenRegions(); + Iterator it = hiddenColumns.iterator(); + Iterator thatit = that.iterator(); + while (it.hasNext()) + { + int[] thisRange = it.next(); + int[] thatRange = thatit.next(); + if (thisRange[0] != thatRange[0] || thisRange[1] != thatRange[1]) + { + return false; + } + } + return true; } finally { LOCK.readLock().unlock(); } } - public ArrayList getHiddenColumnsCopyAsList() + /** + * Return absolute column index for a visible column index + * + * @param column + * int column index in alignment view (count from zero) + * @return alignment column index for column + */ + public int visibleToAbsoluteColumn(int column) { try { LOCK.readLock().lock(); - return copyHiddenRegionsToArrayList(); + int result = column; + + if (hiddenColumns != null) + { + result += cursor.findRegionForVisColumn(column).getHiddenSoFar(); + } + + return result; } finally { LOCK.readLock().unlock(); @@ -690,474 +733,213 @@ public class HiddenColumns } /** - * propagate shift in alignment columns to column selection + * Use this method to find out where a column will appear in the visible + * alignment when hidden columns exist. If the column is not visible, then the + * index of the next visible column on the left will be returned (or 0 if + * there is no visible column on the left) * - * @param start - * beginning of edit - * @param left - * shift in edit (+ve for removal, or -ve for inserts) + * @param hiddenColumn + * the column index in the full alignment including hidden columns + * @return the position of the column in the visible alignment */ - public List compensateForEdit(int start, int change, - ColumnSelection sel) + public int absoluteToVisibleColumn(int hiddenColumn) { try { - LOCK.writeLock().lock(); - List deletedHiddenColumns = null; + LOCK.readLock().lock(); + int result = hiddenColumn; if (hiddenColumns != null) { - deletedHiddenColumns = new ArrayList<>(); - int hSize = hiddenColumns.size(); - for (int i = 0; i < hSize; i++) + HiddenCursorPosition cursorPos = cursor + .findRegionForColumn(hiddenColumn); + int index = cursorPos.getRegionIndex(); + int hiddenBeforeCol = cursorPos.getHiddenSoFar(); + + // just subtract hidden cols count - this works fine if column is + // visible + result = hiddenColumn - hiddenBeforeCol; + + // now check in case column is hidden - it will be in the returned + // hidden region + if (index < hiddenColumns.size()) { - int[] region = hiddenColumns.elementAt(i); - if (region[0] > start && start + change > region[1]) - { - deletedHiddenColumns.add(region); - - hiddenColumns.removeElementAt(i); - i--; - hSize--; - continue; - } - - if (region[0] > start) - { - region[0] -= change; - region[1] -= change; - } - - if (region[0] < 0) + int[] region = hiddenColumns.get(index); + if (hiddenColumn >= region[0] && hiddenColumn <= region[1]) { - region[0] = 0; + // actually col is hidden, return region[0]-1 + // unless region[0]==0 in which case return 0 + if (region[0] == 0) + { + result = 0; + } + else + { + result = region[0] - 1 - hiddenBeforeCol; + } } - } - - this.revealHiddenColumns(0, sel); } - return deletedHiddenColumns; + return result; // return the shifted position after removing hidden + // columns. } finally { - LOCK.writeLock().unlock(); + LOCK.readLock().unlock(); } } /** - * propagate shift in alignment columns to column selection special version of - * compensateForEdit - allowing for edits within hidden regions + * Find the visible column which is a given visible number of columns to the + * left of another visible column. i.e. for a startColumn x, the column which + * is distance 1 away will be column x-1. * - * @param start - * beginning of edit - * @param left - * shift in edit (+ve for removal, or -ve for inserts) + * @param visibleDistance + * the number of visible columns to offset by + * @param startColumn + * the column to start from + * @return the position of the column in the visible alignment */ - public void compensateForDelEdits(int start, int change) + public int subtractVisibleColumns(int visibleDistance, int startColumn) { try { - LOCK.writeLock().lock(); - if (hiddenColumns != null) + LOCK.readLock().lock(); + int distance = visibleDistance; + + // in case startColumn is in a hidden region, move it to the left + int start = visibleToAbsoluteColumn(absoluteToVisibleColumn(startColumn)); + + Iterator it = new ReverseRegionsIterator(0, start, + hiddenColumns); + + while (it.hasNext() && (distance > 0)) { - for (int i = 0; i < hiddenColumns.size(); i++) + int[] region = it.next(); + + if (start > region[1]) { - int[] region = hiddenColumns.elementAt(i); - if (region[0] >= start) - { - region[0] -= change; - } - if (region[1] >= start) + // subtract the gap to right of region from distance + if (start - region[1] <= distance) { - region[1] -= change; + distance -= start - region[1]; + start = region[0] - 1; } - if (region[1] < region[0]) + else { - hiddenColumns.removeElementAt(i--); - } - - if (region[0] < 0) - { - region[0] = 0; - } - if (region[1] < 0) - { - region[1] = 0; + start = start - distance; + distance = 0; } } } - } - finally + return start - distance; + + } finally { - LOCK.writeLock().unlock(); + LOCK.readLock().unlock(); } } /** - * return all visible segments between the given start and end boundaries + * This method returns the rightmost limit of a region of an alignment with + * hidden columns. In otherwords, the next hidden column. * - * @param start - * (first column inclusive from 0) - * @param end - * (last column - not inclusive) - * @return int[] {i_start, i_end, ..} where intervals lie in - * start<=i_start<=i_end