src/jalview/schemabinding/version2/StructureState.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 StructureState.
  19  *
  20  * @version $Revision$ $Date$
  21  */
  22 public class StructureState implements java.io.Serializable {
  23
  24
  25       //--------------------------/
  26      //- Class/Member Variables -/
  27     //--------------------------/
  28
  29     /**
  30      * internal content storage
  31      */
  32     private java.lang.String _content = "";
  33
  34     /**
  35      * Field _visible.
  36      */
  37     private boolean _visible;
  38
  39     /**
  40      * keeps track of state for field: _visible
  41      */
  42     private boolean _has_visible;
  43
  44     /**
  45      * additional
  46      *  identifier
  47      *  which
  48      *  properly
  49      *  disambiguates
  50      *  the
  51      *  structure
  52      *  view
  53      *  from
  54      *  any
  55      *  other
  56      *  view
  57      *  with
  58      *  the
  59      *  same
  60      *  attributes.
  61      *  This
  62      *  is
  63      *  not
  64      *  an
  65      *  ID,
  66      *  because
  67      *  it
  68      *  is
  69      *  possible
  70      *  to
  71      *  have
  72      *  many
  73      *  references
  74      *  to
  75      *  the
  76      *  same
  77      *  physical
  78      *  structure
  79      *  view
  80      *  from
  81      *  different
  82      *  sequences
  83      *  in
  84      *  an
  85      *  alignment.
  86      *  A
  87      *  structureState
  88      *  element
  89      *  citing
  90      *  the
  91      *  same
  92      *  viewId
  93      *  will
  94      *  appear
  95      *  for
  96      *  each
  97      *  instance.
  98      *
  99      */
 100     private java.lang.String _viewId;
 101
 102     /**
 103      * Flag
 104      *  set
 105      *  if
 106      *  the
 107      *  alignment
 108      *  panel
 109      *  containing
 110      *  this
 111      *  JSeq
 112      *  should
 113      *  be
 114      *  included
 115      *  in
 116      *  those
 117      *  used
 118      *  to
 119      *  perform
 120      *  a
 121      *  structure
 122      *  superposition
 123      *  (since
 124      *  Jalview
 125      *  2.7).
 126      *
 127      */
 128     private boolean _alignwithAlignPanel = true;
 129
 130     /**
 131      * keeps track of state for field: _alignwithAlignPanel
 132      */
 133     private boolean _has_alignwithAlignPanel;
 134
 135     /**
 136      * Flag
 137      *  set
 138      *  if
 139      *  the
 140      *  alignment
 141      *  panel
 142      *  containing
 143      *  this
 144      *  JSeq
 145      *  should
 146      *  be
 147      *  included
 148      *  in
 149      *  those
 150      *  used
 151      *  to
 152      *  colour
 153      *  its
 154      *  associated
 155      *  sequences
 156      *  in
 157      *  this
 158      *  structureState(since
 159      *  Jalview
 160      *  2.7).
 161      *
 162      */
 163     private boolean _colourwithAlignPanel = false;
 164
 165     /**
 166      * keeps track of state for field: _colourwithAlignPanel
 167      */
 168     private boolean _has_colourwithAlignPanel;
 169
 170     /**
 171      * Flag
 172      *  set
 173      *  if
 174      *  the
 175      *  structure
 176      *  display
 177      *  is
 178      *  coloured
 179      *  by
 180      *  the
 181      *  Jmol
 182      *  state,
 183      *  rather
 184      *  than
 185      *  by
 186      *  one
 187      *  or
 188      *  more
 189      *  linked
 190      *  alignment
 191      *  views.
 192      *
 193      */
 194     private boolean _colourByJmol = true;
 195
 196     /**
 197      * keeps track of state for field: _colourByJmol
 198      */
 199     private boolean _has_colourByJmol;
 200
 201     /**
 202      * Field _width.
 203      */
 204     private int _width;
 205
 206     /**
 207      * keeps track of state for field: _width
 208      */
 209     private boolean _has_width;
 210
 211     /**
 212      * Field _height.
 213      */
 214     private int _height;
 215
 216     /**
 217      * keeps track of state for field: _height
 218      */
 219     private boolean _has_height;
 220
 221     /**
 222      * Field _xpos.
 223      */
 224     private int _xpos;
 225
 226     /**
 227      * keeps track of state for field: _xpos
 228      */
 229     private boolean _has_xpos;
 230
 231     /**
 232      * Field _ypos.
 233      */
 234     private int _ypos;
 235
 236     /**
 237      * keeps track of state for field: _ypos
 238      */
 239     private boolean _has_ypos;
 240
 241
 242       //----------------/
 243      //- Constructors -/
 244     //----------------/
 245
 246     public StructureState() {
 247         super();
 248         setContent("");
 249     }
 250
 251
 252       //-----------/
 253      //- Methods -/
 254     //-----------/
 255
 256     /**
 257      */
 258     public void deleteAlignwithAlignPanel(
 259     ) {
 260         this._has_alignwithAlignPanel= false;
 261     }
 262
 263     /**
 264      */
 265     public void deleteColourByJmol(
 266     ) {
 267         this._has_colourByJmol= false;
 268     }
 269
 270     /**
 271      */
 272     public void deleteColourwithAlignPanel(
 273     ) {
 274         this._has_colourwithAlignPanel= false;
 275     }
 276
 277     /**
 278      */
 279     public void deleteHeight(
 280     ) {
 281         this._has_height= false;
 282     }
 283
 284     /**
 285      */
 286     public void deleteVisible(
 287     ) {
 288         this._has_visible= false;
 289     }
 290
 291     /**
 292      */
 293     public void deleteWidth(
 294     ) {
 295         this._has_width= false;
 296     }
 297
 298     /**
 299      */
 300     public void deleteXpos(
 301     ) {
 302         this._has_xpos= false;
 303     }
 304
 305     /**
 306      */
 307     public void deleteYpos(
 308     ) {
 309         this._has_ypos= false;
 310     }
 311
 312     /**
 313      * Returns the value of field 'alignwithAlignPanel'. The field
 314      * 'alignwithAlignPanel' has the following description: Flag
 315      *  set
 316      *  if
 317      *  the
 318      *  alignment
 319      *  panel
 320      *  containing
 321      *  this
 322      *  JSeq
 323      *  should
 324      *  be
 325      *  included
 326      *  in
 327      *  those
 328      *  used
 329      *  to
 330      *  perform
 331      *  a
 332      *  structure
 333      *  superposition
 334      *  (since
 335      *  Jalview
 336      *  2.7).
 337      *
 338      *
 339      * @return the value of field 'AlignwithAlignPanel'.
 340      */
 341     public boolean getAlignwithAlignPanel(
 342     ) {
 343         return this._alignwithAlignPanel;
 344     }
 345
 346     /**
 347      * Returns the value of field 'colourByJmol'. The field
 348      * 'colourByJmol' has the following description: Flag
 349      *  set
 350      *  if
 351      *  the
 352      *  structure
 353      *  display
 354      *  is
 355      *  coloured
 356      *  by
 357      *  the
 358      *  Jmol
 359      *  state,
 360      *  rather
 361      *  than
 362      *  by
 363      *  one
 364      *  or
 365      *  more
 366      *  linked
 367      *  alignment
 368      *  views.
 369      *
 370      *
 371      * @return the value of field 'ColourByJmol'.
 372      */
 373     public boolean getColourByJmol(
 374     ) {
 375         return this._colourByJmol;
 376     }
 377
 378     /**
 379      * Returns the value of field 'colourwithAlignPanel'. The field
 380      * 'colourwithAlignPanel' has the following description: Flag
 381      *  set
 382      *  if
 383      *  the
 384      *  alignment
 385      *  panel
 386      *  containing
 387      *  this
 388      *  JSeq
 389      *  should
 390      *  be
 391      *  included
 392      *  in
 393      *  those
 394      *  used
 395      *  to
 396      *  colour
 397      *  its
 398      *  associated
 399      *  sequences
 400      *  in
 401      *  this
 402      *  structureState(since
 403      *  Jalview
 404      *  2.7).
 405      *
 406      *
 407      * @return the value of field 'ColourwithAlignPanel'.
 408      */
 409     public boolean getColourwithAlignPanel(
 410     ) {
 411         return this._colourwithAlignPanel;
 412     }
 413
 414     /**
 415      * Returns the value of field 'content'. The field 'content'
 416      * has the following description: internal content storage
 417      *
 418      * @return the value of field 'Content'.
 419      */
 420     public java.lang.String getContent(
 421     ) {
 422         return this._content;
 423     }
 424
 425     /**
 426      * Returns the value of field 'height'.
 427      *
 428      * @return the value of field 'Height'.
 429      */
 430     public int getHeight(
 431     ) {
 432         return this._height;
 433     }
 434
 435     /**
 436      * Returns the value of field 'viewId'. The field 'viewId' has
 437      * the following description: additional
 438      *  identifier
 439      *  which
 440      *  properly
 441      *  disambiguates
 442      *  the
 443      *  structure
 444      *  view
 445      *  from
 446      *  any
 447      *  other
 448      *  view
 449      *  with
 450      *  the
 451      *  same
 452      *  attributes.
 453      *  This
 454      *  is
 455      *  not
 456      *  an
 457      *  ID,
 458      *  because
 459      *  it
 460      *  is
 461      *  possible
 462      *  to
 463      *  have
 464      *  many
 465      *  references
 466      *  to
 467      *  the
 468      *  same
 469      *  physical
 470      *  structure
 471      *  view
 472      *  from
 473      *  different
 474      *  sequences
 475      *  in
 476      *  an
 477      *  alignment.
 478      *  A
 479      *  structureState
 480      *  element
 481      *  citing
 482      *  the
 483      *  same
 484      *  viewId
 485      *  will
 486      *  appear
 487      *  for
 488      *  each
 489      *  instance.
 490      *
 491      *
 492      * @return the value of field 'ViewId'.
 493      */
 494     public java.lang.String getViewId(
 495     ) {
 496         return this._viewId;
 497     }
 498
 499     /**
 500      * Returns the value of field 'visible'.
 501      *
 502      * @return the value of field 'Visible'.
 503      */
 504     public boolean getVisible(
 505     ) {
 506         return this._visible;
 507     }
 508
 509     /**
 510      * Returns the value of field 'width'.
 511      *
 512      * @return the value of field 'Width'.
 513      */
 514     public int getWidth(
 515     ) {
 516         return this._width;
 517     }
 518
 519     /**
 520      * Returns the value of field 'xpos'.
 521      *
 522      * @return the value of field 'Xpos'.
 523      */
 524     public int getXpos(
 525     ) {
 526         return this._xpos;
 527     }
 528
 529     /**
 530      * Returns the value of field 'ypos'.
 531      *
 532      * @return the value of field 'Ypos'.
 533      */
 534     public int getYpos(
 535     ) {
 536         return this._ypos;
 537     }
 538
 539     /**
 540      * Method hasAlignwithAlignPanel.
 541      *
 542      * @return true if at least one AlignwithAlignPanel has been
 543      * added
 544      */
 545     public boolean hasAlignwithAlignPanel(
 546     ) {
 547         return this._has_alignwithAlignPanel;
 548     }
 549
 550     /**
 551      * Method hasColourByJmol.
 552      *
 553      * @return true if at least one ColourByJmol has been added
 554      */
 555     public boolean hasColourByJmol(
 556     ) {
 557         return this._has_colourByJmol;
 558     }
 559
 560     /**
 561      * Method hasColourwithAlignPanel.
 562      *
 563      * @return true if at least one ColourwithAlignPanel has been
 564      * added
 565      */
 566     public boolean hasColourwithAlignPanel(
 567     ) {
 568         return this._has_colourwithAlignPanel;
 569     }
 570
 571     /**
 572      * Method hasHeight.
 573      *
 574      * @return true if at least one Height has been added
 575      */
 576     public boolean hasHeight(
 577     ) {
 578         return this._has_height;
 579     }
 580
 581     /**
 582      * Method hasVisible.
 583      *
 584      * @return true if at least one Visible has been added
 585      */
 586     public boolean hasVisible(
 587     ) {
 588         return this._has_visible;
 589     }
 590
 591     /**
 592      * Method hasWidth.
 593      *
 594      * @return true if at least one Width has been added
 595      */
 596     public boolean hasWidth(
 597     ) {
 598         return this._has_width;
 599     }
 600
 601     /**
 602      * Method hasXpos.
 603      *
 604      * @return true if at least one Xpos has been added
 605      */
 606     public boolean hasXpos(
 607     ) {
 608         return this._has_xpos;
 609     }
 610
 611     /**
 612      * Method hasYpos.
 613      *
 614      * @return true if at least one Ypos has been added
 615      */
 616     public boolean hasYpos(
 617     ) {
 618         return this._has_ypos;
 619     }
 620
 621     /**
 622      * Returns the value of field 'alignwithAlignPanel'. The field
 623      * 'alignwithAlignPanel' has the following description: Flag
 624      *  set
 625      *  if
 626      *  the
 627      *  alignment
 628      *  panel
 629      *  containing
 630      *  this
 631      *  JSeq
 632      *  should
 633      *  be
 634      *  included
 635      *  in
 636      *  those
 637      *  used
 638      *  to
 639      *  perform
 640      *  a
 641      *  structure
 642      *  superposition
 643      *  (since
 644      *  Jalview
 645      *  2.7).
 646      *
 647      *
 648      * @return the value of field 'AlignwithAlignPanel'.
 649      */
 650     public boolean isAlignwithAlignPanel(
 651     ) {
 652         return this._alignwithAlignPanel;
 653     }
 654
 655     /**
 656      * Returns the value of field 'colourByJmol'. The field
 657      * 'colourByJmol' has the following description: Flag
 658      *  set
 659      *  if
 660      *  the
 661      *  structure
 662      *  display
 663      *  is
 664      *  coloured
 665      *  by
 666      *  the
 667      *  Jmol
 668      *  state,
 669      *  rather
 670      *  than
 671      *  by
 672      *  one
 673      *  or
 674      *  more
 675      *  linked
 676      *  alignment
 677      *  views.
 678      *
 679      *
 680      * @return the value of field 'ColourByJmol'.
 681      */
 682     public boolean isColourByJmol(
 683     ) {
 684         return this._colourByJmol;
 685     }
 686
 687     /**
 688      * Returns the value of field 'colourwithAlignPanel'. The field
 689      * 'colourwithAlignPanel' has the following description: Flag
 690      *  set
 691      *  if
 692      *  the
 693      *  alignment
 694      *  panel
 695      *  containing
 696      *  this
 697      *  JSeq
 698      *  should
 699      *  be
 700      *  included
 701      *  in
 702      *  those
 703      *  used
 704      *  to
 705      *  colour
 706      *  its
 707      *  associated
 708      *  sequences
 709      *  in
 710      *  this
 711      *  structureState(since
 712      *  Jalview
 713      *  2.7).
 714      *
 715      *
 716      * @return the value of field 'ColourwithAlignPanel'.
 717      */
 718     public boolean isColourwithAlignPanel(
 719     ) {
 720         return this._colourwithAlignPanel;
 721     }
 722
 723     /**
 724      * Method isValid.
 725      *
 726      * @return true if this object is valid according to the schema
 727      */
 728     public boolean isValid(
 729     ) {
 730         try {
 731             validate();
 732         } catch (org.exolab.castor.xml.ValidationException vex) {
 733             return false;
 734         }
 735         return true;
 736     }
 737
 738     /**
 739      * Returns the value of field 'visible'.
 740      *
 741      * @return the value of field 'Visible'.
 742      */
 743     public boolean isVisible(
 744     ) {
 745         return this._visible;
 746     }
 747
 748     /**
 749      *
 750      *
 751      * @param out
 752      * @throws org.exolab.castor.xml.MarshalException if object is
 753      * null or if any SAXException is thrown during marshaling
 754      * @throws org.exolab.castor.xml.ValidationException if this
 755      * object is an invalid instance according to the schema
 756      */
 757     public void marshal(
 758             final java.io.Writer out)
 759     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 760         Marshaller.marshal(this, out);
 761     }
 762
 763     /**
 764      *
 765      *
 766      * @param handler
 767      * @throws java.io.IOException if an IOException occurs during
 768      * marshaling
 769      * @throws org.exolab.castor.xml.ValidationException if this
 770      * object is an invalid instance according to the schema
 771      * @throws org.exolab.castor.xml.MarshalException if object is
 772      * null or if any SAXException is thrown during marshaling
 773      */
 774     public void marshal(
 775             final org.xml.sax.ContentHandler handler)
 776     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 777         Marshaller.marshal(this, handler);
 778     }
 779
 780     /**
 781      * Sets the value of field 'alignwithAlignPanel'. The field
 782      * 'alignwithAlignPanel' has the following description: Flag
 783      *  set
 784      *  if
 785      *  the
 786      *  alignment
 787      *  panel
 788      *  containing
 789      *  this
 790      *  JSeq
 791      *  should
 792      *  be
 793      *  included
 794      *  in
 795      *  those
 796      *  used
 797      *  to
 798      *  perform
 799      *  a
 800      *  structure
 801      *  superposition
 802      *  (since
 803      *  Jalview
 804      *  2.7).
 805      *
 806      *
 807      * @param alignwithAlignPanel the value of field
 808      * 'alignwithAlignPanel'.
 809      */
 810     public void setAlignwithAlignPanel(
 811             final boolean alignwithAlignPanel) {
 812         this._alignwithAlignPanel = alignwithAlignPanel;
 813         this._has_alignwithAlignPanel = true;
 814     }
 815
 816     /**
 817      * Sets the value of field 'colourByJmol'. The field
 818      * 'colourByJmol' has the following description: Flag
 819      *  set
 820      *  if
 821      *  the
 822      *  structure
 823      *  display
 824      *  is
 825      *  coloured
 826      *  by
 827      *  the
 828      *  Jmol
 829      *  state,
 830      *  rather
 831      *  than
 832      *  by
 833      *  one
 834      *  or
 835      *  more
 836      *  linked
 837      *  alignment
 838      *  views.
 839      *
 840      *
 841      * @param colourByJmol the value of field 'colourByJmol'.
 842      */
 843     public void setColourByJmol(
 844             final boolean colourByJmol) {
 845         this._colourByJmol = colourByJmol;
 846         this._has_colourByJmol = true;
 847     }
 848
 849     /**
 850      * Sets the value of field 'colourwithAlignPanel'. The field
 851      * 'colourwithAlignPanel' has the following description: Flag
 852      *  set
 853      *  if
 854      *  the
 855      *  alignment
 856      *  panel
 857      *  containing
 858      *  this
 859      *  JSeq
 860      *  should
 861      *  be
 862      *  included
 863      *  in
 864      *  those
 865      *  used
 866      *  to
 867      *  colour
 868      *  its
 869      *  associated
 870      *  sequences
 871      *  in
 872      *  this
 873      *  structureState(since
 874      *  Jalview
 875      *  2.7).
 876      *
 877      *
 878      * @param colourwithAlignPanel the value of field
 879      * 'colourwithAlignPanel'.
 880      */
 881     public void setColourwithAlignPanel(
 882             final boolean colourwithAlignPanel) {
 883         this._colourwithAlignPanel = colourwithAlignPanel;
 884         this._has_colourwithAlignPanel = true;
 885     }
 886
 887     /**
 888      * Sets the value of field 'content'. The field 'content' has
 889      * the following description: internal content storage
 890      *
 891      * @param content the value of field 'content'.
 892      */
 893     public void setContent(
 894             final java.lang.String content) {
 895         this._content = content;
 896     }
 897
 898     /**
 899      * Sets the value of field 'height'.
 900      *
 901      * @param height the value of field 'height'.
 902      */
 903     public void setHeight(
 904             final int height) {
 905         this._height = height;
 906         this._has_height = true;
 907     }
 908
 909     /**
 910      * Sets the value of field 'viewId'. The field 'viewId' has the
 911      * following description: additional
 912      *  identifier
 913      *  which
 914      *  properly
 915      *  disambiguates
 916      *  the
 917      *  structure
 918      *  view
 919      *  from
 920      *  any
 921      *  other
 922      *  view
 923      *  with
 924      *  the
 925      *  same
 926      *  attributes.
 927      *  This
 928      *  is
 929      *  not
 930      *  an
 931      *  ID,
 932      *  because
 933      *  it
 934      *  is
 935      *  possible
 936      *  to
 937      *  have
 938      *  many
 939      *  references
 940      *  to
 941      *  the
 942      *  same
 943      *  physical
 944      *  structure
 945      *  view
 946      *  from
 947      *  different
 948      *  sequences
 949      *  in
 950      *  an
 951      *  alignment.
 952      *  A
 953      *  structureState
 954      *  element
 955      *  citing
 956      *  the
 957      *  same
 958      *  viewId
 959      *  will
 960      *  appear
 961      *  for
 962      *  each
 963      *  instance.
 964      *
 965      *
 966      * @param viewId the value of field 'viewId'.
 967      */
 968     public void setViewId(
 969             final java.lang.String viewId) {
 970         this._viewId = viewId;
 971     }
 972
 973     /**
 974      * Sets the value of field 'visible'.
 975      *
 976      * @param visible the value of field 'visible'.
 977      */
 978     public void setVisible(
 979             final boolean visible) {
 980         this._visible = visible;
 981         this._has_visible = true;
 982     }
 983
 984     /**
 985      * Sets the value of field 'width'.
 986      *
 987      * @param width the value of field 'width'.
 988      */
 989     public void setWidth(
 990             final int width) {
 991         this._width = width;
 992         this._has_width = true;
 993     }
 994
 995     /**
 996      * Sets the value of field 'xpos'.
 997      *
 998      * @param xpos the value of field 'xpos'.
 999      */
