src/jalview/schemabinding/version2/Tree.java

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