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