save visible state of annotation
[jalview.git] / src / jalview / schemabinding / version2 / Annotation.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.schemabinding.version2;\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 Annotation.\r
28  * \r
29  * @version $Revision$ $Date$\r
30  */\r
31 public class Annotation implements java.io.Serializable {\r
32 \r
33 \r
34       //--------------------------/\r
35      //- Class/Member Variables -/\r
36     //--------------------------/\r
37 \r
38     /**\r
39      * Field _graph\r
40      */\r
41     private boolean _graph;\r
42 \r
43     /**\r
44      * keeps track of state for field: _graph\r
45      */\r
46     private boolean _has_graph;\r
47 \r
48     /**\r
49      * Field _graphType\r
50      */\r
51     private int _graphType;\r
52 \r
53     /**\r
54      * keeps track of state for field: _graphType\r
55      */\r
56     private boolean _has_graphType;\r
57 \r
58     /**\r
59      * Field _sequenceRef\r
60      */\r
61     private java.lang.String _sequenceRef;\r
62 \r
63     /**\r
64      * Field _graphColour\r
65      */\r
66     private int _graphColour;\r
67 \r
68     /**\r
69      * keeps track of state for field: _graphColour\r
70      */\r
71     private boolean _has_graphColour;\r
72 \r
73     /**\r
74      * Field _graphGroup\r
75      */\r
76     private int _graphGroup;\r
77 \r
78     /**\r
79      * keeps track of state for field: _graphGroup\r
80      */\r
81     private boolean _has_graphGroup;\r
82 \r
83     /**\r
84      * Field _id\r
85      */\r
86     private java.lang.String _id;\r
87 \r
88     /**\r
89      * Field _scoreOnly\r
90      */\r
91     private boolean _scoreOnly = false;\r
92 \r
93     /**\r
94      * keeps track of state for field: _scoreOnly\r
95      */\r
96     private boolean _has_scoreOnly;\r
97 \r
98     /**\r
99      * Field _score\r
100      */\r
101     private double _score;\r
102 \r
103     /**\r
104      * keeps track of state for field: _score\r
105      */\r
106     private boolean _has_score;\r
107 \r
108     /**\r
109      * Field _visible\r
110      */\r
111     private boolean _visible;\r
112 \r
113     /**\r
114      * keeps track of state for field: _visible\r
115      */\r
116     private boolean _has_visible;\r
117 \r
118     /**\r
119      * Field _annotationElementList\r
120      */\r
121     private java.util.Vector _annotationElementList;\r
122 \r
123     /**\r
124      * Field _label\r
125      */\r
126     private java.lang.String _label;\r
127 \r
128     /**\r
129      * Field _description\r
130      */\r
131     private java.lang.String _description;\r
132 \r
133     /**\r
134      * Field _thresholdLine\r
135      */\r
136     private jalview.schemabinding.version2.ThresholdLine _thresholdLine;\r
137 \r
138 \r
139       //----------------/\r
140      //- Constructors -/\r
141     //----------------/\r
142 \r
143     public Annotation() {\r
144         super();\r
145         _annotationElementList = new Vector();\r
146     } //-- jalview.schemabinding.version2.Annotation()\r
147 \r
148 \r
149       //-----------/\r
150      //- Methods -/\r
151     //-----------/\r
152 \r
153     /**\r
154      * Method addAnnotationElement\r
155      * \r
156      * \r
157      * \r
158      * @param vAnnotationElement\r
159      */\r
160     public void addAnnotationElement(jalview.schemabinding.version2.AnnotationElement vAnnotationElement)\r
161         throws java.lang.IndexOutOfBoundsException\r
162     {\r
163         _annotationElementList.addElement(vAnnotationElement);\r
164     } //-- void addAnnotationElement(jalview.schemabinding.version2.AnnotationElement) \r
165 \r
166     /**\r
167      * Method addAnnotationElement\r
168      * \r
169      * \r
170      * \r
171      * @param index\r
172      * @param vAnnotationElement\r
173      */\r
174     public void addAnnotationElement(int index, jalview.schemabinding.version2.AnnotationElement vAnnotationElement)\r
175         throws java.lang.IndexOutOfBoundsException\r
176     {\r
177         _annotationElementList.insertElementAt(vAnnotationElement, index);\r
178     } //-- void addAnnotationElement(int, jalview.schemabinding.version2.AnnotationElement) \r
179 \r
180     /**\r
181      * Method deleteGraph\r
182      * \r
183      */\r
184     public void deleteGraph()\r
185     {\r
186         this._has_graph= false;\r
187     } //-- void deleteGraph() \r
188 \r
189     /**\r
190      * Method deleteGraphColour\r
191      * \r
192      */\r
193     public void deleteGraphColour()\r
194     {\r
195         this._has_graphColour= false;\r
196     } //-- void deleteGraphColour() \r
197 \r
198     /**\r
199      * Method deleteGraphGroup\r
200      * \r
201      */\r
202     public void deleteGraphGroup()\r
203     {\r
204         this._has_graphGroup= false;\r
205     } //-- void deleteGraphGroup() \r
206 \r
207     /**\r
208      * Method deleteGraphType\r
209      * \r
210      */\r
211     public void deleteGraphType()\r
212     {\r
213         this._has_graphType= false;\r
214     } //-- void deleteGraphType() \r
215 \r
216     /**\r
217      * Method deleteScore\r
218      * \r
219      */\r
220     public void deleteScore()\r
221     {\r
222         this._has_score= false;\r
223     } //-- void deleteScore() \r
224 \r
225     /**\r
226      * Method deleteScoreOnly\r
227      * \r
228      */\r
229     public void deleteScoreOnly()\r
230     {\r
231         this._has_scoreOnly= false;\r
232     } //-- void deleteScoreOnly() \r
233 \r
234     /**\r
235      * Method deleteVisible\r
236      * \r
237      */\r
238     public void deleteVisible()\r
239     {\r
240         this._has_visible= false;\r
241     } //-- void deleteVisible() \r
242 \r
243     /**\r
244      * Method enumerateAnnotationElement\r
245      * \r
246      * \r
247      * \r
248      * @return Enumeration\r
249      */\r
250     public java.util.Enumeration enumerateAnnotationElement()\r
251     {\r
252         return _annotationElementList.elements();\r
253     } //-- java.util.Enumeration enumerateAnnotationElement() \r
254 \r
255     /**\r
256      * Method getAnnotationElement\r
257      * \r
258      * \r
259      * \r
260      * @param index\r
261      * @return AnnotationElement\r
262      */\r
263     public jalview.schemabinding.version2.AnnotationElement getAnnotationElement(int index)\r
264         throws java.lang.IndexOutOfBoundsException\r
265     {\r
266         //-- check bounds for index\r
267         if ((index < 0) || (index > _annotationElementList.size())) {\r
268             throw new IndexOutOfBoundsException();\r
269         }\r
270         \r
271         return (jalview.schemabinding.version2.AnnotationElement) _annotationElementList.elementAt(index);\r
272     } //-- jalview.schemabinding.version2.AnnotationElement getAnnotationElement(int) \r
273 \r
274     /**\r
275      * Method getAnnotationElement\r
276      * \r
277      * \r
278      * \r
279      * @return AnnotationElement\r
280      */\r
281     public jalview.schemabinding.version2.AnnotationElement[] getAnnotationElement()\r
282     {\r
283         int size = _annotationElementList.size();\r
284         jalview.schemabinding.version2.AnnotationElement[] mArray = new jalview.schemabinding.version2.AnnotationElement[size];\r
285         for (int index = 0; index < size; index++) {\r
286             mArray[index] = (jalview.schemabinding.version2.AnnotationElement) _annotationElementList.elementAt(index);\r
287         }\r
288         return mArray;\r
289     } //-- jalview.schemabinding.version2.AnnotationElement[] getAnnotationElement() \r
290 \r
291     /**\r
292      * Method getAnnotationElementCount\r
293      * \r
294      * \r
295      * \r
296      * @return int\r
297      */\r
298     public int getAnnotationElementCount()\r
299     {\r
300         return _annotationElementList.size();\r
301     } //-- int getAnnotationElementCount() \r
302 \r
303     /**\r
304      * Returns the value of field 'description'.\r
305      * \r
306      * @return String\r
307      * @return the value of field 'description'.\r
308      */\r
309     public java.lang.String getDescription()\r
310     {\r
311         return this._description;\r
312     } //-- java.lang.String getDescription() \r
313 \r
314     /**\r
315      * Returns the value of field 'graph'.\r
316      * \r
317      * @return boolean\r
318      * @return the value of field 'graph'.\r
319      */\r
320     public boolean getGraph()\r
321     {\r
322         return this._graph;\r
323     } //-- boolean getGraph() \r
324 \r
325     /**\r
326      * Returns the value of field 'graphColour'.\r
327      * \r
328      * @return int\r
329      * @return the value of field 'graphColour'.\r
330      */\r
331     public int getGraphColour()\r
332     {\r
333         return this._graphColour;\r
334     } //-- int getGraphColour() \r
335 \r
336     /**\r
337      * Returns the value of field 'graphGroup'.\r
338      * \r
339      * @return int\r
340      * @return the value of field 'graphGroup'.\r
341      */\r
342     public int getGraphGroup()\r
343     {\r
344         return this._graphGroup;\r
345     } //-- int getGraphGroup() \r
346 \r
347     /**\r
348      * Returns the value of field 'graphType'.\r
349      * \r
350      * @return int\r
351      * @return the value of field 'graphType'.\r
352      */\r
353     public int getGraphType()\r
354     {\r
355         return this._graphType;\r
356     } //-- int getGraphType() \r
357 \r
358     /**\r
359      * Returns the value of field 'id'.\r
360      * \r
361      * @return String\r
362      * @return the value of field 'id'.\r
363      */\r
364     public java.lang.String getId()\r
365     {\r
366         return this._id;\r
367     } //-- java.lang.String getId() \r
368 \r
369     /**\r
370      * Returns the value of field 'label'.\r
371      * \r
372      * @return String\r
373      * @return the value of field 'label'.\r
374      */\r
375     public java.lang.String getLabel()\r
376     {\r
377         return this._label;\r
378     } //-- java.lang.String getLabel() \r
379 \r
380     /**\r
381      * Returns the value of field 'score'.\r
382      * \r
383      * @return double\r
384      * @return the value of field 'score'.\r
385      */\r
386     public double getScore()\r
387     {\r
388         return this._score;\r
389     } //-- double getScore() \r
390 \r
391     /**\r
392      * Returns the value of field 'scoreOnly'.\r
393      * \r
394      * @return boolean\r
395      * @return the value of field 'scoreOnly'.\r
396      */\r
397     public boolean getScoreOnly()\r
398     {\r
399         return this._scoreOnly;\r
400     } //-- boolean getScoreOnly() \r
401 \r
402     /**\r
403      * Returns the value of field 'sequenceRef'.\r
404      * \r
405      * @return String\r
406      * @return the value of field 'sequenceRef'.\r
407      */\r
408     public java.lang.String getSequenceRef()\r
409     {\r
410         return this._sequenceRef;\r
411     } //-- java.lang.String getSequenceRef() \r
412 \r
413     /**\r
414      * Returns the value of field 'thresholdLine'.\r
415      * \r
416      * @return ThresholdLine\r
417      * @return the value of field 'thresholdLine'.\r
418      */\r
419     public jalview.schemabinding.version2.ThresholdLine getThresholdLine()\r
420     {\r
421         return this._thresholdLine;\r
422     } //-- jalview.schemabinding.version2.ThresholdLine getThresholdLine() \r
423 \r
424     /**\r
425      * Returns the value of field 'visible'.\r
426      * \r
427      * @return boolean\r
428      * @return the value of field 'visible'.\r
429      */\r
430     public boolean getVisible()\r
431     {\r
432         return this._visible;\r
433     } //-- boolean getVisible() \r
434 \r
435     /**\r
436      * Method hasGraph\r
437      * \r
438      * \r
439      * \r
440      * @return boolean\r
441      */\r
442     public boolean hasGraph()\r
443     {\r
444         return this._has_graph;\r
445     } //-- boolean hasGraph() \r
446 \r
447     /**\r
448      * Method hasGraphColour\r
449      * \r
450      * \r
451      * \r
452      * @return boolean\r
453      */\r
454     public boolean hasGraphColour()\r
455     {\r
456         return this._has_graphColour;\r
457     } //-- boolean hasGraphColour() \r
458 \r
459     /**\r
460      * Method hasGraphGroup\r
461      * \r
462      * \r
463      * \r
464      * @return boolean\r
465      */\r
466     public boolean hasGraphGroup()\r
467     {\r
468         return this._has_graphGroup;\r
469     } //-- boolean hasGraphGroup() \r
470 \r
471     /**\r
472      * Method hasGraphType\r
473      * \r
474      * \r
475      * \r
476      * @return boolean\r
477      */\r
478     public boolean hasGraphType()\r
479     {\r
480         return this._has_graphType;\r
481     } //-- boolean hasGraphType() \r
482 \r
483     /**\r
484      * Method hasScore\r
485      * \r
486      * \r
487      * \r
488      * @return boolean\r
489      */\r
490     public boolean hasScore()\r
491     {\r
492         return this._has_score;\r
493     } //-- boolean hasScore() \r
494 \r
495     /**\r
496      * Method hasScoreOnly\r
497      * \r
498      * \r
499      * \r
500      * @return boolean\r
501      */\r
502     public boolean hasScoreOnly()\r
503     {\r
504         return this._has_scoreOnly;\r
505     } //-- boolean hasScoreOnly() \r
506 \r
507     /**\r
508      * Method hasVisible\r
509      * \r
510      * \r
511      * \r
512      * @return boolean\r
513      */\r
514     public boolean hasVisible()\r
515     {\r
516         return this._has_visible;\r
517     } //-- boolean hasVisible() \r
518 \r
519     /**\r
520      * Method isValid\r
521      * \r
522      * \r
523      * \r
524      * @return boolean\r
525      */\r
526     public boolean isValid()\r
527     {\r
528         try {\r
529             validate();\r
530         }\r
531         catch (org.exolab.castor.xml.ValidationException vex) {\r
532             return false;\r
533         }\r
534         return true;\r
535     } //-- boolean isValid() \r
536 \r
537     /**\r
538      * Method marshal\r
539      * \r
540      * \r
541      * \r
542      * @param out\r
543      */\r
544     public void marshal(java.io.Writer out)\r
545         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
546     {\r
547         \r
548         Marshaller.marshal(this, out);\r
549     } //-- void marshal(java.io.Writer) \r
550 \r
551     /**\r
552      * Method marshal\r
553      * \r
554      * \r
555      * \r
556      * @param handler\r
557      */\r
558     public void marshal(org.xml.sax.ContentHandler handler)\r
559         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
560     {\r
561         \r
562         Marshaller.marshal(this, handler);\r
563     } //-- void marshal(org.xml.sax.ContentHandler) \r
564 \r
565     /**\r
566      * Method removeAllAnnotationElement\r
567      * \r
568      */\r
569     public void removeAllAnnotationElement()\r
570     {\r
571         _annotationElementList.removeAllElements();\r
572     } //-- void removeAllAnnotationElement() \r
573 \r
574     /**\r
575      * Method removeAnnotationElement\r
576      * \r
577      * \r
578      * \r
579      * @param index\r
580      * @return AnnotationElement\r
581      */\r
582     public jalview.schemabinding.version2.AnnotationElement removeAnnotationElement(int index)\r
583     {\r
584         java.lang.Object obj = _annotationElementList.elementAt(index);\r
585         _annotationElementList.removeElementAt(index);\r
586         return (jalview.schemabinding.version2.AnnotationElement) obj;\r
587     } //-- jalview.schemabinding.version2.AnnotationElement removeAnnotationElement(int) \r
588 \r
589     /**\r
590      * Method setAnnotationElement\r
591      * \r
592      * \r
593      * \r
594      * @param index\r
595      * @param vAnnotationElement\r
596      */\r
597     public void setAnnotationElement(int index, jalview.schemabinding.version2.AnnotationElement vAnnotationElement)\r
598         throws java.lang.IndexOutOfBoundsException\r
599     {\r
600         //-- check bounds for index\r
601         if ((index < 0) || (index > _annotationElementList.size())) {\r
602             throw new IndexOutOfBoundsException();\r
603         }\r
604         _annotationElementList.setElementAt(vAnnotationElement, index);\r
605     } //-- void setAnnotationElement(int, jalview.schemabinding.version2.AnnotationElement) \r
606 \r
607     /**\r
608      * Method setAnnotationElement\r
609      * \r
610      * \r
611      * \r
612      * @param annotationElementArray\r
613      */\r
614     public void setAnnotationElement(jalview.schemabinding.version2.AnnotationElement[] annotationElementArray)\r
615     {\r
616         //-- copy array\r
617         _annotationElementList.removeAllElements();\r
618         for (int i = 0; i < annotationElementArray.length; i++) {\r
619             _annotationElementList.addElement(annotationElementArray[i]);\r
620         }\r
621     } //-- void setAnnotationElement(jalview.schemabinding.version2.AnnotationElement) \r
622 \r
623     /**\r
624      * Sets the value of field 'description'.\r
625      * \r
626      * @param description the value of field 'description'.\r
627      */\r
628     public void setDescription(java.lang.String description)\r
629     {\r
630         this._description = description;\r
631     } //-- void setDescription(java.lang.String) \r
632 \r
633     /**\r
634      * Sets the value of field 'graph'.\r
635      * \r
636      * @param graph the value of field 'graph'.\r
637      */\r
638     public void setGraph(boolean graph)\r
639     {\r
640         this._graph = graph;\r
641         this._has_graph = true;\r
642     } //-- void setGraph(boolean) \r
643 \r
644     /**\r
645      * Sets the value of field 'graphColour'.\r
646      * \r
647      * @param graphColour the value of field 'graphColour'.\r
648      */\r
649     public void setGraphColour(int graphColour)\r
650     {\r
651         this._graphColour = graphColour;\r
652         this._has_graphColour = true;\r
653     } //-- void setGraphColour(int) \r
654 \r
655     /**\r
656      * Sets the value of field 'graphGroup'.\r
657      * \r
658      * @param graphGroup the value of field 'graphGroup'.\r
659      */\r
660     public void setGraphGroup(int graphGroup)\r
661     {\r
662         this._graphGroup = graphGroup;\r
663         this._has_graphGroup = true;\r
664     } //-- void setGraphGroup(int) \r
665 \r
666     /**\r
667      * Sets the value of field 'graphType'.\r
668      * \r
669      * @param graphType the value of field 'graphType'.\r
670      */\r
671     public void setGraphType(int graphType)\r
672     {\r
673         this._graphType = graphType;\r
674         this._has_graphType = true;\r
675     } //-- void setGraphType(int) \r
676 \r
677     /**\r
678      * Sets the value of field 'id'.\r
679      * \r
680      * @param id the value of field 'id'.\r
681      */\r
682     public void setId(java.lang.String id)\r
683     {\r
684         this._id = id;\r
685     } //-- void setId(java.lang.String) \r
686 \r
687     /**\r
688      * Sets the value of field 'label'.\r
689      * \r
690      * @param label the value of field 'label'.\r
691      */\r
692     public void setLabel(java.lang.String label)\r
693     {\r
694         this._label = label;\r
695     } //-- void setLabel(java.lang.String) \r
696 \r
697     /**\r
698      * Sets the value of field 'score'.\r
699      * \r
700      * @param score the value of field 'score'.\r
701      */\r
702     public void setScore(double score)\r
703     {\r
704         this._score = score;\r
705         this._has_score = true;\r
706     } //-- void setScore(double) \r
707 \r
708     /**\r
709      * Sets the value of field 'scoreOnly'.\r
710      * \r
711      * @param scoreOnly the value of field 'scoreOnly'.\r
712      */\r
713     public void setScoreOnly(boolean scoreOnly)\r
714     {\r
715         this._scoreOnly = scoreOnly;\r
716         this._has_scoreOnly = true;\r
717     } //-- void setScoreOnly(boolean) \r
718 \r
719     /**\r
720      * Sets the value of field 'sequenceRef'.\r
721      * \r
722      * @param sequenceRef the value of field 'sequenceRef'.\r
723      */\r
724     public void setSequenceRef(java.lang.String sequenceRef)\r
725     {\r
726         this._sequenceRef = sequenceRef;\r
727     } //-- void setSequenceRef(java.lang.String) \r
728 \r
729     /**\r
730      * Sets the value of field 'thresholdLine'.\r
731      * \r
732      * @param thresholdLine the value of field 'thresholdLine'.\r
733      */\r
734     public void setThresholdLine(jalview.schemabinding.version2.ThresholdLine thresholdLine)\r
735     {\r
736         this._thresholdLine = thresholdLine;\r
737     } //-- void setThresholdLine(jalview.schemabinding.version2.ThresholdLine) \r
738 \r
739     /**\r
740      * Sets the value of field 'visible'.\r
741      * \r
742      * @param visible the value of field 'visible'.\r
743      */\r
744     public void setVisible(boolean visible)\r
745     {\r
746         this._visible = visible;\r
747         this._has_visible = true;\r
748     } //-- void setVisible(boolean) \r
749 \r
750     /**\r
751      * Method unmarshal\r
752      * \r
753      * \r
754      * \r
755      * @param reader\r
756      * @return Object\r
757      */\r
758     public static java.lang.Object unmarshal(java.io.Reader reader)\r
759         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
760     {\r
761         return (jalview.schemabinding.version2.Annotation) Unmarshaller.unmarshal(jalview.schemabinding.version2.Annotation.class, reader);\r
762     } //-- java.lang.Object unmarshal(java.io.Reader) \r
763 \r
764     /**\r
765      * Method validate\r
766      * \r
767      */\r
768     public void validate()\r
769         throws org.exolab.castor.xml.ValidationException\r
770     {\r
771         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
772         validator.validate(this);\r
773     } //-- void validate() \r
774 \r
775 }\r