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 java.util.ArrayList;
24 import java.util.BitSet;
25 import java.util.Iterator;
26 import java.util.List;
27 import java.util.concurrent.locks.ReentrantReadWriteLock;
29 public class HiddenColumns
31 private static final int HASH_MULTIPLIER = 31;
33 private static final ReentrantReadWriteLock LOCK = new ReentrantReadWriteLock();
35 private HiddenColumnsCursor cursor = new HiddenColumnsCursor();
38 * list of hidden column [start, end] ranges; the list is maintained in
39 * ascending start column order
41 private ArrayList<int[]> hiddenColumns;
46 public HiddenColumns()
55 public HiddenColumns(HiddenColumns copy)
59 LOCK.writeLock().lock();
62 if (copy.hiddenColumns != null)
64 hiddenColumns = new ArrayList<>();
65 Iterator<int[]> it = copy.iterator();
68 hiddenColumns.add(it.next());
70 cursor.resetCursor(hiddenColumns);
75 LOCK.writeLock().unlock();
80 * Copy constructor within bounds and with offset. Copies hidden column
81 * regions fully contained between start and end, and offsets positions by
85 * HiddenColumns instance to copy from
87 * lower bound to copy from
89 * upper bound to copy to
91 * offset to subtract from each region boundary position
94 public HiddenColumns(HiddenColumns copy, int start, int end, int offset)
98 LOCK.writeLock().lock();
101 hiddenColumns = new ArrayList<>();
102 Iterator<int[]> it = copy.getBoundedIterator(start, end);
105 int[] region = it.next();
106 // still need to check boundaries because iterator returns
107 // all overlapping regions and we need contained regions
108 if (region[0] >= start && region[1] <= end)
112 { region[0] - offset, region[1] - offset });
115 cursor.resetCursor(hiddenColumns);
119 LOCK.writeLock().unlock();
124 * Output regions data as a string. String is in the format:
125 * reg0[0]<between>reg0[1]<delimiter>reg1[0]<between>reg1[1] ... regn[1]
128 * string to delimit regions
129 * @param betweenstring
130 * to put between start and end region values
131 * @return regions formatted according to delimiter and between strings
133 public String regionsToString(String delimiter, String between)
137 LOCK.readLock().lock();
138 StringBuilder regionBuilder = new StringBuilder();
139 if (hiddenColumns != null)
141 Iterator<int[]> it = hiddenColumns.iterator();
144 int[] range = it.next();
145 regionBuilder.append(delimiter).append(range[0]).append(between)
149 regionBuilder.deleteCharAt(0);
153 return regionBuilder.toString();
156 LOCK.readLock().unlock();
161 * Find the number of hidden columns
163 * @return number of hidden columns
169 LOCK.readLock().lock();
171 if (hiddenColumns != null)
173 Iterator<int[]> it = hiddenColumns.iterator();
176 int[] range = it.next();
177 size += range[1] - range[0] + 1;
183 LOCK.readLock().unlock();
188 * Get the number of distinct hidden regions
190 * @return number of regions
192 public int getNumberOfRegions()
196 LOCK.readLock().lock();
198 if (hasHiddenColumns())
200 num = hiddenColumns.size();
205 LOCK.readLock().unlock();
210 public boolean equals(Object obj)
214 LOCK.readLock().lock();
216 if (!(obj instanceof HiddenColumns))
220 HiddenColumns that = (HiddenColumns) obj;
223 * check hidden columns are either both null, or match
225 if (this.hiddenColumns == null)
227 return (that.hiddenColumns == null);
229 if (that.hiddenColumns == null
230 || that.hiddenColumns.size() != this.hiddenColumns.size())
235 Iterator<int[]> it = hiddenColumns.iterator();
236 Iterator<int[]> thatit = that.iterator();
239 int[] thisRange = it.next();
240 int[] thatRange = thatit.next();
241 if (thisRange[0] != thatRange[0] || thisRange[1] != thatRange[1])
249 LOCK.readLock().unlock();
254 * Return absolute column index for a visible column index
257 * int column index in alignment view (count from zero)
258 * @return alignment column index for column
260 public int adjustForHiddenColumns(int column)
264 LOCK.readLock().lock();
267 if (hiddenColumns != null)
269 result += cursor.getHiddenOffset(column);
272 /*Iterator<int[]> it = hiddenColumns.iterator();
275 int[] region = it.next();
276 if (result >= region[0])
278 result += region[1] - region[0] + 1;
286 LOCK.readLock().unlock();
291 * Use this method to find out where a column will appear in the visible
292 * alignment when hidden columns exist. If the column is not visible, then the
293 * left-most visible column will always be returned.
295 * @param hiddenColumn
296 * the column index in the full alignment including hidden columns
297 * @return the position of the column in the visible alignment
299 public int findColumnPosition(int hiddenColumn)
303 LOCK.readLock().lock();
304 int result = hiddenColumn;
306 if (hiddenColumns != null)
308 Iterator<int[]> it = new RegionsIterator(0,
309 hiddenColumn, hiddenColumns, cursor);
313 if (hiddenColumn > region[1])
315 result -= region[1] + 1 - region[0];
319 if (region != null && hiddenColumn >= region[0]
320 && hiddenColumn <= region[1])
322 // Here the hidden column is within a region, so
323 // we want to return the position of region[0]-1, adjusted for any
324 // earlier hidden columns.
325 // Calculate the difference between the actual hidden col position
326 // and region[0]-1, and then subtract from result to convert result
327 // from the adjusted hiddenColumn value to the adjusted region[0]-1
330 // However, if the region begins at 0 we cannot return region[0]-1
338 return result - (hiddenColumn - region[0] + 1);
342 return result; // return the shifted position after removing hidden
346 LOCK.readLock().unlock();
351 * Find the visible column which is a given visible number of columns to the
352 * left of another visible column. i.e. for a startColumn x, the column which
353 * is distance 1 away will be column x-1.
355 * @param visibleDistance
356 * the number of visible columns to offset by
358 * the column to start from
359 * @return the position of the column in the visible alignment
361 public int subtractVisibleColumns(int visibleDistance, int startColumn)
365 LOCK.readLock().lock();
366 int distance = visibleDistance;
368 // in case startColumn is in a hidden region, move it to the left
369 int start = adjustForHiddenColumns(findColumnPosition(startColumn));
371 Iterator<int[]> it = new ReverseRegionsIterator(0, start,
374 while (it.hasNext() && (distance > 0))
376 int[] region = it.next();
378 if (start > region[1])
380 // subtract the gap to right of region from distance
381 if (start - region[1] <= distance)
383 distance -= start - region[1];
384 start = region[0] - 1;
388 start = start - distance;
394 return start - distance;
398 LOCK.readLock().unlock();
403 * This method returns the rightmost limit of a region of an alignment with
404 * hidden columns. In otherwords, the next hidden column.
407 * the (visible) alignmentPosition to find the next hidden column for
409 public int getHiddenBoundaryRight(int alPos)
413 LOCK.readLock().lock();
414 if (hiddenColumns != null)
416 Iterator<int[]> it = hiddenColumns.iterator();
419 int[] region = it.next();
420 if (alPos < region[0])
429 LOCK.readLock().unlock();
434 * This method returns the leftmost limit of a region of an alignment with
435 * hidden columns. In otherwords, the previous hidden column.
438 * the (visible) alignmentPosition to find the previous hidden column
441 public int getHiddenBoundaryLeft(int alPos)
445 LOCK.readLock().lock();
447 Iterator<int[]> it = new ReverseRegionsIterator(0, alPos,
451 int[] region = it.next();
452 if (alPos > region[1])
461 LOCK.readLock().unlock();
466 * Adds the specified column range to the hidden columns collection
469 * start of range to add (absolute position in alignment)
471 * end of range to add (absolute position in alignment)
473 public void hideColumns(int start, int end)
475 boolean wasAlreadyLocked = false;
478 // check if the write lock was already locked by this thread,
479 // as this method can be called internally in loops within HiddenColumns
480 if (!LOCK.isWriteLockedByCurrentThread())
482 LOCK.writeLock().lock();
486 wasAlreadyLocked = true;
489 if (hiddenColumns == null)
491 hiddenColumns = new ArrayList<>();
495 * new range follows everything else; check first to avoid looping over whole hiddenColumns collection
497 if (hiddenColumns.isEmpty()
498 || start > hiddenColumns.get(hiddenColumns.size() - 1)[1])
500 hiddenColumns.add(new int[] { start, end });
505 * traverse existing hidden ranges and insert / amend / append as
508 boolean added = false;
509 for (int i = 0; !added && i < hiddenColumns.size(); i++)
511 added = insertRangeAtRegion(i, start, end);
514 if (!wasAlreadyLocked)
516 cursor.resetCursor(hiddenColumns);
520 if (!wasAlreadyLocked)
522 LOCK.writeLock().unlock();
528 * Insert [start, range] at the region at index i in hiddenColumns, if
534 * start of range to insert
536 * end of range to insert
537 * @return true if range was successfully inserted
539 private boolean insertRangeAtRegion(int i, int start, int end)
541 boolean added = false;
543 int[] region = hiddenColumns.get(i);
544 if (end < region[0] - 1)
547 * insert discontiguous preceding range
549 hiddenColumns.add(i, new int[] { start, end });
552 else if (end <= region[1])
555 * new range overlaps existing, or is contiguous preceding it - adjust
558 region[0] = Math.min(region[0], start);
561 else if (start <= region[1] + 1)
564 * new range overlaps existing, or is contiguous following it - adjust
565 * start and end columns
567 region[0] = Math.min(region[0], start);
568 region[1] = Math.max(region[1], end);
571 * also update or remove any subsequent ranges
572 * that are overlapped
574 while (i < hiddenColumns.size() - 1)
576 int[] nextRegion = hiddenColumns.get(i + 1);
577 if (nextRegion[0] > end + 1)
580 * gap to next hidden range - no more to update
584 region[1] = Math.max(nextRegion[1], end);
585 hiddenColumns.subList(i + 1, i + 2).clear();
593 * Answers if a column in the alignment is visible
596 * absolute position of column in the alignment
597 * @return true if column is visible
599 public boolean isVisible(int column)
603 LOCK.readLock().lock();
605 Iterator<int[]> it = new RegionsIterator(column, column,
606 hiddenColumns, cursor);
609 int[] region = it.next();
610 if (column >= region[0] && column <= region[1])
619 LOCK.readLock().unlock();
624 * Get the visible sections of a set of sequences
627 * sequence position to start from
629 * sequence position to end at
631 * an array of sequences
632 * @return an array of strings encoding the visible parts of each sequence
634 public String[] getVisibleSequenceStrings(int start, int end,
639 LOCK.readLock().lock();
640 int iSize = seqs.length;
641 String[] selections = new String[iSize];
642 if (hiddenColumns != null && hiddenColumns.size() > 0)
644 for (int i = 0; i < iSize; i++)
646 StringBuffer visibleSeq = new StringBuffer();
648 Iterator<int[]> blocks = new VisibleContigsIterator(start,
649 end + 1, hiddenColumns);
651 while (blocks.hasNext())
653 int[] block = blocks.next();
654 if (blocks.hasNext())
657 .append(seqs[i].getSequence(block[0], block[1] + 1));
662 .append(seqs[i].getSequence(block[0], block[1]));
666 selections[i] = visibleSeq.toString();
671 for (int i = 0; i < iSize; i++)
673 selections[i] = seqs[i].getSequenceAsString(start, end);
680 LOCK.readLock().unlock();
685 * Locate the first position visible for this sequence. If seq isn't visible
686 * then return the position of the left side of the hidden boundary region.
689 * sequence to find position for
690 * @return visible start position
692 public int locateVisibleStartOfSequence(SequenceI seq)
696 LOCK.readLock().lock();
699 if (hiddenColumns == null || hiddenColumns.size() == 0)
701 return seq.findIndex(seq.getStart()) - 1;
704 // Simply walk along the sequence whilst watching for hidden column
706 Iterator<int[]> regions = hiddenColumns.iterator();
707 int hideStart = seq.getLength();
711 boolean foundStart = false;
713 // step through the non-gapped positions of the sequence
714 for (int i = seq.getStart(); i <= seq.getEnd() && (!foundStart); i++)
716 // get alignment position of this residue in the sequence
717 int p = seq.findIndex(i) - 1;
719 // update hidden region start/end
720 while (hideEnd < p && regions.hasNext())
722 int[] region = regions.next();
724 visNext += region[0] - visPrev;
725 hideStart = region[0];
730 hideStart = seq.getLength();
732 // update visible boundary for sequence
742 return findColumnPosition(start);
744 // otherwise, sequence was completely hidden
748 LOCK.readLock().unlock();
753 * delete any columns in alignmentAnnotation that are hidden (including
754 * sequence associated annotation).
756 * @param alignmentAnnotation
758 public void makeVisibleAnnotation(AlignmentAnnotation alignmentAnnotation)
760 makeVisibleAnnotation(0, alignmentAnnotation.annotations.length,
761 alignmentAnnotation);
765 * delete any columns in alignmentAnnotation that are hidden (including
766 * sequence associated annotation).
769 * remove any annotation to the right of this column
771 * remove any annotation to the left of this column
772 * @param alignmentAnnotation
773 * the annotation to operate on
775 public void makeVisibleAnnotation(int start, int end,
776 AlignmentAnnotation alignmentAnnotation)
780 LOCK.readLock().lock();
782 int startFrom = start;
785 if (alignmentAnnotation.annotations != null)
787 if (hiddenColumns != null && hiddenColumns.size() > 0)
789 removeHiddenAnnotation(startFrom, endAt, alignmentAnnotation);
793 alignmentAnnotation.restrict(startFrom, endAt);
798 LOCK.readLock().unlock();
802 private void removeHiddenAnnotation(int start, int end,
803 AlignmentAnnotation alignmentAnnotation)
805 // mangle the alignmentAnnotation annotation array
806 ArrayList<Annotation[]> annels = new ArrayList<>();
807 Annotation[] els = null;
811 Iterator<int[]> blocks = new VisibleContigsIterator(start, end + 1,
815 int annotationLength;
816 while (blocks.hasNext())
818 int[] block = blocks.next();
819 annotationLength = block[1] - block[0] + 1;
821 if (blocks.hasNext())
823 // copy just the visible segment of the annotation row
824 copylength = annotationLength;
828 if (annotationLength + block[0] <= alignmentAnnotation.annotations.length)
830 // copy just the visible segment of the annotation row
831 copylength = annotationLength;
835 // copy to the end of the annotation row
836 copylength = alignmentAnnotation.annotations.length - block[0];
840 els = new Annotation[annotationLength];
842 System.arraycopy(alignmentAnnotation.annotations, block[0], els, 0,
844 w += annotationLength;
849 alignmentAnnotation.annotations = new Annotation[w];
852 for (Annotation[] chnk : annels)
854 System.arraycopy(chnk, 0, alignmentAnnotation.annotations, w,
863 * @return true if there are columns hidden
865 public boolean hasHiddenColumns()
869 LOCK.readLock().lock();
870 return hiddenColumns != null && hiddenColumns.size() > 0;
873 LOCK.readLock().unlock();
879 * @return true if there are more than one set of columns hidden
881 public boolean hasManyHiddenColumns()
885 LOCK.readLock().lock();
886 return hiddenColumns != null && hiddenColumns.size() > 1;
889 LOCK.readLock().unlock();
894 * mark the columns corresponding to gap characters as hidden in the column
899 public void hideInsertionsFor(SequenceI sr)
903 LOCK.writeLock().lock();
904 List<int[]> inserts = sr.getInsertions();
905 for (int[] r : inserts)
907 hideColumns(r[0], r[1]);
909 cursor.resetCursor(hiddenColumns);
912 LOCK.writeLock().unlock();
917 * Unhides, and adds to the selection list, all hidden columns
919 public void revealAllHiddenColumns(ColumnSelection sel)
923 LOCK.writeLock().lock();
924 if (hiddenColumns != null)
926 Iterator<int[]> it = hiddenColumns.iterator();
929 int[] region = it.next();
930 for (int j = region[0]; j < region[1] + 1; j++)
935 hiddenColumns = null;
936 cursor.resetCursor(hiddenColumns);
940 LOCK.writeLock().unlock();
945 * Reveals, and marks as selected, the hidden column range with the given
950 public void revealHiddenColumns(int start, ColumnSelection sel)
954 LOCK.writeLock().lock();
955 Iterator<int[]> it = new RegionsIterator(start, start, hiddenColumns,
959 int[] region = it.next();
960 if (start == region[0])
962 for (int j = region[0]; j < region[1] + 1; j++)
969 else if (start < region[0])
971 break; // passed all possible matching regions
975 if (hiddenColumns.size() == 0)
977 hiddenColumns = null;
979 cursor.resetCursor(hiddenColumns);
982 LOCK.writeLock().unlock();
987 * Add gaps into the sequences aligned to profileseq under the given
992 * - alignment to have gaps inserted into it
994 * - alignment view where sequence corresponding to profileseq is
996 * @return new HiddenColumns for new alignment view, with insertions into
997 * profileseq marked as hidden.
999 public static HiddenColumns propagateInsertions(SequenceI profileseq,
1000 AlignmentI al, AlignmentView input)
1004 char gc = al.getGapCharacter();
1005 Object[] alandhidden = input.getAlignmentAndHiddenColumns(gc);
1006 HiddenColumns nview = (HiddenColumns) alandhidden[1];
1007 SequenceI origseq = ((SequenceI[]) alandhidden[0])[profsqpos];
1008 nview.propagateInsertions(profileseq, al, origseq);
1015 * - sequence in al which corresponds to origseq
1017 * - alignment which is to have gaps inserted into it
1019 * - sequence corresponding to profileseq which defines gap map for
1022 private void propagateInsertions(SequenceI profileseq, AlignmentI al,
1027 LOCK.writeLock().lock();
1029 char gc = al.getGapCharacter();
1031 // take the set of hidden columns, and the set of gaps in origseq,
1032 // and remove all the hidden gaps from hiddenColumns
1034 // first get the gaps as a Bitset
1035 BitSet gaps = origseq.gapBitset();
1037 // now calculate hidden ^ not(gap)
1038 BitSet hidden = new BitSet();
1039 markHiddenRegions(hidden);
1040 hidden.andNot(gaps);
1041 hiddenColumns = null;
1042 this.hideMarkedBits(hidden);
1044 // for each sequence in the alignment, except the profile sequence,
1045 // insert gaps corresponding to each hidden region
1046 // but where each hidden column region is shifted backwards by the number
1048 // preceding visible gaps
1049 // update hidden columns at the same time
1050 Iterator<int[]> regions = hiddenColumns.iterator();
1051 ArrayList<int[]> newhidden = new ArrayList<>();
1053 int numGapsBefore = 0;
1054 int gapPosition = 0;
1055 while (regions.hasNext())
1057 // get region coordinates accounting for gaps
1058 // we can rely on gaps not being *in* hidden regions because we already
1060 int[] region = regions.next();
1061 while (gapPosition < region[0])
1064 if (gaps.get(gapPosition))
1070 int left = region[0] - numGapsBefore;
1071 int right = region[1] - numGapsBefore;
1072 newhidden.add(new int[] { left, right });
1074 // make a string with number of gaps = length of hidden region
1075 StringBuffer sb = new StringBuffer();
1076 for (int s = 0; s < right - left + 1; s++)
1080 padGaps(sb, left, profileseq, al);
1083 hiddenColumns = newhidden;
1084 cursor.resetCursor(hiddenColumns);
1087 LOCK.writeLock().unlock();
1092 * Pad gaps in all sequences in alignment except profileseq
1095 * gap string to insert
1097 * position to insert at
1099 * sequence not to pad
1101 * alignment to pad sequences in
1103 private void padGaps(StringBuffer sb, int pos, SequenceI profileseq,
1106 // loop over the sequences and pad with gaps where required
1107 for (int s = 0, ns = al.getHeight(); s < ns; s++)
1109 SequenceI sqobj = al.getSequenceAt(s);
1110 if (sqobj != profileseq)
1112 String sq = al.getSequenceAt(s).getSequenceAsString();
1113 if (sq.length() <= pos)
1116 int diff = pos - sq.length() - 1;
1121 while ((diff = pos - sq.length() - 1) > 0)
1123 if (diff >= sb.length())
1125 sq += sb.toString();
1129 char[] buf = new char[diff];
1130 sb.getChars(0, diff, buf, 0);
1131 sq += buf.toString();
1135 sq += sb.toString();
1139 al.getSequenceAt(s).setSequence(
1140 sq.substring(0, pos) + sb.toString() + sq.substring(pos));
1147 * Returns a hashCode built from hidden column ranges
1150 public int hashCode()
1154 LOCK.readLock().lock();
1156 Iterator<int[]> it = hiddenColumns.iterator();
1157 while (it.hasNext())
1159 int[] hidden = it.next();
1160 hashCode = HASH_MULTIPLIER * hashCode + hidden[0];
1161 hashCode = HASH_MULTIPLIER * hashCode + hidden[1];
1166 LOCK.readLock().unlock();
1171 * Hide columns corresponding to the marked bits
1174 * - columns map to bits starting from zero
1176 public void hideMarkedBits(BitSet inserts)
1180 LOCK.writeLock().lock();
1181 for (int firstSet = inserts
1182 .nextSetBit(0), lastSet = 0; firstSet >= 0; firstSet = inserts
1183 .nextSetBit(lastSet))
1185 lastSet = inserts.nextClearBit(firstSet);
1186 hideColumns(firstSet, lastSet - 1);
1188 cursor.resetCursor(hiddenColumns);
1191 LOCK.writeLock().unlock();
1198 * BitSet where hidden columns will be marked
1200 public void markHiddenRegions(BitSet inserts)
1204 LOCK.readLock().lock();
1205 if (hiddenColumns == null)
1209 Iterator<int[]> it = hiddenColumns.iterator();
1210 while (it.hasNext())
1212 int[] range = it.next();
1213 inserts.set(range[0], range[1] + 1);
1217 LOCK.readLock().unlock();
1222 * Calculate the visible start and end index of an alignment.
1225 * full alignment width
1226 * @return integer array where: int[0] = startIndex, and int[1] = endIndex
1228 public int[] getVisibleStartAndEndIndex(int width)
1232 LOCK.readLock().lock();
1233 int[] alignmentStartEnd = new int[] { 0, width - 1 };
1234 int startPos = alignmentStartEnd[0];
1235 int endPos = alignmentStartEnd[1];
1237 int[] lowestRange = new int[] { -1, -1 };
1238 int[] higestRange = new int[] { -1, -1 };
1240 if (hiddenColumns == null)
1242 return new int[] { startPos, endPos };
1245 Iterator<int[]> it = hiddenColumns.iterator();
1246 while (it.hasNext())
1248 int[] range = it.next();
1249 lowestRange = (range[0] <= startPos) ? range : lowestRange;
1250 higestRange = (range[1] >= endPos) ? range : higestRange;
1253 if (lowestRange[0] == -1 && lowestRange[1] == -1)
1255 startPos = alignmentStartEnd[0];
1259 startPos = lowestRange[1] + 1;
1262 if (higestRange[0] == -1 && higestRange[1] == -1)
1264 endPos = alignmentStartEnd[1];
1268 endPos = higestRange[0] - 1;
1270 return new int[] { startPos, endPos };
1273 LOCK.readLock().unlock();
1278 * Finds the hidden region (if any) which starts or ends at res
1281 * visible residue position, unadjusted for hidden columns
1282 * @return region as [start,end] or null if no matching region is found
1284 public int[] getRegionWithEdgeAtRes(int res)
1288 LOCK.readLock().lock();
1289 int adjres = adjustForHiddenColumns(res);
1291 int[] reveal = null;
1292 Iterator<int[]> it = new RegionsIterator(adjres - 2,
1293 adjres + 2, hiddenColumns, cursor);
1294 while (it.hasNext())
1296 int[] region = it.next();
1297 if (adjres + 1 == region[0] || adjres - 1 == region[1])
1306 LOCK.readLock().unlock();
1311 * Return an iterator over the hidden regions
1313 public Iterator<int[]> iterator()
1317 LOCK.readLock().lock();
1318 return new BoundedHiddenColsIterator(hiddenColumns);
1321 LOCK.readLock().unlock();
1326 * Return a bounded iterator over the hidden regions
1329 * position to start from (inclusive, absolute column position)
1331 * position to end at (inclusive, absolute column position)
1334 public Iterator<int[]> getBoundedIterator(int start, int end)
1338 LOCK.readLock().lock();
1339 return new BoundedHiddenColsIterator(start, end, hiddenColumns);
1342 LOCK.readLock().unlock();
1347 * Return a bounded iterator over the *visible* start positions of hidden
1351 * position to start from (inclusive, visible column position)
1353 * position to end at (inclusive, visible column position)
1355 public Iterator<Integer> getBoundedStartIterator(int start, int end)
1359 LOCK.readLock().lock();
1360 return new BoundedStartRegionIterator(start, end, hiddenColumns);
1363 LOCK.readLock().unlock();
1368 * Return an iterator over visible *columns* (not regions) between the given
1369 * start and end boundaries
1372 * first column (inclusive)
1374 * last column (inclusive)
1376 public Iterator<Integer> getVisibleColsIterator(int start, int end)
1380 LOCK.readLock().lock();
1381 return new VisibleColsIterator(start, end, hiddenColumns);
1384 LOCK.readLock().unlock();
1389 * return an iterator over visible segments between the given start and end
1393 * (first column inclusive from 0)
1395 * (last column - not inclusive)
1397 public Iterator<int[]> getVisContigsIterator(int start, int end)
1401 LOCK.readLock().lock();
1402 return new VisibleContigsIterator(start, end, hiddenColumns);
1405 LOCK.readLock().unlock();
1410 * return an iterator over visible segments between the given start and end
1414 * (first column - inclusive from 0)
1416 * (last column - inclusive)
1417 * @param useVisibleCoords
1418 * if true, start and end are visible column positions, not absolute
1421 public Iterator<int[]> getVisibleBlocksIterator(int start, int end,
1422 boolean useVisibleCoords)
1424 if (useVisibleCoords)
1427 // we should really just convert start and end here with
1428 // adjustForHiddenColumns
1429 // and then create a VisibleContigsIterator
1430 // but without a cursor this will be horribly slow in some situations
1431 // ... so until then...
1432 return new VisibleBlocksVisBoundsIterator(start, end, true);
1438 LOCK.readLock().lock();
1439 return new VisibleContigsIterator(start, end + 1, hiddenColumns);
1442 LOCK.readLock().unlock();
1448 * An iterator which iterates over visible regions in a range. The range is
1449 * specified in terms of visible column positions. Provides a special
1450 * "endsAtHidden" indicator to allow callers to determine if the final visible
1451 * column is adjacent to a hidden region.
1453 public class VisibleBlocksVisBoundsIterator implements Iterator<int[]>
1455 private List<int[]> vcontigs = new ArrayList<>();
1457 private int currentPosition = 0;
1459 private boolean endsAtHidden = false;
1462 * Constructor for iterator over visible regions in a range.
1465 * start position in terms of visible column position
1467 * end position in terms of visible column position
1469 * whether to use a local copy of hidden columns
1471 VisibleBlocksVisBoundsIterator(int start, int end, boolean usecopy)
1473 /* actually this implementation always uses a local copy but this may change in future */
1478 LOCK.readLock().lock();
1481 if (hiddenColumns != null && hiddenColumns.size() > 0)
1483 int blockStart = start;
1485 int hiddenSoFar = 0;
1488 // iterate until a region begins within (start,end]
1490 while ((i < hiddenColumns.size())
1491 && (hiddenColumns.get(i)[0] <= blockStart + hiddenSoFar))
1493 hiddenSoFar += hiddenColumns.get(i)[1] - hiddenColumns.get(i)[0]
1498 blockStart += hiddenSoFar; // convert start to absolute position
1499 blockEnd += hiddenSoFar; // convert end to absolute position
1501 // iterate from start to end, adding each visible region. Positions
1503 // absolute, and all hidden regions which overlap [start,end] are
1505 while (i < hiddenColumns.size()
1506 && (hiddenColumns.get(i)[0] <= blockEnd))
1508 int[] region = hiddenColumns.get(i);
1510 // end position of this visible region is either just before the
1511 // start of the next hidden region, or the absolute position of
1512 // 'end', whichever is lowest
1513 blockEnd = Math.min(blockEnd, region[0] - 1);
1515 vcontigs.add(new int[] { blockStart, blockEnd });
1517 visSoFar += blockEnd - blockStart + 1;
1519 // next visible region starts after this hidden region
1520 blockStart = region[1] + 1;
1522 hiddenSoFar += region[1] - region[0] + 1;
1524 // reset blockEnd to absolute position of 'end', assuming we've now
1525 // passed all hidden regions before end
1526 blockEnd = end + hiddenSoFar;
1530 if (visSoFar < end - start)
1532 // the number of visible columns we've accounted for is less than
1533 // the number specified by end-start; work out the end position of
1534 // the last visible region
1535 blockEnd = blockStart + end - start - visSoFar;
1536 vcontigs.add(new int[] { blockStart, blockEnd });
1538 // if the last visible region ends at the next hidden region, set
1539 // endsAtHidden=true
1540 if (i < hiddenColumns.size()
1541 && hiddenColumns.get(i)[0] - 1 == blockEnd)
1543 endsAtHidden = true;
1549 // there are no hidden columns, return a single visible contig
1550 vcontigs.add(new int[] { start, end });
1551 endsAtHidden = false;
1557 LOCK.readLock().unlock();
1563 public boolean hasNext()
1565 return (currentPosition < vcontigs.size());
1571 int[] result = vcontigs.get(currentPosition);
1576 public boolean endsAtHidden()
1578 return endsAtHidden;