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