added help and documentation for annotation editing.
[jalview.git] / src / jalview / binding / VAMSAS.java
1 /*\r
2  * This class was automatically generated with\r
3  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
4  * Schema.\r
5  * $Id$\r
6  */\r
7 \r
8 package jalview.binding;\r
9 \r
10 //---------------------------------/\r
11 //- Imported classes and packages -/\r
12 //---------------------------------/\r
13 \r
14 import java.util.*;\r
15 \r
16 import org.exolab.castor.xml.*;\r
17 \r
18 /**\r
19  * Class VAMSAS.\r
20  *\r
21  * @version $Revision$ $Date$\r
22  */\r
23 public class VAMSAS\r
24     implements java.io.Serializable\r
25 {\r
26 \r
27   //--------------------------/\r
28   //- Class/Member Variables -/\r
29   //--------------------------/\r
30 \r
31   /**\r
32    * Field _alignmentList\r
33    */\r
34   private java.util.Vector _alignmentList;\r
35 \r
36   /**\r
37    * Field _treeList\r
38    */\r
39   private java.util.Vector _treeList;\r
40 \r
41   /**\r
42    * Field _sequenceSetList\r
43    */\r
44   private java.util.Vector _sequenceSetList;\r
45 \r
46   //----------------/\r
47   //- Constructors -/\r
48   //----------------/\r
49 \r
50   public VAMSAS()\r
51   {\r
52     super();\r
53     _alignmentList = new Vector();\r
54     _treeList = new Vector();\r
55     _sequenceSetList = new Vector();\r
56   } //-- jalview.binding.VAMSAS()\r
57 \r
58   //-----------/\r
59   //- Methods -/\r
60   //-----------/\r
61 \r
62   /**\r
63    * Method addAlignment\r
64    *\r
65    *\r
66    *\r
67    * @param vAlignment\r
68    */\r
69   public void addAlignment(jalview.binding.Alignment vAlignment)\r
70       throws java.lang.IndexOutOfBoundsException\r
71   {\r
72     _alignmentList.addElement(vAlignment);\r
73   } //-- void addAlignment(jalview.binding.Alignment)\r
74 \r
75   /**\r
76    * Method addAlignment\r
77    *\r
78    *\r
79    *\r
80    * @param index\r
81    * @param vAlignment\r
82    */\r
83   public void addAlignment(int index, jalview.binding.Alignment vAlignment)\r
84       throws java.lang.IndexOutOfBoundsException\r
85   {\r
86     _alignmentList.insertElementAt(vAlignment, index);\r
87   } //-- void addAlignment(int, jalview.binding.Alignment)\r
88 \r
89   /**\r
90    * Method addSequenceSet\r
91    *\r
92    *\r
93    *\r
94    * @param vSequenceSet\r
95    */\r
96   public void addSequenceSet(jalview.binding.SequenceSet vSequenceSet)\r
97       throws java.lang.IndexOutOfBoundsException\r
98   {\r
99     _sequenceSetList.addElement(vSequenceSet);\r
100   } //-- void addSequenceSet(jalview.binding.SequenceSet)\r
101 \r
102   /**\r
103    * Method addSequenceSet\r
104    *\r
105    *\r
106    *\r
107    * @param index\r
108    * @param vSequenceSet\r
109    */\r
110   public void addSequenceSet(int index,\r
111                              jalview.binding.SequenceSet vSequenceSet)\r
112       throws java.lang.IndexOutOfBoundsException\r
113   {\r
114     _sequenceSetList.insertElementAt(vSequenceSet, index);\r
115   } //-- void addSequenceSet(int, jalview.binding.SequenceSet)\r
116 \r
117   /**\r
118    * Method addTree\r
119    *\r
120    *\r
121    *\r
122    * @param vTree\r
123    */\r
124   public void addTree(java.lang.String vTree)\r
125       throws java.lang.IndexOutOfBoundsException\r
126   {\r
127     _treeList.addElement(vTree);\r
128   } //-- void addTree(java.lang.String)\r
129 \r
130   /**\r
131    * Method addTree\r
132    *\r
133    *\r
134    *\r
135    * @param index\r
136    * @param vTree\r
137    */\r
138   public void addTree(int index, java.lang.String vTree)\r
139       throws java.lang.IndexOutOfBoundsException\r
140   {\r
141     _treeList.insertElementAt(vTree, index);\r
142   } //-- void addTree(int, java.lang.String)\r
143 \r
144   /**\r
145    * Method enumerateAlignment\r
146    *\r
147    *\r
148    *\r
149    * @return Enumeration\r
150    */\r
151   public java.util.Enumeration enumerateAlignment()\r
152   {\r
153     return _alignmentList.elements();\r
154   } //-- java.util.Enumeration enumerateAlignment()\r
155 \r
156   /**\r
157    * Method enumerateSequenceSet\r
158    *\r
159    *\r
160    *\r
161    * @return Enumeration\r
162    */\r
163   public java.util.Enumeration enumerateSequenceSet()\r
164   {\r
165     return _sequenceSetList.elements();\r
166   } //-- java.util.Enumeration enumerateSequenceSet()\r
167 \r
168   /**\r
169    * Method enumerateTree\r
170    *\r
171    *\r
172    *\r
173    * @return Enumeration\r
174    */\r
175   public java.util.Enumeration enumerateTree()\r
176   {\r
177     return _treeList.elements();\r
178   } //-- java.util.Enumeration enumerateTree()\r
179 \r
180   /**\r
181    * Method getAlignment\r
182    *\r
183    *\r
184    *\r
185    * @param index\r
186    * @return Alignment\r
187    */\r
188   public jalview.binding.Alignment getAlignment(int index)\r
189       throws java.lang.IndexOutOfBoundsException\r
190   {\r
191     //-- check bounds for index\r
192     if ( (index < 0) || (index > _alignmentList.size()))\r
193     {\r
194       throw new IndexOutOfBoundsException();\r
195     }\r
196 \r
197     return (jalview.binding.Alignment) _alignmentList.elementAt(index);\r
198   } //-- jalview.binding.Alignment getAlignment(int)\r
199 \r
200   /**\r
201    * Method getAlignment\r
202    *\r
203    *\r
204    *\r
205    * @return Alignment\r
206    */\r
207   public jalview.binding.Alignment[] getAlignment()\r
208   {\r
209     int size = _alignmentList.size();\r
210     jalview.binding.Alignment[] mArray = new jalview.binding.Alignment[size];\r
211     for (int index = 0; index < size; index++)\r
212     {\r
213       mArray[index] = (jalview.binding.Alignment) _alignmentList.elementAt(\r
214           index);\r
215     }\r
216     return mArray;\r
217   } //-- jalview.binding.Alignment[] getAlignment()\r
218 \r
219   /**\r
220    * Method getAlignmentCount\r
221    *\r
222    *\r
223    *\r
224    * @return int\r
225    */\r
226   public int getAlignmentCount()\r
227   {\r
228     return _alignmentList.size();\r
229   } //-- int getAlignmentCount()\r
230 \r
231   /**\r
232    * Method getSequenceSet\r
233    *\r
234    *\r
235    *\r
236    * @param index\r
237    * @return SequenceSet\r
238    */\r
239   public jalview.binding.SequenceSet getSequenceSet(int index)\r
240       throws java.lang.IndexOutOfBoundsException\r
241   {\r
242     //-- check bounds for index\r
243     if ( (index < 0) || (index > _sequenceSetList.size()))\r
244     {\r
245       throw new IndexOutOfBoundsException();\r
246     }\r
247 \r
248     return (jalview.binding.SequenceSet) _sequenceSetList.elementAt(index);\r
249   } //-- jalview.binding.SequenceSet getSequenceSet(int)\r
250 \r
251   /**\r
252    * Method getSequenceSet\r
253    *\r
254    *\r
255    *\r
256    * @return SequenceSet\r
257    */\r
258   public jalview.binding.SequenceSet[] getSequenceSet()\r
259   {\r
260     int size = _sequenceSetList.size();\r
261     jalview.binding.SequenceSet[] mArray = new jalview.binding.SequenceSet[size];\r
262     for (int index = 0; index < size; index++)\r
263     {\r
264       mArray[index] = (jalview.binding.SequenceSet) _sequenceSetList.elementAt(\r
265           index);\r
266     }\r
267     return mArray;\r
268   } //-- jalview.binding.SequenceSet[] getSequenceSet()\r
269 \r
270   /**\r
271    * Method getSequenceSetCount\r
272    *\r
273    *\r
274    *\r
275    * @return int\r
276    */\r
277   public int getSequenceSetCount()\r
278   {\r
279     return _sequenceSetList.size();\r
280   } //-- int getSequenceSetCount()\r
281 \r
282   /**\r
283    * Method getTree\r
284    *\r
285    *\r
286    *\r
287    * @param index\r
288    * @return String\r
289    */\r
290   public java.lang.String getTree(int index)\r
291       throws java.lang.IndexOutOfBoundsException\r
292   {\r
293     //-- check bounds for index\r
294     if ( (index < 0) || (index > _treeList.size()))\r
295     {\r
296       throw new IndexOutOfBoundsException();\r
297     }\r
298 \r
299     return (String) _treeList.elementAt(index);\r
300   } //-- java.lang.String getTree(int)\r
301 \r
302   /**\r
303    * Method getTree\r
304    *\r
305    *\r
306    *\r
307    * @return String\r
308    */\r
309   public java.lang.String[] getTree()\r
310   {\r
311     int size = _treeList.size();\r
312     java.lang.String[] mArray = new java.lang.String[size];\r
313     for (int index = 0; index < size; index++)\r
314     {\r
315       mArray[index] = (String) _treeList.elementAt(index);\r
316     }\r
317     return mArray;\r
318   } //-- java.lang.String[] getTree()\r
319 \r
320   /**\r
321    * Method getTreeCount\r
322    *\r
323    *\r
324    *\r
325    * @return int\r
326    */\r
327   public int getTreeCount()\r
328   {\r
329     return _treeList.size();\r
330   } //-- int getTreeCount()\r
331 \r
332   /**\r
333    * Method isValid\r
334    *\r
335    *\r
336    *\r
337    * @return boolean\r
338    */\r
339   public boolean isValid()\r
340   {\r
341     try\r
342     {\r
343       validate();\r
344     }\r
345     catch (org.exolab.castor.xml.ValidationException vex)\r
346     {\r
347       return false;\r
348     }\r
349     return true;\r
350   } //-- boolean isValid()\r
351 \r
352   /**\r
353    * Method marshal\r
354    *\r
355    *\r
356    *\r
357    * @param out\r
358    */\r
359   public void marshal(java.io.Writer out)\r
360       throws org.exolab.castor.xml.MarshalException,\r
361       org.exolab.castor.xml.ValidationException\r
362   {\r
363 \r
364     Marshaller.marshal(this, out);\r
365   } //-- void marshal(java.io.Writer)\r
366 \r
367   /**\r
368    * Method marshal\r
369    *\r
370    *\r
371    *\r
372    * @param handler\r
373    */\r
374   public void marshal(org.xml.sax.ContentHandler handler)\r
375       throws java.io.IOException, org.exolab.castor.xml.MarshalException,\r
376       org.exolab.castor.xml.ValidationException\r
377   {\r
378 \r
379     Marshaller.marshal(this, handler);\r
380   } //-- void marshal(org.xml.sax.ContentHandler)\r
381 \r
382   /**\r
383    * Method removeAlignment\r
384    *\r
385    *\r
386    *\r
387    * @param index\r
388    * @return Alignment\r
389    */\r
390   public jalview.binding.Alignment removeAlignment(int index)\r
391   {\r
392     java.lang.Object obj = _alignmentList.elementAt(index);\r
393     _alignmentList.removeElementAt(index);\r
394     return (jalview.binding.Alignment) obj;\r
395   } //-- jalview.binding.Alignment removeAlignment(int)\r
396 \r
397   /**\r
398    * Method removeAllAlignment\r
399    *\r
400    */\r
401   public void removeAllAlignment()\r
402   {\r
403     _alignmentList.removeAllElements();\r
404   } //-- void removeAllAlignment()\r
405 \r
406   /**\r
407    * Method removeAllSequenceSet\r
408    *\r
409    */\r
410   public void removeAllSequenceSet()\r
411   {\r
412     _sequenceSetList.removeAllElements();\r
413   } //-- void removeAllSequenceSet()\r
414 \r
415   /**\r
416    * Method removeAllTree\r
417    *\r
418    */\r
419   public void removeAllTree()\r
420   {\r
421     _treeList.removeAllElements();\r
422   } //-- void removeAllTree()\r
423 \r
424   /**\r
425    * Method removeSequenceSet\r
426    *\r
427    *\r
428    *\r
429    * @param index\r
430    * @return SequenceSet\r
431    */\r
432   public jalview.binding.SequenceSet removeSequenceSet(int index)\r
433   {\r
434     java.lang.Object obj = _sequenceSetList.elementAt(index);\r
435     _sequenceSetList.removeElementAt(index);\r
436     return (jalview.binding.SequenceSet) obj;\r
437   } //-- jalview.binding.SequenceSet removeSequenceSet(int)\r
438 \r
439   /**\r
440    * Method removeTree\r
441    *\r
442    *\r
443    *\r
444    * @param index\r
445    * @return String\r
446    */\r
447   public java.lang.String removeTree(int index)\r
448   {\r
449     java.lang.Object obj = _treeList.elementAt(index);\r
450     _treeList.removeElementAt(index);\r
451     return (String) obj;\r
452   } //-- java.lang.String removeTree(int)\r
453 \r
454   /**\r
455    * Method setAlignment\r
456    *\r
457    *\r
458    *\r
459    * @param index\r
460    * @param vAlignment\r
461    */\r
462   public void setAlignment(int index, jalview.binding.Alignment vAlignment)\r
463       throws java.lang.IndexOutOfBoundsException\r
464   {\r
465     //-- check bounds for index\r
466     if ( (index < 0) || (index > _alignmentList.size()))\r
467     {\r
468       throw new IndexOutOfBoundsException();\r
469     }\r
470     _alignmentList.setElementAt(vAlignment, index);\r
471   } //-- void setAlignment(int, jalview.binding.Alignment)\r
472 \r
473   /**\r
474    * Method setAlignment\r
475    *\r
476    *\r
477    *\r
478    * @param alignmentArray\r
479    */\r
480   public void setAlignment(jalview.binding.Alignment[] alignmentArray)\r
481   {\r
482     //-- copy array\r
483     _alignmentList.removeAllElements();\r
484     for (int i = 0; i < alignmentArray.length; i++)\r
485     {\r
486       _alignmentList.addElement(alignmentArray[i]);\r
487     }\r
488   } //-- void setAlignment(jalview.binding.Alignment)\r
489 \r
490   /**\r
491    * Method setSequenceSet\r
492    *\r
493    *\r
494    *\r
495    * @param index\r
496    * @param vSequenceSet\r
497    */\r
498   public void setSequenceSet(int index,\r
499                              jalview.binding.SequenceSet vSequenceSet)\r
500       throws java.lang.IndexOutOfBoundsException\r
501   {\r
502     //-- check bounds for index\r
503     if ( (index < 0) || (index > _sequenceSetList.size()))\r
504     {\r
505       throw new IndexOutOfBoundsException();\r
506     }\r
507     _sequenceSetList.setElementAt(vSequenceSet, index);\r
508   } //-- void setSequenceSet(int, jalview.binding.SequenceSet)\r
509 \r
510   /**\r
511    * Method setSequenceSet\r
512    *\r
513    *\r
514    *\r
515    * @param sequenceSetArray\r
516    */\r
517   public void setSequenceSet(jalview.binding.SequenceSet[] sequenceSetArray)\r
518   {\r
519     //-- copy array\r
520     _sequenceSetList.removeAllElements();\r
521     for (int i = 0; i < sequenceSetArray.length; i++)\r
522     {\r
523       _sequenceSetList.addElement(sequenceSetArray[i]);\r
524     }\r
525   } //-- void setSequenceSet(jalview.binding.SequenceSet)\r
526 \r
527   /**\r
528    * Method setTree\r
529    *\r
530    *\r
531    *\r
532    * @param index\r
533    * @param vTree\r
534    */\r
535   public void setTree(int index, java.lang.String vTree)\r
536       throws java.lang.IndexOutOfBoundsException\r
537   {\r
538     //-- check bounds for index\r
539     if ( (index < 0) || (index > _treeList.size()))\r
540     {\r
541       throw new IndexOutOfBoundsException();\r
542     }\r
543     _treeList.setElementAt(vTree, index);\r
544   } //-- void setTree(int, java.lang.String)\r
545 \r
546   /**\r
547    * Method setTree\r
548    *\r
549    *\r
550    *\r
551    * @param treeArray\r
552    */\r
553   public void setTree(java.lang.String[] treeArray)\r
554   {\r
555     //-- copy array\r
556     _treeList.removeAllElements();\r
557     for (int i = 0; i < treeArray.length; i++)\r
558     {\r
559       _treeList.addElement(treeArray[i]);\r
560     }\r
561   } //-- void setTree(java.lang.String)\r
562 \r
563   /**\r
564    * Method unmarshal\r
565    *\r
566    *\r
567    *\r
568    * @param reader\r
569    * @return Object\r
570    */\r
571   public static java.lang.Object unmarshal(java.io.Reader reader)\r
572       throws org.exolab.castor.xml.MarshalException,\r
573       org.exolab.castor.xml.ValidationException\r
574   {\r
575     return (jalview.binding.VAMSAS) Unmarshaller.unmarshal(jalview.binding.\r
576         VAMSAS.class, reader);\r
577   } //-- java.lang.Object unmarshal(java.io.Reader)\r
578 \r
579   /**\r
580    * Method validate\r
581    *\r
582    */\r
583   public void validate()\r
584       throws org.exolab.castor.xml.ValidationException\r
585   {\r
586     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.\r
587         Validator();\r
588     validator.validate(this);\r
589   } //-- void validate()\r
590 \r
591 }\r