1000     public void setXpos(
1001             final int xpos) {
1002         this._xpos = xpos;
1003         this._has_xpos = true;
1004     }
1005
1006     /**
1007      * Sets the value of field 'ypos'.
1008      *
1009      * @param ypos the value of field 'ypos'.
1010      */
1011     public void setYpos(
1012             final int ypos) {
1013         this._ypos = ypos;
1014         this._has_ypos = true;
1015     }
1016
1017     /**
1018      * Method unmarshal.
1019      *
1020      * @param reader
1021      * @throws org.exolab.castor.xml.MarshalException if object is
1022      * null or if any SAXException is thrown during marshaling
1023      * @throws org.exolab.castor.xml.ValidationException if this
1024      * object is an invalid instance according to the schema
1025      * @return the unmarshaled
1026      * jalview.schemabinding.version2.StructureState
1027      */
1028     public static jalview.schemabinding.version2.StructureState unmarshal(
1029             final java.io.Reader reader)
1030     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
1031         return (jalview.schemabinding.version2.StructureState) Unmarshaller.unmarshal(jalview.schemabinding.version2.StructureState.class, reader);
1032     }
1033
1034     /**
1035      *
1036      *
1037      * @throws org.exolab.castor.xml.ValidationException if this
1038      * object is an invalid instance according to the schema
1039      */
1040     public void validate(
1041     )
1042     throws org.exolab.castor.xml.ValidationException {
1043         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
1044         validator.validate(this);
1045     }
1046
1047 }