JAL-2909 Tidy up bam file cigar code
[jalview.git] / src / jalview / api / AlignmentRowsCollectionI.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
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.
11  *  
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.
16  * 
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.
20  */
21 package jalview.api;
22
23 import jalview.datamodel.SequenceI;
24
25 public interface AlignmentRowsCollectionI extends Iterable<Integer>
26 {
27   /**
28    * Answers if the sequence at the given position is hidden.
29    * 
30    * @param r
31    *          the row index to check
32    * @return true if the sequence at r is hidden
33    */
34   public boolean isHidden(int r);
35
36   /**
37    * Answers if any row in this collection is hidden
38    * 
39    * @return true if there is at least 1 hidden row
40    */
41   public boolean hasHidden();
42
43   /**
44    * Answers the sequence at the given position in the alignment
45    * 
46    * @param r
47    *          the row index to locate
48    * @return the sequence
49    */
50   public SequenceI getSequence(int r);
51 }