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