Find by displayid not used
[jalview.git] / src / jalview / datamodel / AlignmentI.java
1 /*\r
2 * Jalview - A Sequence Alignment Editor and Viewer\r
3 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
4 *\r
5 * This program is free software; you can redistribute it and/or\r
6 * modify it under the terms of the GNU General Public License\r
7 * as published by the Free Software Foundation; either version 2\r
8 * of the License, or (at your option) any later version.\r
9 *\r
10 * This program is distributed in the hope that it will be useful,\r
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
13 * GNU General Public License for more details.\r
14 *\r
15 * You should have received a copy of the GNU General Public License\r
16 * along with this program; if not, write to the Free Software\r
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
18 */\r
19 package jalview.datamodel;\r
20 \r
21 import java.util.*;\r
22 \r
23 \r
24 /** Data structure to hold and manipulate a multiple sequence alignment\r
25  */\r
26 public interface AlignmentI\r
27 {\r
28     /**\r
29      *  Calculates the number of sequences in an alignment\r
30      *\r
31      * @return Number of sequences in alignment\r
32      */\r
33     public int getHeight();\r
34 \r
35     /**\r
36      * Calculates the maximum width of the alignment, including gaps.\r
37      *\r
38      * @return Greatest sequence length within alignment.\r
39      */\r
40     public int getWidth();\r
41 \r
42     /**\r
43      * Calculates the longest sequence Id of the alignment\r
44      *\r
45      * @return Number of characters in longest sequence Id.\r
46      */\r
47     public int getMaxIdLength();\r
48 \r
49     /**\r
50      * Calculates if this set of sequences is all the same length\r
51      *\r
52      * @return true if all sequences in alignment are the same length\r
53      */\r
54     public boolean isAligned();\r
55 \r
56     /**\r
57      * Gets sequences as a Vector\r
58      *\r
59      * @return All sequences in alignment.\r
60      */\r
61     public Vector getSequences();\r
62 \r
63     /**\r
64      * Find a specific sequence in this alignment.\r
65      *\r
66      * @param i Index of required sequence.\r
67      *\r
68      * @return SequenceI at given index.\r
69      */\r
70     public SequenceI getSequenceAt(int i);\r
71 \r
72     /**\r
73      * Add a new sequence to this alignment.\r
74      *\r
75      * @param seq New sequence will be added at end of alignment.\r
76      */\r
77     public void addSequence(SequenceI seq);\r
78 \r
79     /**\r
80      * Used to set a particular index of the alignment with the given sequence.\r
81      *\r
82      * @param i Index of sequence to be updated.\r
83      * @param seq New sequence to be inserted.\r
84      */\r
85     public void setSequenceAt(int i, SequenceI seq);\r
86 \r
87     /**\r
88      * Deletes a sequence from the alignment.\r
89      *\r
90      * @param s Sequence to be deleted.\r
91      */\r
92     public void deleteSequence(SequenceI s);\r
93 \r
94     /**\r
95      * Deletes a sequence from the alignment.\r
96      *\r
97      * @param i Index of sequence to be deleted.\r
98      */\r
99     public void deleteSequence(int i);\r
100 \r
101     /**\r
102      * Deletes all residues in every sequence of alignment within given columns.\r
103      *\r
104      * @param start Start index of columns to delete.\r
105      * @param end End index to columns to delete.\r
106      */\r
107     public void deleteColumns(int start, int end);\r
108 \r
109     /**\r
110      * Deletes all residues in every sequence of alignment within given columns.\r
111      *\r
112      * @param seq1 Index of first sequence to delete columns from.\r
113      * @param seq2 Index of last sequence to delete columns from.\r
114      * @param start Start index of columns to delete.\r
115      * @param end End index of columns to delete.\r
116      */\r
117     public void deleteColumns(int seq1, int seq2, int start, int end);\r
118 \r
119     /**\r
120      * Finds sequence in alignment using sequence name as query.\r
121      *\r
122      * @param name Id of sequence to search for.\r
123      *\r
124      * @return Sequence matching query, if found. If not found returns null.\r
125      */\r
126     public SequenceI findName(String name);\r
127 \r
128 \r
129     /**\r
130      * Finds index of a given sequence in the alignment.\r
131      *\r
132      * @param s Sequence to look for.\r
133      *\r
134      * @return Index of sequence within the alignment.\r
135      */\r
136     public int findIndex(SequenceI s);\r
137 \r
138     /**\r
139     * All sequences will be cut from beginning to given index.\r
140     *\r
141     * @param i Remove all residues in sequences up to this column.\r
142      */\r
143     public void trimLeft(int i);\r
144 \r
145     /**\r
146      * All sequences will be cut from given index.\r
147      *\r
148      * @param i Remove all residues in sequences beyond this column.\r
149      */\r
150     public void trimRight(int i);\r
151 \r
152     /**\r
153      * Removes all columns containing entirely gap characters.\r
154      */\r
155     public void removeGaps();\r
156 \r
157     /**\r
158      * Removes redundant sequences from alignment.\r
159      *\r
160      * @param threshold Remove all sequences above the given threshold.\r
161      * @param sel Set of sequences which will have redundant sequences removed from.\r
162      *\r
163      * @return All sequences below redundancy threshold.\r
164      */\r
165     public Vector removeRedundancy(float threshold, Vector sel);\r
166 \r
167     /**\r
168      * Finds group that sequence at index i in alignment is part of.\r
169      *\r
170      * @param i Index in alignment.\r
171      *\r
172      * @return First group found for sequence at position i. WARNING :\r
173      * Sequences may be members of several groups. This method is incomplete.\r
174      */\r
175     public SequenceGroup findGroup(int i);\r
176 \r
177     /**\r
178      * Finds group that given sequence is part of.\r
179      *\r
180      * @param s Sequence in alignment.\r
181      *\r
182      * @return First group found for sequence. WARNING :\r
183      * Sequences may be members of several groups. This method is incomplete.\r
184      */\r
185     public SequenceGroup findGroup(SequenceI s);\r
186 \r
187     /**\r
188      * Finds all groups that a given sequence is part of.\r
189      *\r
190      * @param s Sequence in alignment.\r
191      *\r
192      * @return All groups containing given sequence.\r
193      */\r
194     public SequenceGroup[] findAllGroups(SequenceI s);\r
195 \r
196     /**\r
197      * Adds a new SequenceGroup to this alignment.\r
198      *\r
199      * @param sg New group to be added.\r
200      */\r
201     public void addGroup(SequenceGroup sg);\r
202 \r
203     /**\r
204      * Deletes a specific SequenceGroup\r
205      *\r
206      * @param g Group will be deleted from alignment.\r
207      */\r
208     public void deleteGroup(SequenceGroup g);\r
209 \r
210     /**\r
211      * Get all the groups associated with this alignment.\r
212      *\r
213      * @return All groups as a Vector.\r
214      */\r
215     public Vector getGroups();\r
216 \r
217     /**\r
218      * Deletes all groups from this alignment.\r
219      */\r
220     public void deleteAllGroups();\r
221 \r
222     /**\r
223      * Adds a super group. A SuperGroup is a group of groups.\r
224      *\r
225      * @param sg Adds a new SuperGroup to alignment\r
226      */\r
227     public void addSuperGroup(SuperGroup sg);\r
228 \r
229     /**\r
230      * Removes SuperGroup from alignment.\r
231      *\r
232      * @param sg This SuperGroup will be deleted from alignment.\r
233      */\r
234     public void removeSuperGroup(SuperGroup sg);\r
235 \r
236     /**\r
237      * Finds any SuperGroup that a given SequenceGroup may be part of.\r
238      *\r
239      * @param sg SequenceGroup to search for.\r
240      *\r
241      * @return SuperGroup that contains the given SequenceGroup.\r
242      */\r
243     public SuperGroup getSuperGroup(SequenceGroup sg);\r
244 \r
245     /**\r
246      * Adds a new AlignmentAnnotation to this alignment\r
247      */\r
248     public void addAnnotation(AlignmentAnnotation aa);\r
249 \r
250     /**\r
251      * Deletes a specific AlignmentAnnotation from the alignment.\r
252      *\r
253      * @param aa DOCUMENT ME!\r
254      */\r
255     public void deleteAnnotation(AlignmentAnnotation aa);\r
256 \r
257     /**\r
258      * DOCUMENT ME!\r
259      *\r
260      * @return DOCUMENT ME!\r
261      */\r
262     public AlignmentAnnotation[] getAlignmentAnnotation();\r
263 \r
264     /**\r
265      * DOCUMENT ME!\r
266      *\r
267      * @param gc DOCUMENT ME!\r
268      */\r
269     public void setGapCharacter(char gc);\r
270 \r
271     /**\r
272      * DOCUMENT ME!\r
273      *\r
274      * @return DOCUMENT ME!\r
275      */\r
276     public char getGapCharacter();\r
277 \r
278     /**\r
279      * DOCUMENT ME!\r
280      *\r
281      * @return DOCUMENT ME!\r
282      */\r
283     public Vector getAAFrequency();\r
284 \r
285     /**\r
286      * Returns true if alignment is nucleotide sequence\r
287      *\r
288      * @return DOCUMENT ME!\r
289      */\r
290     public boolean isNucleotide();\r
291 \r
292     /**\r
293      * Set true if the alignment is a nucleotide sequence\r
294      *\r
295      * @return\r
296      */\r
297     public void setNucleotide(boolean b);\r
298 \r
299 \r
300     public Alignment getDataset();\r
301 \r
302     public void setDataset(Alignment dataset);\r
303 \r
304     public Provenance getProvenance();\r
305 \r
306     public void setProvenance(Provenance prov);\r
307 \r
308 }\r