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