src/jalview/binding/Tree.java

   1 /*\r
   2  * This class was automatically generated with \r
   3  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
   4  * Schema.\r
   5  * $Id$\r
   6  */\r
   7 \r
   8 package jalview.binding;\r
   9 \r
  10   //---------------------------------/\r
  11  //- Imported classes and packages -/\r
  12 //---------------------------------/\r
  13 \r
  14 import java.io.IOException;\r
  15 import java.io.Reader;\r
  16 import java.io.Serializable;\r
  17 import java.io.Writer;\r
  18 import org.exolab.castor.xml.MarshalException;\r
  19 import org.exolab.castor.xml.Marshaller;\r
  20 import org.exolab.castor.xml.Unmarshaller;\r
  21 import org.exolab.castor.xml.ValidationException;\r
  22 import org.xml.sax.ContentHandler;\r
  23 \r
  24 /**\r
  25  * Class Tree.\r
  26  * \r
  27  * @version $Revision$ $Date$\r
  28  */\r
  29 public class Tree implements java.io.Serializable {\r
  30 \r
  31 \r
  32       //--------------------------/\r
  33      //- Class/Member Variables -/\r
  34     //--------------------------/\r
  35 \r
  36     /**\r
  37      * Field _width\r
  38      */\r
  39     private int _width;\r
  40 \r
  41     /**\r
  42      * keeps track of state for field: _width\r
  43      */\r
  44     private boolean _has_width;\r
  45 \r
  46     /**\r
  47      * Field _height\r
  48      */\r
  49     private int _height;\r
  50 \r
  51     /**\r
  52      * keeps track of state for field: _height\r
  53      */\r
  54     private boolean _has_height;\r
  55 \r
  56     /**\r
  57      * Field _xpos\r
  58      */\r
  59     private int _xpos;\r
  60 \r
  61     /**\r
  62      * keeps track of state for field: _xpos\r
  63      */\r
  64     private boolean _has_xpos;\r
  65 \r
  66     /**\r
  67      * Field _ypos\r
  68      */\r
  69     private int _ypos;\r
  70 \r
  71     /**\r
  72      * keeps track of state for field: _ypos\r
  73      */\r
  74     private boolean _has_ypos;\r
  75 \r
  76     /**\r
  77      * Field _fontSize\r
  78      */\r
  79     private int _fontSize;\r
  80 \r
  81     /**\r
  82      * keeps track of state for field: _fontSize\r
  83      */\r
  84     private boolean _has_fontSize;\r
  85 \r
  86     /**\r
  87      * Field _threshold\r
  88      */\r
  89     private float _threshold;\r
  90 \r
  91     /**\r
  92      * keeps track of state for field: _threshold\r
  93      */\r
  94     private boolean _has_threshold;\r
  95 \r
  96     /**\r
  97      * Field _showBootstrap\r
  98      */\r
  99     private boolean _showBootstrap;\r
 100 \r
 101     /**\r
 102      * keeps track of state for field: _showBootstrap\r
 103      */\r
 104     private boolean _has_showBootstrap;\r
 105 \r
 106     /**\r
 107      * Field _showDistances\r
 108      */\r
 109     private boolean _showDistances;\r
 110 \r
 111     /**\r
 112      * keeps track of state for field: _showDistances\r
 113      */\r
 114     private boolean _has_showDistances;\r
 115 \r
 116     /**\r
 117      * Field _markUnlinked\r
 118      */\r
 119     private boolean _markUnlinked;\r
 120 \r
 121     /**\r
 122      * keeps track of state for field: _markUnlinked\r
 123      */\r
 124     private boolean _has_markUnlinked;\r
 125 \r
 126     /**\r
 127      * Field _fitToWindow\r
 128      */\r
 129     private boolean _fitToWindow;\r
 130 \r
 131     /**\r
 132      * keeps track of state for field: _fitToWindow\r
 133      */\r
 134     private boolean _has_fitToWindow;\r
 135 \r
 136     /**\r
 137      * Field _currentTree\r
 138      */\r
 139     private boolean _currentTree;\r
 140 \r
 141     /**\r
 142      * keeps track of state for field: _currentTree\r
 143      */\r
 144     private boolean _has_currentTree;\r
 145 \r
 146     /**\r
 147      * Field _title\r
 148      */\r
 149     private java.lang.String _title;\r
 150 \r
 151     /**\r
 152      * Field _newick\r
 153      */\r
 154     private java.lang.String _newick;\r
 155 \r
 156 \r
 157       //----------------/\r
 158      //- Constructors -/\r
 159     //----------------/\r
 160 \r
 161     public Tree() {\r
 162         super();\r
 163     } //-- jalview.binding.Tree()\r
 164 \r
 165 \r
 166       //-----------/\r
 167      //- Methods -/\r
 168     //-----------/\r
 169 \r
 170     /**\r
 171      * Method deleteCurrentTree\r
 172      * \r
 173      */\r
 174     public void deleteCurrentTree()\r
 175     {\r
 176         this._has_currentTree= false;\r
 177     } //-- void deleteCurrentTree() \r
 178 \r
 179     /**\r
 180      * Method deleteFitToWindow\r
 181      * \r
 182      */\r
 183     public void deleteFitToWindow()\r
 184     {\r
 185         this._has_fitToWindow= false;\r
 186     } //-- void deleteFitToWindow() \r
 187 \r
 188     /**\r
 189      * Method deleteFontSize\r
 190      * \r
 191      */\r
 192     public void deleteFontSize()\r
 193     {\r
 194         this._has_fontSize= false;\r
 195     } //-- void deleteFontSize() \r
 196 \r
 197     /**\r
 198      * Method deleteHeight\r
 199      * \r
 200      */\r
 201     public void deleteHeight()\r
 202     {\r
 203         this._has_height= false;\r
 204     } //-- void deleteHeight() \r
 205 \r
 206     /**\r
 207      * Method deleteMarkUnlinked\r
 208      * \r
 209      */\r
 210     public void deleteMarkUnlinked()\r
 211     {\r
 212         this._has_markUnlinked= false;\r
 213     } //-- void deleteMarkUnlinked() \r
 214 \r
 215     /**\r
 216      * Method deleteShowBootstrap\r
 217      * \r
 218      */\r
 219     public void deleteShowBootstrap()\r
 220     {\r
 221         this._has_showBootstrap= false;\r
 222     } //-- void deleteShowBootstrap() \r
 223 \r
 224     /**\r
 225      * Method deleteShowDistances\r
 226      * \r
 227      */\r
 228     public void deleteShowDistances()\r
 229     {\r
 230         this._has_showDistances= false;\r
 231     } //-- void deleteShowDistances() \r
 232 \r
 233     /**\r
 234      * Method deleteThreshold\r
 235      * \r
 236      */\r
 237     public void deleteThreshold()\r
 238     {\r
 239         this._has_threshold= false;\r
 240     } //-- void deleteThreshold() \r
 241 \r
 242     /**\r
 243      * Method deleteWidth\r
 244      * \r
 245      */\r
 246     public void deleteWidth()\r
 247     {\r
 248         this._has_width= false;\r
 249     } //-- void deleteWidth() \r
 250 \r
 251     /**\r
 252      * Method deleteXpos\r
 253      * \r
 254      */\r
 255     public void deleteXpos()\r
 256     {\r
 257         this._has_xpos= false;\r
 258     } //-- void deleteXpos() \r
 259 \r
 260     /**\r
 261      * Method deleteYpos\r
 262      * \r
 263      */\r
 264     public void deleteYpos()\r
 265     {\r
 266         this._has_ypos= false;\r
 267     } //-- void deleteYpos() \r
 268 \r
 269     /**\r
 270      * Returns the value of field 'currentTree'.\r
 271      * \r
 272      * @return boolean\r
 273      * @return the value of field 'currentTree'.\r
 274      */\r
 275     public boolean getCurrentTree()\r
 276     {\r
 277         return this._currentTree;\r
 278     } //-- boolean getCurrentTree() \r
 279 \r
 280     /**\r
 281      * Returns the value of field 'fitToWindow'.\r
 282      * \r
 283      * @return boolean\r
 284      * @return the value of field 'fitToWindow'.\r
 285      */\r
 286     public boolean getFitToWindow()\r
 287     {\r
 288         return this._fitToWindow;\r
 289     } //-- boolean getFitToWindow() \r
 290 \r
 291     /**\r
 292      * Returns the value of field 'fontSize'.\r
 293      * \r
 294      * @return int\r
 295      * @return the value of field 'fontSize'.\r
 296      */\r
 297     public int getFontSize()\r
 298     {\r
 299         return this._fontSize;\r
 300     } //-- int getFontSize() \r
 301 \r
 302     /**\r
 303      * Returns the value of field 'height'.\r
 304      * \r
 305      * @return int\r
 306      * @return the value of field 'height'.\r
 307      */\r
 308     public int getHeight()\r
 309     {\r
 310         return this._height;\r
 311     } //-- int getHeight() \r
 312 \r
 313     /**\r
 314      * Returns the value of field 'markUnlinked'.\r
 315      * \r
 316      * @return boolean\r
 317      * @return the value of field 'markUnlinked'.\r
 318      */\r
 319     public boolean getMarkUnlinked()\r
 320     {\r
 321         return this._markUnlinked;\r
 322     } //-- boolean getMarkUnlinked() \r
 323 \r
 324     /**\r
 325      * Returns the value of field 'newick'.\r
 326      * \r
 327      * @return String\r
 328      * @return the value of field 'newick'.\r
 329      */\r
 330     public java.lang.String getNewick()\r
 331     {\r
 332         return this._newick;\r
 333     } //-- java.lang.String getNewick() \r
 334 \r
 335     /**\r
 336      * Returns the value of field 'showBootstrap'.\r
 337      * \r
 338      * @return boolean\r
 339      * @return the value of field 'showBootstrap'.\r
 340      */\r
 341     public boolean getShowBootstrap()\r
 342     {\r
 343         return this._showBootstrap;\r
 344     } //-- boolean getShowBootstrap() \r
 345 \r
 346     /**\r
 347      * Returns the value of field 'showDistances'.\r
 348      * \r
 349      * @return boolean\r
 350      * @return the value of field 'showDistances'.\r
 351      */\r
 352     public boolean getShowDistances()\r
 353     {\r
 354         return this._showDistances;\r
 355     } //-- boolean getShowDistances() \r
 356 \r
 357     /**\r
 358      * Returns the value of field 'threshold'.\r
 359      * \r
 360      * @return float\r
 361      * @return the value of field 'threshold'.\r
 362      */\r
 363     public float getThreshold()\r
 364     {\r
 365         return this._threshold;\r
 366     } //-- float getThreshold() \r
 367 \r
 368     /**\r
 369      * Returns the value of field 'title'.\r
 370      * \r
 371      * @return String\r
 372      * @return the value of field 'title'.\r
 373      */\r
 374     public java.lang.String getTitle()\r
 375     {\r
 376         return this._title;\r
 377     } //-- java.lang.String getTitle() \r
 378 \r
 379     /**\r
 380      * Returns the value of field 'width'.\r
 381      * \r
 382      * @return int\r
 383      * @return the value of field 'width'.\r
 384      */\r
 385     public int getWidth()\r
 386     {\r
 387         return this._width;\r
 388     } //-- int getWidth() \r
 389 \r
 390     /**\r
 391      * Returns the value of field 'xpos'.\r
 392      * \r
 393      * @return int\r
 394      * @return the value of field 'xpos'.\r
 395      */\r
 396     public int getXpos()\r
 397     {\r
 398         return this._xpos;\r
 399     } //-- int getXpos() \r
 400 \r
 401     /**\r
 402      * Returns the value of field 'ypos'.\r
 403      * \r
 404      * @return int\r
 405      * @return the value of field 'ypos'.\r
 406      */\r
 407     public int getYpos()\r
 408     {\r
 409         return this._ypos;\r
 410     } //-- int getYpos() \r
 411 \r
 412     /**\r
 413      * Method hasCurrentTree\r
 414      * \r
 415      * \r
 416      * \r
 417      * @return boolean\r
 418      */\r
 419     public boolean hasCurrentTree()\r
 420     {\r
 421         return this._has_currentTree;\r
 422     } //-- boolean hasCurrentTree() \r
 423 \r
 424     /**\r
 425      * Method hasFitToWindow\r
 426      * \r
 427      * \r
 428      * \r
 429      * @return boolean\r
 430      */\r
 431     public boolean hasFitToWindow()\r
 432     {\r
 433         return this._has_fitToWindow;\r
 434     } //-- boolean hasFitToWindow() \r
 435 \r
 436     /**\r
 437      * Method hasFontSize\r
 438      * \r
 439      * \r
 440      * \r
 441      * @return boolean\r
 442      */\r
 443     public boolean hasFontSize()\r
 444     {\r
 445         return this._has_fontSize;\r
 446     } //-- boolean hasFontSize() \r
 447 \r
 448     /**\r
 449      * Method hasHeight\r
 450      * \r
 451      * \r
 452      * \r
 453      * @return boolean\r
 454      */\r
 455     public boolean hasHeight()\r
 456     {\r
 457         return this._has_height;\r
 458     } //-- boolean hasHeight() \r
 459 \r
 460     /**\r
 461      * Method hasMarkUnlinked\r
 462      * \r
 463      * \r
 464      * \r
 465      * @return boolean\r
 466      */\r
 467     public boolean hasMarkUnlinked()\r
 468     {\r
 469         return this._has_markUnlinked;\r
 470     } //-- boolean hasMarkUnlinked() \r
 471 \r
 472     /**\r
 473      * Method hasShowBootstrap\r
 474      * \r
 475      * \r
 476      * \r
 477      * @return boolean\r
 478      */\r
 479     public boolean hasShowBootstrap()\r
 480     {\r
 481         return this._has_showBootstrap;\r
 482     } //-- boolean hasShowBootstrap() \r
 483 \r
 484     /**\r
 485      * Method hasShowDistances\r
 486      * \r
 487      * \r
 488      * \r
 489      * @return boolean\r
 490      */\r
 491     public boolean hasShowDistances()\r
 492     {\r
 493         return this._has_showDistances;\r
 494     } //-- boolean hasShowDistances() \r
 495 \r
 496     /**\r
 497      * Method hasThreshold\r
 498      * \r
 499      * \r
 500      * \r
 501      * @return boolean\r
 502      */\r
 503     public boolean hasThreshold()\r
 504     {\r
 505         return this._has_threshold;\r
 506     } //-- boolean hasThreshold() \r
 507 \r
 508     /**\r
 509      * Method hasWidth\r
 510      * \r
 511      * \r
 512      * \r
 513      * @return boolean\r
 514      */\r
 515     public boolean hasWidth()\r
 516     {\r
 517         return this._has_width;\r
 518     } //-- boolean hasWidth() \r
 519 \r
 520     /**\r
 521      * Method hasXpos\r
 522      * \r
 523      * \r
 524      * \r
 525      * @return boolean\r
 526      */\r
 527     public boolean hasXpos()\r
 528     {\r
 529         return this._has_xpos;\r
 530     } //-- boolean hasXpos() \r
 531 \r
 532     /**\r
 533      * Method hasYpos\r
 534      * \r
 535      * \r
 536      * \r
 537      * @return boolean\r
 538      */\r
 539     public boolean hasYpos()\r
 540     {\r
 541         return this._has_ypos;\r
 542     } //-- boolean hasYpos() \r
 543 \r
 544     /**\r
 545      * Method isValid\r
 546      * \r
 547      * \r
 548      * \r
 549      * @return boolean\r
 550      */\r
 551     public boolean isValid()\r
 552     {\r
 553         try {\r
 554             validate();\r
 555         }\r
 556         catch (org.exolab.castor.xml.ValidationException vex) {\r
 557             return false;\r
 558         }\r
 559         return true;\r
 560     } //-- boolean isValid() \r
 561 \r
 562     /**\r
 563      * Method marshal\r
 564      * \r
 565      * \r
 566      * \r
 567      * @param out\r
 568      */\r
 569     public void marshal(java.io.Writer out)\r
 570         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 571     {\r
 572         \r
 573         Marshaller.marshal(this, out);\r
 574     } //-- void marshal(java.io.Writer) \r
 575 \r
 576     /**\r
 577      * Method marshal\r
 578      * \r
 579      * \r
 580      * \r
 581      * @param handler\r
 582      */\r
 583     public void marshal(org.xml.sax.ContentHandler handler)\r
 584         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 585     {\r
 586         \r
 587         Marshaller.marshal(this, handler);\r
 588     } //-- void marshal(org.xml.sax.ContentHandler) \r
 589 \r
 590     /**\r
 591      * Sets the value of field 'currentTree'.\r
 592      * \r
 593      * @param currentTree the value of field 'currentTree'.\r
 594      */\r
 595     public void setCurrentTree(boolean currentTree)\r
 596     {\r
 597         this._currentTree = currentTree;\r
 598         this._has_currentTree = true;\r
 599     } //-- void setCurrentTree(boolean) \r
 600 \r
 601     /**\r
 602      * Sets the value of field 'fitToWindow'.\r
 603      * \r
 604      * @param fitToWindow the value of field 'fitToWindow'.\r
 605      */\r
 606     public void setFitToWindow(boolean fitToWindow)\r
 607     {\r
 608         this._fitToWindow = fitToWindow;\r
 609         this._has_fitToWindow = true;\r
 610     } //-- void setFitToWindow(boolean) \r
 611 \r
 612     /**\r
 613      * Sets the value of field 'fontSize'.\r
 614      * \r
 615      * @param fontSize the value of field 'fontSize'.\r
 616      */\r
 617     public void setFontSize(int fontSize)\r
 618     {\r
 619         this._fontSize = fontSize;\r
 620         this._has_fontSize = true;\r
 621     } //-- void setFontSize(int) \r
 622 \r
 623     /**\r
 624      * Sets the value of field 'height'.\r
 625      * \r
 626      * @param height the value of field 'height'.\r
 627      */\r
 628     public void setHeight(int height)\r
 629     {\r
 630         this._height = height;\r
 631         this._has_height = true;\r
 632     } //-- void setHeight(int) \r
 633 \r
 634     /**\r
 635      * Sets the value of field 'markUnlinked'.\r
 636      * \r
 637      * @param markUnlinked the value of field 'markUnlinked'.\r
 638      */\r
 639     public void setMarkUnlinked(boolean markUnlinked)\r
 640     {\r
 641         this._markUnlinked = markUnlinked;\r
 642         this._has_markUnlinked = true;\r
 643     } //-- void setMarkUnlinked(boolean) \r
 644 \r
 645     /**\r
 646      * Sets the value of field 'newick'.\r
 647      * \r
 648      * @param newick the value of field 'newick'.\r
 649      */\r
 650     public void setNewick(java.lang.String newick)\r
 651     {\r
 652         this._newick = newick;\r
 653     } //-- void setNewick(java.lang.String) \r
 654 \r
 655     /**\r
 656      * Sets the value of field 'showBootstrap'.\r
 657      * \r
 658      * @param showBootstrap the value of field 'showBootstrap'.\r
 659      */\r
 660     public void setShowBootstrap(boolean showBootstrap)\r
 661     {\r
 662         this._showBootstrap = showBootstrap;\r
 663         this._has_showBootstrap = true;\r
 664     } //-- void setShowBootstrap(boolean) \r
 665 \r
 666     /**\r
 667      * Sets the value of field 'showDistances'.\r
 668      * \r
 669      * @param showDistances the value of field 'showDistances'.\r
 670      */\r
 671     public void setShowDistances(boolean showDistances)\r
 672     {\r
 673         this._showDistances = showDistances;\r
 674         this._has_showDistances = true;\r
 675     } //-- void setShowDistances(boolean) \r
 676 \r
 677     /**\r
 678      * Sets the value of field 'threshold'.\r
 679      * \r
 680      * @param threshold the value of field 'threshold'.\r
 681      */\r
 682     public void setThreshold(float threshold)\r
 683     {\r
 684         this._threshold = threshold;\r
 685         this._has_threshold = true;\r
 686     } //-- void setThreshold(float) \r
 687 \r
 688     /**\r
 689      * Sets the value of field 'title'.\r
 690      * \r
 691      * @param title the value of field 'title'.\r
 692      */\r
 693     public void setTitle(java.lang.String title)\r
 694     {\r
 695         this._title = title;\r
 696     } //-- void setTitle(java.lang.String) \r
 697 \r
 698     /**\r
 699      * Sets the value of field 'width'.\r
 700      * \r
 701      * @param width the value of field 'width'.\r
 702      */\r
 703     public void setWidth(int width)\r
 704     {\r
 705         this._width = width;\r
 706         this._has_width = true;\r
 707     } //-- void setWidth(int) \r
 708 \r
 709     /**\r
 710      * Sets the value of field 'xpos'.\r
 711      * \r
 712      * @param xpos the value of field 'xpos'.\r
 713      */\r
 714     public void setXpos(int xpos)\r
 715     {\r
 716         this._xpos = xpos;\r
 717         this._has_xpos = true;\r
 718     } //-- void setXpos(int) \r
 719 \r
 720     /**\r
 721      * Sets the value of field 'ypos'.\r
 722      * \r
 723      * @param ypos the value of field 'ypos'.\r
 724      */\r
 725     public void setYpos(int ypos)\r
 726     {\r
 727         this._ypos = ypos;\r
 728         this._has_ypos = true;\r
 729     } //-- void setYpos(int) \r
 730 \r
 731     /**\r
 732      * Method unmarshal\r
 733      * \r
 734      * \r
 735      * \r
 736      * @param reader\r
 737      * @return Object\r
 738      */\r
 739     public static java.lang.Object unmarshal(java.io.Reader reader)\r
 740         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 741     {\r
 742         return (jalview.binding.Tree) Unmarshaller.unmarshal(jalview.binding.Tree.class, reader);\r
 743     } //-- java.lang.Object unmarshal(java.io.Reader) \r
 744 \r
 745     /**\r
 746      * Method validate\r
 747      * \r
 748      */\r
 749     public void validate()\r
 750         throws org.exolab.castor.xml.ValidationException\r
 751     {\r
 752         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 753         validator.validate(this);\r
 754     } //-- void validate() \r
 755 \r
 756 }\r