JAL-2403 redundant 'implements' removed
[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   // - Constructors -/
166   // ----------------/
167
168   public Tree()
169   {
170     super();
171   }
172
173   // -----------/
174   // - Methods -/
175   // -----------/
176
177   /**
178      */
179   public void deleteCurrentTree()
180   {
181     this._has_currentTree = false;
182   }
183
184   /**
185      */
186   public void deleteFitToWindow()
187   {
188     this._has_fitToWindow = false;
189   }
190
191   /**
192      */
193   public void deleteFontSize()
194   {
195     this._has_fontSize = false;
196   }
197
198   /**
199      */
200   public void deleteFontStyle()
201   {
202     this._has_fontStyle = false;
203   }
204
205   /**
206      */
207   public void deleteHeight()
208   {
209     this._has_height = false;
210   }
211
212   /**
213      */
214   public void deleteMarkUnlinked()
215   {
216     this._has_markUnlinked = false;
217   }
218
219   /**
220      */
221   public void deleteShowBootstrap()
222   {
223     this._has_showBootstrap = false;
224   }
225
226   /**
227      */
228   public void deleteShowDistances()
229   {
230     this._has_showDistances = false;
231   }
232
233   /**
234      */
235   public void deleteThreshold()
236   {
237     this._has_threshold = false;
238   }
239
240   /**
241      */
242   public void deleteWidth()
243   {
244     this._has_width = false;
245   }
246
247   /**
248      */
249   public void deleteXpos()
250   {
251     this._has_xpos = false;
252   }
253
254   /**
255      */
256   public void deleteYpos()
257   {
258     this._has_ypos = false;
259   }
260
261   /**
262    * Returns the value of field 'currentTree'.
263    * 
264    * @return the value of field 'CurrentTree'.
265    */
266   public boolean getCurrentTree()
267   {
268     return this._currentTree;
269   }
270
271   /**
272    * Returns the value of field 'fitToWindow'.
273    * 
274    * @return the value of field 'FitToWindow'.
275    */
276   public boolean getFitToWindow()
277   {
278     return this._fitToWindow;
279   }
280
281   /**
282    * Returns the value of field 'fontName'.
283    * 
284    * @return the value of field 'FontName'.
285    */
286   public java.lang.String getFontName()
287   {
288     return this._fontName;
289   }
290
291   /**
292    * Returns the value of field 'fontSize'.
293    * 
294    * @return the value of field 'FontSize'.
295    */
296   public int getFontSize()
297   {
298     return this._fontSize;
299   }
300
301   /**
302    * Returns the value of field 'fontStyle'.
303    * 
304    * @return the value of field 'FontStyle'.
305    */
306   public int getFontStyle()
307   {
308     return this._fontStyle;
309   }
310
311   /**
312    * Returns the value of field 'height'.
313    * 
314    * @return the value of field 'Height'.
315    */
316   public int getHeight()
317   {
318     return this._height;
319   }
320
321   /**
322    * Returns the value of field 'markUnlinked'.
323    * 
324    * @return the value of field 'MarkUnlinked'.
325    */
326   public boolean getMarkUnlinked()
327   {
328     return this._markUnlinked;
329   }
330
331   /**
332    * Returns the value of field 'newick'.
333    * 
334    * @return the value of field 'Newick'.
335    */
336   public java.lang.String getNewick()
337   {
338     return this._newick;
339   }
340
341   /**
342    * Returns the value of field 'showBootstrap'.
343    * 
344    * @return the value of field 'ShowBootstrap'.
345    */
346   public boolean getShowBootstrap()
347   {
348     return this._showBootstrap;
349   }
350
351   /**
352    * Returns the value of field 'showDistances'.
353    * 
354    * @return the value of field 'ShowDistances'.
355    */
356   public boolean getShowDistances()
357   {
358     return this._showDistances;
359   }
360
361   /**
362    * Returns the value of field 'threshold'.
363    * 
364    * @return the value of field 'Threshold'.
365    */
366   public float getThreshold()
367   {
368     return this._threshold;
369   }
370
371   /**
372    * Returns the value of field 'title'.
373    * 
374    * @return the value of field 'Title'.
375    */
376   public java.lang.String getTitle()
377   {
378     return this._title;
379   }
380
381   /**
382    * Returns the value of field 'width'.
383    * 
384    * @return the value of field 'Width'.
385    */
386   public int getWidth()
387   {
388     return this._width;
389   }
390
391   /**
392    * Returns the value of field 'xpos'.
393    * 
394    * @return the value of field 'Xpos'.
395    */
396   public int getXpos()
397   {
398     return this._xpos;
399   }
400
401   /**
402    * Returns the value of field 'ypos'.
403    * 
404    * @return the value of field 'Ypos'.
405    */
406   public int getYpos()
407   {
408     return this._ypos;
409   }
410
411   /**
412    * Method hasCurrentTree.
413    * 
414    * @return true if at least one CurrentTree has been added
415    */
416   public boolean hasCurrentTree()
417   {
418     return this._has_currentTree;
419   }
420
421   /**
422    * Method hasFitToWindow.
423    * 
424    * @return true if at least one FitToWindow has been added
425    */
426   public boolean hasFitToWindow()
427   {
428     return this._has_fitToWindow;
429   }
430
431   /**
432    * Method hasFontSize.
433    * 
434    * @return true if at least one FontSize has been added
435    */
436   public boolean hasFontSize()
437   {
438     return this._has_fontSize;
439   }
440
441   /**
442    * Method hasFontStyle.
443    * 
444    * @return true if at least one FontStyle has been added
445    */
446   public boolean hasFontStyle()
447   {
448     return this._has_fontStyle;
449   }
450
451   /**
452    * Method hasHeight.
453    * 
454    * @return true if at least one Height has been added
455    */
456   public boolean hasHeight()
457   {
458     return this._has_height;
459   }
460
461   /**
462    * Method hasMarkUnlinked.
463    * 
464    * @return true if at least one MarkUnlinked has been added
465    */
466   public boolean hasMarkUnlinked()
467   {
468     return this._has_markUnlinked;
469   }
470
471   /**
472    * Method hasShowBootstrap.
473    * 
474    * @return true if at least one ShowBootstrap has been added
475    */
476   public boolean hasShowBootstrap()
477   {
478     return this._has_showBootstrap;
479   }
480
481   /**
482    * Method hasShowDistances.
483    * 
484    * @return true if at least one ShowDistances has been added
485    */
486   public boolean hasShowDistances()
487   {
488     return this._has_showDistances;
489   }
490
491   /**
492    * Method hasThreshold.
493    * 
494    * @return true if at least one Threshold has been added
495    */
496   public boolean hasThreshold()
497   {
498     return this._has_threshold;
499   }
500
501   /**
502    * Method hasWidth.
503    * 
504    * @return true if at least one Width has been added
505    */
506   public boolean hasWidth()
507   {
508     return this._has_width;
509   }
510
511   /**
512    * Method hasXpos.
513    * 
514    * @return true if at least one Xpos has been added
515    */
516   public boolean hasXpos()
517   {
518     return this._has_xpos;
519   }
520
521   /**
522    * Method hasYpos.
523    * 
524    * @return true if at least one Ypos has been added
525    */
526   public boolean hasYpos()
527   {
528     return this._has_ypos;
529   }
530
531   /**
532    * Returns the value of field 'currentTree'.
533    * 
534    * @return the value of field 'CurrentTree'.
535    */
536   public boolean isCurrentTree()
537   {
538     return this._currentTree;
539   }
540
541   /**
542    * Returns the value of field 'fitToWindow'.
543    * 
544    * @return the value of field 'FitToWindow'.
545    */
546   public boolean isFitToWindow()
547   {
548     return this._fitToWindow;
549   }
550
551   /**
552    * Returns the value of field 'markUnlinked'.
553    * 
554    * @return the value of field 'MarkUnlinked'.
555    */
556   public boolean isMarkUnlinked()
557   {
558     return this._markUnlinked;
559   }
560
561   /**
562    * Returns the value of field 'showBootstrap'.
563    * 
564    * @return the value of field 'ShowBootstrap'.
565    */
566   public boolean isShowBootstrap()
567   {
568     return this._showBootstrap;
569   }
570
571   /**
572    * Returns the value of field 'showDistances'.
573    * 
574    * @return the value of field 'ShowDistances'.
575    */
576   public boolean isShowDistances()
577   {
578     return this._showDistances;
579   }
580
581   /**
582    * Method isValid.
583    * 
584    * @return true if this object is valid according to the schema
585    */
586   public boolean isValid()
587   {
588     try
589     {
590       validate();
591     } catch (org.exolab.castor.xml.ValidationException vex)
592     {
593       return false;
594     }
595     return true;
596   }
597
598   /**
599    * 
600    * 
601    * @param out
602    * @throws org.exolab.castor.xml.MarshalException
603    *           if object is null or if any SAXException is thrown during
604    *           marshaling
605    * @throws org.exolab.castor.xml.ValidationException
606    *           if this object is an invalid instance according to the schema
607    */
608   public void marshal(final java.io.Writer out)
609           throws org.exolab.castor.xml.MarshalException,
610           org.exolab.castor.xml.ValidationException
611   {
612     Marshaller.marshal(this, out);
613   }
614
615   /**
616    * 
617    * 
618    * @param handler
619    * @throws java.io.IOException
620    *           if an IOException occurs during marshaling
621    * @throws org.exolab.castor.xml.ValidationException
622    *           if this object is an invalid instance according to the schema
623    * @throws org.exolab.castor.xml.MarshalException
624    *           if object is null or if any SAXException is thrown during
625    *           marshaling
626    */
627   public void marshal(final org.xml.sax.ContentHandler handler)
628           throws java.io.IOException,
629           org.exolab.castor.xml.MarshalException,
630           org.exolab.castor.xml.ValidationException
631   {
632     Marshaller.marshal(this, handler);
633   }
634
635   /**
636    * Sets the value of field 'currentTree'.
637    * 
638    * @param currentTree
639    *          the value of field 'currentTree'.
640    */
641   public void setCurrentTree(final boolean currentTree)
642   {
643     this._currentTree = currentTree;
644     this._has_currentTree = true;
645   }
646
647   /**
648    * Sets the value of field 'fitToWindow'.
649    * 
650    * @param fitToWindow
651    *          the value of field 'fitToWindow'.
652    */
653   public void setFitToWindow(final boolean fitToWindow)
654   {
655     this._fitToWindow = fitToWindow;
656     this._has_fitToWindow = true;
657   }
658
659   /**
660    * Sets the value of field 'fontName'.
661    * 
662    * @param fontName
663    *          the value of field 'fontName'.
664    */
665   public void setFontName(final java.lang.String fontName)
666   {
667     this._fontName = fontName;
668   }
669
670   /**
671    * Sets the value of field 'fontSize'.
672    * 
673    * @param fontSize
674    *          the value of field 'fontSize'.
675    */
676   public void setFontSize(final int fontSize)
677   {
678     this._fontSize = fontSize;
679     this._has_fontSize = true;
680   }
681
682   /**
683    * Sets the value of field 'fontStyle'.
684    * 
685    * @param fontStyle
686    *          the value of field 'fontStyle'.
687    */
688   public void setFontStyle(final int fontStyle)
689   {
690     this._fontStyle = fontStyle;
691     this._has_fontStyle = true;
692   }
693
694   /**
695    * Sets the value of field 'height'.
696    * 
697    * @param height
698    *          the value of field 'height'.
699    */
700   public void setHeight(final int height)
701   {
702     this._height = height;
703     this._has_height = true;
704   }
705
706   /**
707    * Sets the value of field 'markUnlinked'.
708    * 
709    * @param markUnlinked
710    *          the value of field 'markUnlinked'.
711    */
712   public void setMarkUnlinked(final boolean markUnlinked)
713   {
714     this._markUnlinked = markUnlinked;
715     this._has_markUnlinked = true;
716   }
717
718   /**
719    * Sets the value of field 'newick'.
720    * 
721    * @param newick
722    *          the value of field 'newick'.
723    */
724   public void setNewick(final java.lang.String newick)
725   {
726     this._newick = newick;
727   }
728
729   /**
730    * Sets the value of field 'showBootstrap'.
731    * 
732    * @param showBootstrap
733    *          the value of field 'showBootstrap'.
734    */
735   public void setShowBootstrap(final boolean showBootstrap)
736   {
737     this._showBootstrap = showBootstrap;
738     this._has_showBootstrap = true;
739   }
740
741   /**
742    * Sets the value of field 'showDistances'.
743    * 
744    * @param showDistances
745    *          the value of field 'showDistances'.
746    */
747   public void setShowDistances(final boolean showDistances)
748   {
749     this._showDistances = showDistances;
750     this._has_showDistances = true;
751   }
752
753   /**
754    * Sets the value of field 'threshold'.
755    * 
756    * @param threshold
757    *          the value of field 'threshold'.
758    */
759   public void setThreshold(final float threshold)
760   {
761     this._threshold = threshold;
762     this._has_threshold = true;
763   }
764
765   /**
766    * Sets the value of field 'title'.
767    * 
768    * @param title
769    *          the value of field 'title'.
770    */
771   public void setTitle(final java.lang.String title)
772   {
773     this._title = title;
774   }
775
776   /**
777    * Sets the value of field 'width'.
778    * 
779    * @param width
780    *          the value of field 'width'.
781    */
782   public void setWidth(final int width)
783   {
784     this._width = width;
785     this._has_width = true;
786   }
787
788   /**
789    * Sets the value of field 'xpos'.
790    * 
791    * @param xpos
792    *          the value of field 'xpos'.
793    */
794   public void setXpos(final int xpos)
795   {
796     this._xpos = xpos;
797     this._has_xpos = true;
798   }
799
800   /**
801    * Sets the value of field 'ypos'.
802    * 
803    * @param ypos
804    *          the value of field 'ypos'.
805    */
806   public void setYpos(final int ypos)
807   {
808     this._ypos = ypos;
809     this._has_ypos = true;
810   }
811
812   /**
813    * Method unmarshal.
814    * 
815    * @param reader
816    * @throws org.exolab.castor.xml.MarshalException
817    *           if object is null or if any SAXException is thrown during
818    *           marshaling
819    * @throws org.exolab.castor.xml.ValidationException
820    *           if this object is an invalid instance according to the schema
821    * @return the unmarshaled jalview.binding.Tree
822    */
823   public static jalview.binding.Tree unmarshal(final java.io.Reader reader)
824           throws org.exolab.castor.xml.MarshalException,
825           org.exolab.castor.xml.ValidationException
826   {
827     return (jalview.binding.Tree) Unmarshaller.unmarshal(
828             jalview.binding.Tree.class, reader);
829   }
830
831   /**
832    * 
833    * 
834    * @throws org.exolab.castor.xml.ValidationException
835    *           if this object is an invalid instance according to the schema
836    */
837   public void validate() throws org.exolab.castor.xml.ValidationException
838   {
839     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
840     validator.validate(this);
841   }
842
843 }