JAL-1834 removed quotes around truncated strings with ellipsis
[jalview.git] / src / jalview / datamodel / SequenceCollectionI.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.datamodel;
22
23 import java.util.List;
24 import java.util.Map;
25
26 public interface SequenceCollectionI
27 {
28   List<SequenceI> getSequences();
29
30   List<SequenceI> getSequences(
31           Map<SequenceI, SequenceCollectionI> hiddenReps);
32   int getWidth();
33   /**
34    * 
35    * @return true if getSeqrep doesn't return null
36    */
37   boolean hasSeqrep();
38   /**
39    * get the reference or representative sequence within this collection
40    * @return null or the current reference sequence
41    */
42   SequenceI getSeqrep();
43   /**
44    * set the reference or representative sequence for this collection. 
45    * Reference is assumed to be present within the collection.
46    * @return
47    */
48   void setSeqrep(SequenceI refseq);
49
50   /**
51    * @return the first column included in this collection. Runs from 0<=i<N_cols
52    */
53   int getStartRes();
54
55   /**
56    * 
57    * @return the last column in this collection. Runs from 0<=i<N_cols
58    */
59   int getEndRes();
60
61 }