Add pdb ref
[jalview.git] / src / jalview / binding / Tree.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 org.exolab.castor.xml.MarshalException;\r
19 import org.exolab.castor.xml.Marshaller;\r
20 import org.exolab.castor.xml.Unmarshaller;\r
21 import org.exolab.castor.xml.ValidationException;\r
22 import org.xml.sax.ContentHandler;\r
23 \r
24 /**\r
25  * Class Tree.\r
26  * \r
27  * @version $Revision$ $Date$\r
28  */\r
29 public class Tree implements java.io.Serializable {\r
30 \r
31 \r
32       //--------------------------/\r
33      //- Class/Member Variables -/\r
34     //--------------------------/\r
35 \r
36     /**\r
37      * Field _width\r
38      */\r
39     private int _width;\r
40 \r
41     /**\r
42      * keeps track of state for field: _width\r
43      */\r
44     private boolean _has_width;\r
45 \r
46     /**\r
47      * Field _height\r
48      */\r
49     private int _height;\r
50 \r
51     /**\r
52      * keeps track of state for field: _height\r
53      */\r
54     private boolean _has_height;\r
55 \r
56     /**\r
57      * Field _xpos\r
58      */\r
59     private int _xpos;\r
60 \r
61     /**\r
62      * keeps track of state for field: _xpos\r
63      */\r
64     private boolean _has_xpos;\r
65 \r
66     /**\r
67      * Field _ypos\r
68      */\r
69     private int _ypos;\r
70 \r
71     /**\r
72      * keeps track of state for field: _ypos\r
73      */\r
74     private boolean _has_ypos;\r
75 \r
76     /**\r
77      * Field _fontName\r
78      */\r
79     private java.lang.String _fontName;\r
80 \r
81     /**\r
82      * Field _fontSize\r
83      */\r
84     private int _fontSize;\r
85 \r
86     /**\r
87      * keeps track of state for field: _fontSize\r
88      */\r
89     private boolean _has_fontSize;\r
90 \r
91     /**\r
92      * Field _fontStyle\r
93      */\r
94     private int _fontStyle;\r
95 \r
96     /**\r
97      * keeps track of state for field: _fontStyle\r
98      */\r
99     private boolean _has_fontStyle;\r
100 \r
101     /**\r
102      * Field _threshold\r
103      */\r
104     private float _threshold;\r
105 \r
106     /**\r
107      * keeps track of state for field: _threshold\r
108      */\r
109     private boolean _has_threshold;\r
110 \r
111     /**\r
112      * Field _showBootstrap\r
113      */\r
114     private boolean _showBootstrap;\r
115 \r
116     /**\r
117      * keeps track of state for field: _showBootstrap\r
118      */\r
119     private boolean _has_showBootstrap;\r
120 \r
121     /**\r
122      * Field _showDistances\r
123      */\r
124     private boolean _showDistances;\r
125 \r
126     /**\r
127      * keeps track of state for field: _showDistances\r
128      */\r
129     private boolean _has_showDistances;\r
130 \r
131     /**\r
132      * Field _markUnlinked\r
133      */\r
134     private boolean _markUnlinked;\r
135 \r
136     /**\r
137      * keeps track of state for field: _markUnlinked\r
138      */\r
139     private boolean _has_markUnlinked;\r
140 \r
141     /**\r
142      * Field _fitToWindow\r
143      */\r
144     private boolean _fitToWindow;\r
145 \r
146     /**\r
147      * keeps track of state for field: _fitToWindow\r
148      */\r
149     private boolean _has_fitToWindow;\r
150 \r
151     /**\r
152      * Field _currentTree\r
153      */\r
154     private boolean _currentTree;\r
155 \r
156     /**\r
157      * keeps track of state for field: _currentTree\r
158      */\r
159     private boolean _has_currentTree;\r
160 \r
161     /**\r
162      * Field _title\r
163      */\r
164     private java.lang.String _title;\r
165 \r
166     /**\r
167      * Field _newick\r
168      */\r
169     private java.lang.String _newick;\r
170 \r
171 \r
172       //----------------/\r
173      //- Constructors -/\r
174     //----------------/\r
175 \r
176     public Tree() {\r
177         super();\r
178     } //-- jalview.binding.Tree()\r
179 \r
180 \r
181       //-----------/\r
182      //- Methods -/\r
183     //-----------/\r
184 \r
185     /**\r
186      * Method deleteCurrentTree\r
187      * \r
188      */\r
189     public void deleteCurrentTree()\r
190     {\r
191         this._has_currentTree= false;\r
192     } //-- void deleteCurrentTree() \r
193 \r
194     /**\r
195      * Method deleteFitToWindow\r
196      * \r
197      */\r
198     public void deleteFitToWindow()\r
199     {\r
200         this._has_fitToWindow= false;\r
201     } //-- void deleteFitToWindow() \r
202 \r
203     /**\r
204      * Method deleteFontSize\r
205      * \r
206      */\r
207     public void deleteFontSize()\r
208     {\r
209         this._has_fontSize= false;\r
210     } //-- void deleteFontSize() \r
211 \r
212     /**\r
213      * Method deleteFontStyle\r
214      * \r
215      */\r
216     public void deleteFontStyle()\r
217     {\r
218         this._has_fontStyle= false;\r
219     } //-- void deleteFontStyle() \r
220 \r
221     /**\r
222      * Method deleteHeight\r
223      * \r
224      */\r
225     public void deleteHeight()\r
226     {\r
227         this._has_height= false;\r
228     } //-- void deleteHeight() \r
229 \r
230     /**\r
231      * Method deleteMarkUnlinked\r
232      * \r
233      */\r
234     public void deleteMarkUnlinked()\r
235     {\r
236         this._has_markUnlinked= false;\r
237     } //-- void deleteMarkUnlinked() \r
238 \r
239     /**\r
240      * Method deleteShowBootstrap\r
241      * \r
242      */\r
243     public void deleteShowBootstrap()\r
244     {\r
245         this._has_showBootstrap= false;\r
246     } //-- void deleteShowBootstrap() \r
247 \r
248     /**\r
249      * Method deleteShowDistances\r
250      * \r
251      */\r
252     public void deleteShowDistances()\r
253     {\r
254         this._has_showDistances= false;\r
255     } //-- void deleteShowDistances() \r
256 \r
257     /**\r
258      * Method deleteThreshold\r
259      * \r
260      */\r
261     public void deleteThreshold()\r
262     {\r
263         this._has_threshold= false;\r
264     } //-- void deleteThreshold() \r
265 \r
266     /**\r
267      * Method deleteWidth\r
268      * \r
269      */\r
270     public void deleteWidth()\r
271     {\r
272         this._has_width= false;\r
273     } //-- void deleteWidth() \r
274 \r
275     /**\r
276      * Method deleteXpos\r
277      * \r
278      */\r
279     public void deleteXpos()\r
280     {\r
281         this._has_xpos= false;\r
282     } //-- void deleteXpos() \r
283 \r
284     /**\r
285      * Method deleteYpos\r
286      * \r
287      */\r
288     public void deleteYpos()\r
289     {\r
290         this._has_ypos= false;\r
291     } //-- void deleteYpos() \r
292 \r
293     /**\r
294      * Returns the value of field 'currentTree'.\r
295      * \r
296      * @return boolean\r
297      * @return the value of field 'currentTree'.\r
298      */\r
299     public boolean getCurrentTree()\r
300     {\r
301         return this._currentTree;\r
302     } //-- boolean getCurrentTree() \r
303 \r
304     /**\r
305      * Returns the value of field 'fitToWindow'.\r
306      * \r
307      * @return boolean\r
308      * @return the value of field 'fitToWindow'.\r
309      */\r
310     public boolean getFitToWindow()\r
311     {\r
312         return this._fitToWindow;\r
313     } //-- boolean getFitToWindow() \r
314 \r
315     /**\r
316      * Returns the value of field 'fontName'.\r
317      * \r
318      * @return String\r
319      * @return the value of field 'fontName'.\r
320      */\r
321     public java.lang.String getFontName()\r
322     {\r
323         return this._fontName;\r
324     } //-- java.lang.String getFontName() \r
325 \r
326     /**\r
327      * Returns the value of field 'fontSize'.\r
328      * \r
329      * @return int\r
330      * @return the value of field 'fontSize'.\r
331      */\r
332     public int getFontSize()\r
333     {\r
334         return this._fontSize;\r
335     } //-- int getFontSize() \r
336 \r
337     /**\r
338      * Returns the value of field 'fontStyle'.\r
339      * \r
340      * @return int\r
341      * @return the value of field 'fontStyle'.\r
342      */\r
343     public int getFontStyle()\r
344     {\r
345         return this._fontStyle;\r
346     } //-- int getFontStyle() \r
347 \r
348     /**\r
349      * Returns the value of field 'height'.\r
350      * \r
351      * @return int\r
352      * @return the value of field 'height'.\r
353      */\r
354     public int getHeight()\r
355     {\r
356         return this._height;\r
357     } //-- int getHeight() \r
358 \r
359     /**\r
360      * Returns the value of field 'markUnlinked'.\r
361      * \r
362      * @return boolean\r
363      * @return the value of field 'markUnlinked'.\r
364      */\r
365     public boolean getMarkUnlinked()\r
366     {\r
367         return this._markUnlinked;\r
368     } //-- boolean getMarkUnlinked() \r
369 \r
370     /**\r
371      * Returns the value of field 'newick'.\r
372      * \r
373      * @return String\r
374      * @return the value of field 'newick'.\r
375      */\r
376     public java.lang.String getNewick()\r
377     {\r
378         return this._newick;\r
379     } //-- java.lang.String getNewick() \r
380 \r
381     /**\r
382      * Returns the value of field 'showBootstrap'.\r
383      * \r
384      * @return boolean\r
385      * @return the value of field 'showBootstrap'.\r
386      */\r
387     public boolean getShowBootstrap()\r
388     {\r
389         return this._showBootstrap;\r
390     } //-- boolean getShowBootstrap() \r
391 \r
392     /**\r
393      * Returns the value of field 'showDistances'.\r
394      * \r
395      * @return boolean\r
396      * @return the value of field 'showDistances'.\r
397      */\r
398     public boolean getShowDistances()\r
399     {\r
400         return this._showDistances;\r
401     } //-- boolean getShowDistances() \r
402 \r
403     /**\r
404      * Returns the value of field 'threshold'.\r
405      * \r
406      * @return float\r
407      * @return the value of field 'threshold'.\r
408      */\r
409     public float getThreshold()\r
410     {\r
411         return this._threshold;\r
412     } //-- float getThreshold() \r
413 \r
414     /**\r
415      * Returns the value of field 'title'.\r
416      * \r
417      * @return String\r
418      * @return the value of field 'title'.\r
419      */\r
420     public java.lang.String getTitle()\r
421     {\r
422         return this._title;\r
423     } //-- java.lang.String getTitle() \r
424 \r
425     /**\r
426      * Returns the value of field 'width'.\r
427      * \r
428      * @return int\r
429      * @return the value of field 'width'.\r
430      */\r
431     public int getWidth()\r
432     {\r
433         return this._width;\r
434     } //-- int getWidth() \r
435 \r
436     /**\r
437      * Returns the value of field 'xpos'.\r
438      * \r
439      * @return int\r
440      * @return the value of field 'xpos'.\r
441      */\r
442     public int getXpos()\r
443     {\r
444         return this._xpos;\r
445     } //-- int getXpos() \r
446 \r
447     /**\r
448      * Returns the value of field 'ypos'.\r
449      * \r
450      * @return int\r
451      * @return the value of field 'ypos'.\r
452      */\r
453     public int getYpos()\r
454     {\r
455         return this._ypos;\r
456     } //-- int getYpos() \r
457 \r
458     /**\r
459      * Method hasCurrentTree\r
460      * \r
461      * \r
462      * \r
463      * @return boolean\r
464      */\r
465     public boolean hasCurrentTree()\r
466     {\r
467         return this._has_currentTree;\r
468     } //-- boolean hasCurrentTree() \r
469 \r
470     /**\r
471      * Method hasFitToWindow\r
472      * \r
473      * \r
474      * \r
475      * @return boolean\r
476      */\r
477     public boolean hasFitToWindow()\r
478     {\r
479         return this._has_fitToWindow;\r
480     } //-- boolean hasFitToWindow() \r
481 \r
482     /**\r
483      * Method hasFontSize\r
484      * \r
485      * \r
486      * \r
487      * @return boolean\r
488      */\r
489     public boolean hasFontSize()\r
490     {\r
491         return this._has_fontSize;\r
492     } //-- boolean hasFontSize() \r
493 \r
494     /**\r
495      * Method hasFontStyle\r
496      * \r
497      * \r
498      * \r
499      * @return boolean\r
500      */\r
501     public boolean hasFontStyle()\r
502     {\r
503         return this._has_fontStyle;\r
504     } //-- boolean hasFontStyle() \r
505 \r
506     /**\r
507      * Method hasHeight\r
508      * \r
509      * \r
510      * \r
511      * @return boolean\r
512      */\r
513     public boolean hasHeight()\r
514     {\r
515         return this._has_height;\r
516     } //-- boolean hasHeight() \r
517 \r
518     /**\r
519      * Method hasMarkUnlinked\r
520      * \r
521      * \r
522      * \r
523      * @return boolean\r
524      */\r
525     public boolean hasMarkUnlinked()\r
526     {\r
527         return this._has_markUnlinked;\r
528     } //-- boolean hasMarkUnlinked() \r
529 \r
530     /**\r
531      * Method hasShowBootstrap\r
532      * \r
533      * \r
534      * \r
535      * @return boolean\r
536      */\r
537     public boolean hasShowBootstrap()\r
538     {\r
539         return this._has_showBootstrap;\r
540     } //-- boolean hasShowBootstrap() \r
541 \r
542     /**\r
543      * Method hasShowDistances\r
544      * \r
545      * \r
546      * \r
547      * @return boolean\r
548      */\r
549     public boolean hasShowDistances()\r
550     {\r
551         return this._has_showDistances;\r
552     } //-- boolean hasShowDistances() \r
553 \r
554     /**\r
555      * Method hasThreshold\r
556      * \r
557      * \r
558      * \r
559      * @return boolean\r
560      */\r
561     public boolean hasThreshold()\r
562     {\r
563         return this._has_threshold;\r
564     } //-- boolean hasThreshold() \r
565 \r
566     /**\r
567      * Method hasWidth\r
568      * \r
569      * \r
570      * \r
571      * @return boolean\r
572      */\r
573     public boolean hasWidth()\r
574     {\r
575         return this._has_width;\r
576     } //-- boolean hasWidth() \r
577 \r
578     /**\r
579      * Method hasXpos\r
580      * \r
581      * \r
582      * \r
583      * @return boolean\r
584      */\r
585     public boolean hasXpos()\r
586     {\r
587         return this._has_xpos;\r
588     } //-- boolean hasXpos() \r
589 \r
590     /**\r
591      * Method hasYpos\r
592      * \r
593      * \r
594      * \r
595      * @return boolean\r
596      */\r
597     public boolean hasYpos()\r
598     {\r
599         return this._has_ypos;\r
600     } //-- boolean hasYpos() \r
601 \r
602     /**\r
603      * Method isValid\r
604      * \r
605      * \r
606      * \r
607      * @return boolean\r
608      */\r
609     public boolean isValid()\r
610     {\r
611         try {\r
612             validate();\r
613         }\r
614         catch (org.exolab.castor.xml.ValidationException vex) {\r
615             return false;\r
616         }\r
617         return true;\r
618     } //-- boolean isValid() \r
619 \r
620     /**\r
621      * Method marshal\r
622      * \r
623      * \r
624      * \r
625      * @param out\r
626      */\r
627     public void marshal(java.io.Writer out)\r
628         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
629     {\r
630         \r
631         Marshaller.marshal(this, out);\r
632     } //-- void marshal(java.io.Writer) \r
633 \r
634     /**\r
635      * Method marshal\r
636      * \r
637      * \r
638      * \r
639      * @param handler\r
640      */\r
641     public void marshal(org.xml.sax.ContentHandler handler)\r
642         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
643     {\r
644         \r
645         Marshaller.marshal(this, handler);\r
646     } //-- void marshal(org.xml.sax.ContentHandler) \r
647 \r
648     /**\r
649      * Sets the value of field 'currentTree'.\r
650      * \r
651      * @param currentTree the value of field 'currentTree'.\r
652      */\r
653     public void setCurrentTree(boolean currentTree)\r
654     {\r
655         this._currentTree = currentTree;\r
656         this._has_currentTree = true;\r
657     } //-- void setCurrentTree(boolean) \r
658 \r
659     /**\r
660      * Sets the value of field 'fitToWindow'.\r
661      * \r
662      * @param fitToWindow the value of field 'fitToWindow'.\r
663      */\r
664     public void setFitToWindow(boolean fitToWindow)\r
665     {\r
666         this._fitToWindow = fitToWindow;\r
667         this._has_fitToWindow = true;\r
668     } //-- void setFitToWindow(boolean) \r
669 \r
670     /**\r
671      * Sets the value of field 'fontName'.\r
672      * \r
673      * @param fontName the value of field 'fontName'.\r
674      */\r
675     public void setFontName(java.lang.String fontName)\r
676     {\r
677         this._fontName = fontName;\r
678     } //-- void setFontName(java.lang.String) \r
679 \r
680     /**\r
681      * Sets the value of field 'fontSize'.\r
682      * \r
683      * @param fontSize the value of field 'fontSize'.\r
684      */\r
685     public void setFontSize(int fontSize)\r
686     {\r
687         this._fontSize = fontSize;\r
688         this._has_fontSize = true;\r
689     } //-- void setFontSize(int) \r
690 \r
691     /**\r
692      * Sets the value of field 'fontStyle'.\r
693      * \r
694      * @param fontStyle the value of field 'fontStyle'.\r
695      */\r
696     public void setFontStyle(int fontStyle)\r
697     {\r
698         this._fontStyle = fontStyle;\r
699         this._has_fontStyle = true;\r
700     } //-- void setFontStyle(int) \r
701 \r
702     /**\r
703      * Sets the value of field 'height'.\r
704      * \r
705      * @param height the value of field 'height'.\r
706      */\r
707     public void setHeight(int height)\r
708     {\r
709         this._height = height;\r
710         this._has_height = true;\r
711     } //-- void setHeight(int) \r
712 \r
713     /**\r
714      * Sets the value of field 'markUnlinked'.\r
715      * \r
716      * @param markUnlinked the value of field 'markUnlinked'.\r
717      */\r
718     public void setMarkUnlinked(boolean markUnlinked)\r
719     {\r
720         this._markUnlinked = markUnlinked;\r
721         this._has_markUnlinked = true;\r
722     } //-- void setMarkUnlinked(boolean) \r
723 \r
724     /**\r
725      * Sets the value of field 'newick'.\r
726      * \r
727      * @param newick the value of field 'newick'.\r
728      */\r
729     public void setNewick(java.lang.String newick)\r
730     {\r
731         this._newick = newick;\r
732     } //-- void setNewick(java.lang.String) \r
733 \r
734     /**\r
735      * Sets the value of field 'showBootstrap'.\r
736      * \r
737      * @param showBootstrap the value of field 'showBootstrap'.\r
738      */\r
739     public void setShowBootstrap(boolean showBootstrap)\r
740     {\r
741         this._showBootstrap = showBootstrap;\r
742         this._has_showBootstrap = true;\r
743     } //-- void setShowBootstrap(boolean) \r
744 \r
745     /**\r
746      * Sets the value of field 'showDistances'.\r
747      * \r
748      * @param showDistances the value of field 'showDistances'.\r
749      */\r
750     public void setShowDistances(boolean showDistances)\r
751     {\r
752         this._showDistances = showDistances;\r
753         this._has_showDistances = true;\r
754     } //-- void setShowDistances(boolean) \r
755 \r
756     /**\r
757      * Sets the value of field 'threshold'.\r
758      * \r
759      * @param threshold the value of field 'threshold'.\r
760      */\r
761     public void setThreshold(float threshold)\r
762     {\r
763         this._threshold = threshold;\r
764         this._has_threshold = true;\r
765     } //-- void setThreshold(float) \r
766 \r
767     /**\r
768      * Sets the value of field 'title'.\r
769      * \r
770      * @param title the value of field 'title'.\r
771      */\r
772     public void setTitle(java.lang.String title)\r
773     {\r
774         this._title = title;\r
775     } //-- void setTitle(java.lang.String) \r
776 \r
777     /**\r
778      * Sets the value of field 'width'.\r
779      * \r
780      * @param width the value of field 'width'.\r
781      */\r
782     public void setWidth(int width)\r
783     {\r
784         this._width = width;\r
785         this._has_width = true;\r
786     } //-- void setWidth(int) \r
787 \r
788     /**\r
789      * Sets the value of field 'xpos'.\r
790      * \r
791      * @param xpos the value of field 'xpos'.\r
792      */\r
793     public void setXpos(int xpos)\r
794     {\r
795         this._xpos = xpos;\r
796         this._has_xpos = true;\r
797     } //-- void setXpos(int) \r
798 \r
799     /**\r
800      * Sets the value of field 'ypos'.\r
801      * \r
802      * @param ypos the value of field 'ypos'.\r
803      */\r
804     public void setYpos(int ypos)\r
805     {\r
806         this._ypos = ypos;\r
807         this._has_ypos = true;\r
808     } //-- void setYpos(int) \r
809 \r
810     /**\r
811      * Method unmarshal\r
812      * \r
813      * \r
814      * \r
815      * @param reader\r
816      * @return Object\r
817      */\r
818     public static java.lang.Object unmarshal(java.io.Reader reader)\r
819         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
820     {\r
821         return (jalview.binding.Tree) Unmarshaller.unmarshal(jalview.binding.Tree.class, reader);\r
822     } //-- java.lang.Object unmarshal(java.io.Reader) \r
823 \r
824     /**\r
825      * Method validate\r
826      * \r
827      */\r
828     public void validate()\r
829         throws org.exolab.castor.xml.ValidationException\r
830     {\r
831         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
832         validator.validate(this);\r
833     } //-- void validate() \r
834 \r
835 }\r