vamsasDemo new branch
[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      * Finds sequence in alignment using full displayId as query.\r
130      *\r
131      * @param name displayId, ie <em>NAME/25-100</em>\r
132      *\r
133      * @return Sequence matching query, if found. If not found returns null.\r
134      */\r
135     public SequenceI findbyDisplayId(String name);\r
136 \r
137     /**\r
138      * Finds index of a given sequence in the alignment.\r
139      *\r
140      * @param s Sequence to look for.\r
141      *\r
142      * @return Index of sequence within the alignment.\r
143      */\r
144     public int findIndex(SequenceI s);\r
145 \r
146     /**\r
147     * All sequences will be cut from beginning to given index.\r
148     *\r
149     * @param i Remove all residues in sequences up to this column.\r
150      */\r
151     public void trimLeft(int i);\r
152 \r
153     /**\r
154      * All sequences will be cut from given index.\r
155      *\r
156      * @param i Remove all residues in sequences beyond this column.\r
157      */\r
158     public void trimRight(int i);\r
159 \r
160     /**\r
161      * Removes all columns containing entirely gap characters.\r
162      */\r
163     public void removeGaps();\r
164 \r
165     /**\r
166      * Removes redundant sequences from alignment.\r
167      *\r
168      * @param threshold Remove all sequences above the given threshold.\r
169      * @param sel Set of sequences which will have redundant sequences removed from.\r
170      *\r
171      * @return All sequences below redundancy threshold.\r
172      */\r
173     public Vector removeRedundancy(float threshold, Vector sel);\r
174 \r
175     /**\r
176      * Finds group that sequence at index i in alignment is part of.\r
177      *\r
178      * @param i Index in alignment.\r
179      *\r
180      * @return First group found for sequence at position i. WARNING :\r
181      * Sequences may be members of several groups. This method is incomplete.\r
182      */\r
183     public SequenceGroup findGroup(int i);\r
184 \r
185     /**\r
186      * Finds group that given sequence is part of.\r
187      *\r
188      * @param s Sequence in alignment.\r
189      *\r
190      * @return First group found for sequence. WARNING :\r
191      * Sequences may be members of several groups. This method is incomplete.\r
192      */\r
193     public SequenceGroup findGroup(SequenceI s);\r
194 \r
195     /**\r
196      * Finds all groups that a given sequence is part of.\r
197      *\r
198      * @param s Sequence in alignment.\r
199      *\r
200      * @return All groups containing given sequence.\r
201      */\r
202     public SequenceGroup[] findAllGroups(SequenceI s);\r
203 \r
204     /**\r
205      * Adds a new SequenceGroup to this alignment.\r
206      *\r
207      * @param sg New group to be added.\r
208      */\r
209     public void addGroup(SequenceGroup sg);\r
210 \r
211     /**\r
212      * Deletes a specific SequenceGroup\r
213      *\r
214      * @param g Group will be deleted from alignment.\r
215      */\r
216     public void deleteGroup(SequenceGroup g);\r
217 \r
218     /**\r
219      * Get all the groups associated with this alignment.\r
220      *\r
221      * @return All groups as a Vector.\r
222      */\r
223     public Vector getGroups();\r
224 \r
225     /**\r
226      * Deletes all groups from this alignment.\r
227      */\r
228     public void deleteAllGroups();\r
229 \r
230     /**\r
231      * Adds a super group. A SuperGroup is a group of groups.\r
232      *\r
233      * @param sg Adds a new SuperGroup to alignment\r
234      */\r
235     public void addSuperGroup(SuperGroup sg);\r
236 \r
237     /**\r
238      * Removes SuperGroup from alignment.\r
239      *\r
240      * @param sg This SuperGroup will be deleted from alignment.\r
241      */\r
242     public void removeSuperGroup(SuperGroup sg);\r
243 \r
244     /**\r
245      * Finds any SuperGroup that a given SequenceGroup may be part of.\r
246      *\r
247      * @param sg SequenceGroup to search for.\r
248      *\r
249      * @return SuperGroup that contains the given SequenceGroup.\r
250      */\r
251     public SuperGroup getSuperGroup(SequenceGroup sg);\r
252 \r
253     /**\r
254      * Adds a new AlignmentAnnotation to this alignment\r
255      */\r
256     public void addAnnotation(AlignmentAnnotation aa);\r
257 \r
258     /**\r
259      * Deletes a specific AlignmentAnnotation from the alignment.\r
260      *\r
261      * @param aa DOCUMENT ME!\r
262      */\r
263     public void deleteAnnotation(AlignmentAnnotation aa);\r
264 \r
265     /**\r
266      * DOCUMENT ME!\r
267      *\r
268      * @return DOCUMENT ME!\r
269      */\r
270     public AlignmentAnnotation[] getAlignmentAnnotation();\r
271 \r
272     /**\r
273      * DOCUMENT ME!\r
274      *\r
275      * @param gc DOCUMENT ME!\r
276      */\r
277     public void setGapCharacter(char gc);\r
278 \r
279     /**\r
280      * DOCUMENT ME!\r
281      *\r
282      * @return DOCUMENT ME!\r
283      */\r
284     public char getGapCharacter();\r
285 \r
286     /**\r
287      * DOCUMENT ME!\r
288      *\r
289      * @return DOCUMENT ME!\r
290      */\r
291     public Vector getAAFrequency();\r
292 \r
293     /**\r
294      * Returns true if alignment is nucleotide sequence\r
295      *\r
296      * @return DOCUMENT ME!\r
297      */\r
298     public boolean isNucleotide();\r
299 \r
300     /**\r
301      * Set true if the alignment is a nucleotide sequence\r
302      *\r
303      * @return\r
304      */\r
305     public void setNucleotide(boolean b);\r
306 \r
307 \r
308     public Alignment getDataset();\r
309 \r
310     public void setDataset(Alignment dataset);\r
311 \r
312     public Provenance getProvenance();\r
313 \r
314     public void setProvenance(Provenance prov);\r
315 \r
316 }\r