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