jalview XML schema update for 2.4.1 (or 2.5?) introducing IDs for views and treepanel...
[jalview.git] / src / jalview / schemabinding / version2 / JGroup.java
1 /*\r
2  * This class was automatically generated with \r
3  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
4  * Schema.\r
5  * $Id$\r
6  */\r
7 \r
8 package jalview.schemabinding.version2;\r
9 \r
10   //---------------------------------/\r
11  //- Imported classes and packages -/\r
12 //---------------------------------/\r
13 \r
14 import org.exolab.castor.xml.Marshaller;\r
15 import org.exolab.castor.xml.Unmarshaller;\r
16 \r
17 /**\r
18  * Class JGroup.\r
19  * \r
20  * @version $Revision$ $Date$\r
21  */\r
22 public class JGroup implements java.io.Serializable {\r
23 \r
24 \r
25       //--------------------------/\r
26      //- Class/Member Variables -/\r
27     //--------------------------/\r
28 \r
29     /**\r
30      * Field _start.\r
31      */\r
32     private int _start;\r
33 \r
34     /**\r
35      * keeps track of state for field: _start\r
36      */\r
37     private boolean _has_start;\r
38 \r
39     /**\r
40      * Field _end.\r
41      */\r
42     private int _end;\r
43 \r
44     /**\r
45      * keeps track of state for field: _end\r
46      */\r
47     private boolean _has_end;\r
48 \r
49     /**\r
50      * Field _name.\r
51      */\r
52     private java.lang.String _name;\r
53 \r
54     /**\r
55      * Field _colour.\r
56      */\r
57     private java.lang.String _colour;\r
58 \r
59     /**\r
60      * Field _consThreshold.\r
61      */\r
62     private int _consThreshold;\r
63 \r
64     /**\r
65      * keeps track of state for field: _consThreshold\r
66      */\r
67     private boolean _has_consThreshold;\r
68 \r
69     /**\r
70      * Field _pidThreshold.\r
71      */\r
72     private int _pidThreshold;\r
73 \r
74     /**\r
75      * keeps track of state for field: _pidThreshold\r
76      */\r
77     private boolean _has_pidThreshold;\r
78 \r
79     /**\r
80      * Field _outlineColour.\r
81      */\r
82     private int _outlineColour;\r
83 \r
84     /**\r
85      * keeps track of state for field: _outlineColour\r
86      */\r
87     private boolean _has_outlineColour;\r
88 \r
89     /**\r
90      * Field _displayBoxes.\r
91      */\r
92     private boolean _displayBoxes;\r
93 \r
94     /**\r
95      * keeps track of state for field: _displayBoxes\r
96      */\r
97     private boolean _has_displayBoxes;\r
98 \r
99     /**\r
100      * Field _displayText.\r
101      */\r
102     private boolean _displayText;\r
103 \r
104     /**\r
105      * keeps track of state for field: _displayText\r
106      */\r
107     private boolean _has_displayText;\r
108 \r
109     /**\r
110      * Field _colourText.\r
111      */\r
112     private boolean _colourText;\r
113 \r
114     /**\r
115      * keeps track of state for field: _colourText\r
116      */\r
117     private boolean _has_colourText;\r
118 \r
119     /**\r
120      * Field _textCol1.\r
121      */\r
122     private int _textCol1;\r
123 \r
124     /**\r
125      * keeps track of state for field: _textCol1\r
126      */\r
127     private boolean _has_textCol1;\r
128 \r
129     /**\r
130      * Field _textCol2.\r
131      */\r
132     private int _textCol2;\r
133 \r
134     /**\r
135      * keeps track of state for field: _textCol2\r
136      */\r
137     private boolean _has_textCol2;\r
138 \r
139     /**\r
140      * Field _textColThreshold.\r
141      */\r
142     private int _textColThreshold;\r
143 \r
144     /**\r
145      * keeps track of state for field: _textColThreshold\r
146      */\r
147     private boolean _has_textColThreshold;\r
148 \r
149     /**\r
150      * Field _seqList.\r
151      */\r
152     private java.util.Vector _seqList;\r
153 \r
154 \r
155       //----------------/\r
156      //- Constructors -/\r
157     //----------------/\r
158 \r
159     public JGroup() {\r
160         super();\r
161         this._seqList = new java.util.Vector();\r
162     }\r
163 \r
164 \r
165       //-----------/\r
166      //- Methods -/\r
167     //-----------/\r
168 \r
169     /**\r
170      * \r
171      * \r
172      * @param vSeq\r
173      * @throws java.lang.IndexOutOfBoundsException if the index\r
174      * given is outside the bounds of the collection\r
175      */\r
176     public void addSeq(\r
177             final java.lang.String vSeq)\r
178     throws java.lang.IndexOutOfBoundsException {\r
179         this._seqList.addElement(vSeq);\r
180     }\r
181 \r
182     /**\r
183      * \r
184      * \r
185      * @param index\r
186      * @param vSeq\r
187      * @throws java.lang.IndexOutOfBoundsException if the index\r
188      * given is outside the bounds of the collection\r
189      */\r
190     public void addSeq(\r
191             final int index,\r
192             final java.lang.String vSeq)\r
193     throws java.lang.IndexOutOfBoundsException {\r
194         this._seqList.add(index, vSeq);\r
195     }\r
196 \r
197     /**\r
198      */\r
199     public void deleteColourText(\r
200     ) {\r
201         this._has_colourText= false;\r
202     }\r
203 \r
204     /**\r
205      */\r
206     public void deleteConsThreshold(\r
207     ) {\r
208         this._has_consThreshold= false;\r
209     }\r
210 \r
211     /**\r
212      */\r
213     public void deleteDisplayBoxes(\r
214     ) {\r
215         this._has_displayBoxes= false;\r
216     }\r
217 \r
218     /**\r
219      */\r
220     public void deleteDisplayText(\r
221     ) {\r
222         this._has_displayText= false;\r
223     }\r
224 \r
225     /**\r
226      */\r
227     public void deleteEnd(\r
228     ) {\r
229         this._has_end= false;\r
230     }\r
231 \r
232     /**\r
233      */\r
234     public void deleteOutlineColour(\r
235     ) {\r
236         this._has_outlineColour= false;\r
237     }\r
238 \r
239     /**\r
240      */\r
241     public void deletePidThreshold(\r
242     ) {\r
243         this._has_pidThreshold= false;\r
244     }\r
245 \r
246     /**\r
247      */\r
248     public void deleteStart(\r
249     ) {\r
250         this._has_start= false;\r
251     }\r
252 \r
253     /**\r
254      */\r
255     public void deleteTextCol1(\r
256     ) {\r
257         this._has_textCol1= false;\r
258     }\r
259 \r
260     /**\r
261      */\r
262     public void deleteTextCol2(\r
263     ) {\r
264         this._has_textCol2= false;\r
265     }\r
266 \r
267     /**\r
268      */\r
269     public void deleteTextColThreshold(\r
270     ) {\r
271         this._has_textColThreshold= false;\r
272     }\r
273 \r
274     /**\r
275      * Method enumerateSeq.\r
276      * \r
277      * @return an Enumeration over all java.lang.String elements\r
278      */\r
279     public java.util.Enumeration enumerateSeq(\r
280     ) {\r
281         return this._seqList.elements();\r
282     }\r
283 \r
284     /**\r
285      * Returns the value of field 'colour'.\r
286      * \r
287      * @return the value of field 'Colour'.\r
288      */\r
289     public java.lang.String getColour(\r
290     ) {\r
291         return this._colour;\r
292     }\r
293 \r
294     /**\r
295      * Returns the value of field 'colourText'.\r
296      * \r
297      * @return the value of field 'ColourText'.\r
298      */\r
299     public boolean getColourText(\r
300     ) {\r
301         return this._colourText;\r
302     }\r
303 \r
304     /**\r
305      * Returns the value of field 'consThreshold'.\r
306      * \r
307      * @return the value of field 'ConsThreshold'.\r
308      */\r
309     public int getConsThreshold(\r
310     ) {\r
311         return this._consThreshold;\r
312     }\r
313 \r
314     /**\r
315      * Returns the value of field 'displayBoxes'.\r
316      * \r
317      * @return the value of field 'DisplayBoxes'.\r
318      */\r
319     public boolean getDisplayBoxes(\r
320     ) {\r
321         return this._displayBoxes;\r
322     }\r
323 \r
324     /**\r
325      * Returns the value of field 'displayText'.\r
326      * \r
327      * @return the value of field 'DisplayText'.\r
328      */\r
329     public boolean getDisplayText(\r
330     ) {\r
331         return this._displayText;\r
332     }\r
333 \r
334     /**\r
335      * Returns the value of field 'end'.\r
336      * \r
337      * @return the value of field 'End'.\r
338      */\r
339     public int getEnd(\r
340     ) {\r
341         return this._end;\r
342     }\r
343 \r
344     /**\r
345      * Returns the value of field 'name'.\r
346      * \r
347      * @return the value of field 'Name'.\r
348      */\r
349     public java.lang.String getName(\r
350     ) {\r
351         return this._name;\r
352     }\r
353 \r
354     /**\r
355      * Returns the value of field 'outlineColour'.\r
356      * \r
357      * @return the value of field 'OutlineColour'.\r
358      */\r
359     public int getOutlineColour(\r
360     ) {\r
361         return this._outlineColour;\r
362     }\r
363 \r
364     /**\r
365      * Returns the value of field 'pidThreshold'.\r
366      * \r
367      * @return the value of field 'PidThreshold'.\r
368      */\r
369     public int getPidThreshold(\r
370     ) {\r
371         return this._pidThreshold;\r
372     }\r
373 \r
374     /**\r
375      * Method getSeq.\r
376      * \r
377      * @param index\r
378      * @throws java.lang.IndexOutOfBoundsException if the index\r
379      * given is outside the bounds of the collection\r
380      * @return the value of the java.lang.String at the given index\r
381      */\r
382     public java.lang.String getSeq(\r
383             final int index)\r
384     throws java.lang.IndexOutOfBoundsException {\r
385         // check bounds for index\r
386         if (index < 0 || index >= this._seqList.size()) {\r
387             throw new IndexOutOfBoundsException("getSeq: Index value '" + index + "' not in range [0.." + (this._seqList.size() - 1) + "]");\r
388         }\r
389         \r
390         return (java.lang.String) _seqList.get(index);\r
391     }\r
392 \r
393     /**\r
394      * Method getSeq.Returns the contents of the collection in an\r
395      * Array.  <p>Note:  Just in case the collection contents are\r
396      * changing in another thread, we pass a 0-length Array of the\r
397      * correct type into the API call.  This way we <i>know</i>\r
398      * that the Array returned is of exactly the correct length.\r
399      * \r
400      * @return this collection as an Array\r
401      */\r
402     public java.lang.String[] getSeq(\r
403     ) {\r
404         java.lang.String[] array = new java.lang.String[0];\r
405         return (java.lang.String[]) this._seqList.toArray(array);\r
406     }\r
407 \r
408     /**\r
409      * Method getSeqCount.\r
410      * \r
411      * @return the size of this collection\r
412      */\r
413     public int getSeqCount(\r
414     ) {\r
415         return this._seqList.size();\r
416     }\r
417 \r
418     /**\r
419      * Returns the value of field 'start'.\r
420      * \r
421      * @return the value of field 'Start'.\r
422      */\r
423     public int getStart(\r
424     ) {\r
425         return this._start;\r
426     }\r
427 \r
428     /**\r
429      * Returns the value of field 'textCol1'.\r
430      * \r
431      * @return the value of field 'TextCol1'.\r
432      */\r
433     public int getTextCol1(\r
434     ) {\r
435         return this._textCol1;\r
436     }\r
437 \r
438     /**\r
439      * Returns the value of field 'textCol2'.\r
440      * \r
441      * @return the value of field 'TextCol2'.\r
442      */\r
443     public int getTextCol2(\r
444     ) {\r
445         return this._textCol2;\r
446     }\r
447 \r
448     /**\r
449      * Returns the value of field 'textColThreshold'.\r
450      * \r
451      * @return the value of field 'TextColThreshold'.\r
452      */\r
453     public int getTextColThreshold(\r
454     ) {\r
455         return this._textColThreshold;\r
456     }\r
457 \r
458     /**\r
459      * Method hasColourText.\r
460      * \r
461      * @return true if at least one ColourText has been added\r
462      */\r
463     public boolean hasColourText(\r
464     ) {\r
465         return this._has_colourText;\r
466     }\r
467 \r
468     /**\r
469      * Method hasConsThreshold.\r
470      * \r
471      * @return true if at least one ConsThreshold has been added\r
472      */\r
473     public boolean hasConsThreshold(\r
474     ) {\r
475         return this._has_consThreshold;\r
476     }\r
477 \r
478     /**\r
479      * Method hasDisplayBoxes.\r
480      * \r
481      * @return true if at least one DisplayBoxes has been added\r
482      */\r
483     public boolean hasDisplayBoxes(\r
484     ) {\r
485         return this._has_displayBoxes;\r
486     }\r
487 \r
488     /**\r
489      * Method hasDisplayText.\r
490      * \r
491      * @return true if at least one DisplayText has been added\r
492      */\r
493     public boolean hasDisplayText(\r
494     ) {\r
495         return this._has_displayText;\r
496     }\r
497 \r
498     /**\r
499      * Method hasEnd.\r
500      * \r
501      * @return true if at least one End has been added\r
502      */\r
503     public boolean hasEnd(\r
504     ) {\r
505         return this._has_end;\r
506     }\r
507 \r
508     /**\r
509      * Method hasOutlineColour.\r
510      * \r
511      * @return true if at least one OutlineColour has been added\r
512      */\r
513     public boolean hasOutlineColour(\r
514     ) {\r
515         return this._has_outlineColour;\r
516     }\r
517 \r
518     /**\r
519      * Method hasPidThreshold.\r
520      * \r
521      * @return true if at least one PidThreshold has been added\r
522      */\r
523     public boolean hasPidThreshold(\r
524     ) {\r
525         return this._has_pidThreshold;\r
526     }\r
527 \r
528     /**\r
529      * Method hasStart.\r
530      * \r
531      * @return true if at least one Start has been added\r
532      */\r
533     public boolean hasStart(\r
534     ) {\r
535         return this._has_start;\r
536     }\r
537 \r
538     /**\r
539      * Method hasTextCol1.\r
540      * \r
541      * @return true if at least one TextCol1 has been added\r
542      */\r
543     public boolean hasTextCol1(\r
544     ) {\r
545         return this._has_textCol1;\r
546     }\r
547 \r
548     /**\r
549      * Method hasTextCol2.\r
550      * \r
551      * @return true if at least one TextCol2 has been added\r
552      */\r
553     public boolean hasTextCol2(\r
554     ) {\r
555         return this._has_textCol2;\r
556     }\r
557 \r
558     /**\r
559      * Method hasTextColThreshold.\r
560      * \r
561      * @return true if at least one TextColThreshold has been added\r
562      */\r
563     public boolean hasTextColThreshold(\r
564     ) {\r
565         return this._has_textColThreshold;\r
566     }\r
567 \r
568     /**\r
569      * Returns the value of field 'colourText'.\r
570      * \r
571      * @return the value of field 'ColourText'.\r
572      */\r
573     public boolean isColourText(\r
574     ) {\r
575         return this._colourText;\r
576     }\r
577 \r
578     /**\r
579      * Returns the value of field 'displayBoxes'.\r
580      * \r
581      * @return the value of field 'DisplayBoxes'.\r
582      */\r
583     public boolean isDisplayBoxes(\r
584     ) {\r
585         return this._displayBoxes;\r
586     }\r
587 \r
588     /**\r
589      * Returns the value of field 'displayText'.\r
590      * \r
591      * @return the value of field 'DisplayText'.\r
592      */\r
593     public boolean isDisplayText(\r
594     ) {\r
595         return this._displayText;\r
596     }\r
597 \r
598     /**\r
599      * Method isValid.\r
600      * \r
601      * @return true if this object is valid according to the schema\r
602      */\r
603     public boolean isValid(\r
604     ) {\r
605         try {\r
606             validate();\r
607         } catch (org.exolab.castor.xml.ValidationException vex) {\r
608             return false;\r
609         }\r
610         return true;\r
611     }\r
612 \r
613     /**\r
614      * \r
615      * \r
616      * @param out\r
617      * @throws org.exolab.castor.xml.MarshalException if object is\r
618      * null or if any SAXException is thrown during marshaling\r
619      * @throws org.exolab.castor.xml.ValidationException if this\r
620      * object is an invalid instance according to the schema\r
621      */\r
622     public void marshal(\r
623             final java.io.Writer out)\r
624     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
625         Marshaller.marshal(this, out);\r
626     }\r
627 \r
628     /**\r
629      * \r
630      * \r
631      * @param handler\r
632      * @throws java.io.IOException if an IOException occurs during\r
633      * marshaling\r
634      * @throws org.exolab.castor.xml.ValidationException if this\r
635      * object is an invalid instance according to the schema\r
636      * @throws org.exolab.castor.xml.MarshalException if object is\r
637      * null or if any SAXException is thrown during marshaling\r
638      */\r
639     public void marshal(\r
640             final org.xml.sax.ContentHandler handler)\r
641     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
642         Marshaller.marshal(this, handler);\r
643     }\r
644 \r
645     /**\r
646      */\r
647     public void removeAllSeq(\r
648     ) {\r
649         this._seqList.clear();\r
650     }\r
651 \r
652     /**\r
653      * Method removeSeq.\r
654      * \r
655      * @param vSeq\r
656      * @return true if the object was removed from the collection.\r
657      */\r
658     public boolean removeSeq(\r
659             final java.lang.String vSeq) {\r
660         boolean removed = _seqList.remove(vSeq);\r
661         return removed;\r
662     }\r
663 \r
664     /**\r
665      * Method removeSeqAt.\r
666      * \r
667      * @param index\r
668      * @return the element removed from the collection\r
669      */\r
670     public java.lang.String removeSeqAt(\r
671             final int index) {\r
672         java.lang.Object obj = this._seqList.remove(index);\r
673         return (java.lang.String) obj;\r
674     }\r
675 \r
676     /**\r
677      * Sets the value of field 'colour'.\r
678      * \r
679      * @param colour the value of field 'colour'.\r
680      */\r
681     public void setColour(\r
682             final java.lang.String colour) {\r
683         this._colour = colour;\r
684     }\r
685 \r
686     /**\r
687      * Sets the value of field 'colourText'.\r
688      * \r
689      * @param colourText the value of field 'colourText'.\r
690      */\r
691     public void setColourText(\r
692             final boolean colourText) {\r
693         this._colourText = colourText;\r
694         this._has_colourText = true;\r
695     }\r
696 \r
697     /**\r
698      * Sets the value of field 'consThreshold'.\r
699      * \r
700      * @param consThreshold the value of field 'consThreshold'.\r
701      */\r
702     public void setConsThreshold(\r
703             final int consThreshold) {\r
704         this._consThreshold = consThreshold;\r
705         this._has_consThreshold = true;\r
706     }\r
707 \r
708     /**\r
709      * Sets the value of field 'displayBoxes'.\r
710      * \r
711      * @param displayBoxes the value of field 'displayBoxes'.\r
712      */\r
713     public void setDisplayBoxes(\r
714             final boolean displayBoxes) {\r
715         this._displayBoxes = displayBoxes;\r
716         this._has_displayBoxes = true;\r
717     }\r
718 \r
719     /**\r
720      * Sets the value of field 'displayText'.\r
721      * \r
722      * @param displayText the value of field 'displayText'.\r
723      */\r
724     public void setDisplayText(\r
725             final boolean displayText) {\r
726         this._displayText = displayText;\r
727         this._has_displayText = true;\r
728     }\r
729 \r
730     /**\r
731      * Sets the value of field 'end'.\r
732      * \r
733      * @param end the value of field 'end'.\r
734      */\r
735     public void setEnd(\r
736             final int end) {\r
737         this._end = end;\r
738         this._has_end = true;\r
739     }\r
740 \r
741     /**\r
742      * Sets the value of field 'name'.\r
743      * \r
744      * @param name the value of field 'name'.\r
745      */\r
746     public void setName(\r
747             final java.lang.String name) {\r
748         this._name = name;\r
749     }\r
750 \r
751     /**\r
752      * Sets the value of field 'outlineColour'.\r
753      * \r
754      * @param outlineColour the value of field 'outlineColour'.\r
755      */\r
756     public void setOutlineColour(\r
757             final int outlineColour) {\r
758         this._outlineColour = outlineColour;\r
759         this._has_outlineColour = true;\r
760     }\r
761 \r
762     /**\r
763      * Sets the value of field 'pidThreshold'.\r
764      * \r
765      * @param pidThreshold the value of field 'pidThreshold'.\r
766      */\r
767     public void setPidThreshold(\r
768             final int pidThreshold) {\r
769         this._pidThreshold = pidThreshold;\r
770         this._has_pidThreshold = true;\r
771     }\r
772 \r
773     /**\r
774      * \r
775      * \r
776      * @param index\r
777      * @param vSeq\r
778      * @throws java.lang.IndexOutOfBoundsException if the index\r
779      * given is outside the bounds of the collection\r
780      */\r
781     public void setSeq(\r
782             final int index,\r
783             final java.lang.String vSeq)\r
784     throws java.lang.IndexOutOfBoundsException {\r
785         // check bounds for index\r
786         if (index < 0 || index >= this._seqList.size()) {\r
787             throw new IndexOutOfBoundsException("setSeq: Index value '" + index + "' not in range [0.." + (this._seqList.size() - 1) + "]");\r
788         }\r
789         \r
790         this._seqList.set(index, vSeq);\r
791     }\r
792 \r
793     /**\r
794      * \r
795      * \r
796      * @param vSeqArray\r
797      */\r
798     public void setSeq(\r
799             final java.lang.String[] vSeqArray) {\r
800         //-- copy array\r
801         _seqList.clear();\r
802         \r
803         for (int i = 0; i < vSeqArray.length; i++) {\r
804                 this._seqList.add(vSeqArray[i]);\r
805         }\r
806     }\r
807 \r
808     /**\r
809      * Sets the value of field 'start'.\r
810      * \r
811      * @param start the value of field 'start'.\r
812      */\r
813     public void setStart(\r
814             final int start) {\r
815         this._start = start;\r
816         this._has_start = true;\r
817     }\r
818 \r
819     /**\r
820      * Sets the value of field 'textCol1'.\r
821      * \r
822      * @param textCol1 the value of field 'textCol1'.\r
823      */\r
824     public void setTextCol1(\r
825             final int textCol1) {\r
826         this._textCol1 = textCol1;\r
827         this._has_textCol1 = true;\r
828     }\r
829 \r
830     /**\r
831      * Sets the value of field 'textCol2'.\r
832      * \r
833      * @param textCol2 the value of field 'textCol2'.\r
834      */\r
835     public void setTextCol2(\r
836             final int textCol2) {\r
837         this._textCol2 = textCol2;\r
838         this._has_textCol2 = true;\r
839     }\r
840 \r
841     /**\r
842      * Sets the value of field 'textColThreshold'.\r
843      * \r
844      * @param textColThreshold the value of field 'textColThreshold'\r
845      */\r
846     public void setTextColThreshold(\r
847             final int textColThreshold) {\r
848         this._textColThreshold = textColThreshold;\r
849         this._has_textColThreshold = true;\r
850     }\r
851 \r
852     /**\r
853      * Method unmarshal.\r
854      * \r
855      * @param reader\r
856      * @throws org.exolab.castor.xml.MarshalException if object is\r
857      * null or if any SAXException is thrown during marshaling\r
858      * @throws org.exolab.castor.xml.ValidationException if this\r
859      * object is an invalid instance according to the schema\r
860      * @return the unmarshaled jalview.schemabinding.version2.JGroup\r
861      */\r
862     public static jalview.schemabinding.version2.JGroup unmarshal(\r
863             final java.io.Reader reader)\r
864     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
865         return (jalview.schemabinding.version2.JGroup) Unmarshaller.unmarshal(jalview.schemabinding.version2.JGroup.class, reader);\r
866     }\r
867 \r
868     /**\r
869      * \r
870      * \r
871      * @throws org.exolab.castor.xml.ValidationException if this\r
872      * object is an invalid instance according to the schema\r
873      */\r
874     public void validate(\r
875     )\r
876     throws org.exolab.castor.xml.ValidationException {\r
877         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
878         validator.validate(this);\r
879     }\r
880 \r
881 }\r