src/jalview/schemabinding/version2/Setting.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 Setting.
  19  *
  20  * @version $Revision$ $Date$
  21  */
  22 public class Setting implements java.io.Serializable {
  23
  24
  25       //--------------------------/
  26      //- Class/Member Variables -/
  27     //--------------------------/
  28
  29     /**
  30      * Field _type.
  31      */
  32     private java.lang.String _type;
  33
  34     /**
  35      * Field _colour.
  36      */
  37     private int _colour;
  38
  39     /**
  40      * keeps track of state for field: _colour
  41      */
  42     private boolean _has_colour;
  43
  44     /**
  45      * Field _display.
  46      */
  47     private boolean _display;
  48
  49     /**
  50      * keeps track of state for field: _display
  51      */
  52     private boolean _has_display;
  53
  54     /**
  55      * Field _order.
  56      */
  57     private float _order;
  58
  59     /**
  60      * keeps track of state for field: _order
  61      */
  62     private boolean _has_order;
  63
  64     /**
  65      * Optional minimum colour
  66      *  for graduated
  67      *  feature
  68      *  colour
  69      *
  70      */
  71     private int _mincolour;
  72
  73     /**
  74      * keeps track of state for field: _mincolour
  75      */
  76     private boolean _has_mincolour;
  77
  78     /**
  79      * threshold value for
  80      *  graduated feature colour
  81      *
  82      */
  83     private float _threshold;
  84
  85     /**
  86      * keeps track of state for field: _threshold
  87      */
  88     private boolean _has_threshold;
  89
  90     /**
  91      * threshold type for
  92      *  graduated feature colour
  93      *
  94      */
  95     private int _threshstate;
  96
  97     /**
  98      * keeps track of state for field: _threshstate
  99      */
 100     private boolean _has_threshstate;
 101
 102     /**
 103      * Field _max.
 104      */
 105     private float _max;
 106
 107     /**
 108      * keeps track of state for field: _max
 109      */
 110     private boolean _has_max;
 111
 112     /**
 113      * Field _min.
 114      */
 115     private float _min;
 116
 117     /**
 118      * keeps track of state for field: _min
 119      */
 120     private boolean _has_min;
 121
 122     /**
 123      * Field _colourByLabel.
 124      */
 125     private boolean _colourByLabel;
 126
 127     /**
 128      * keeps track of state for field: _colourByLabel
 129      */
 130     private boolean _has_colourByLabel;
 131
 132     /**
 133      * Field _autoScale.
 134      */
 135     private boolean _autoScale;
 136
 137     /**
 138      * keeps track of state for field: _autoScale
 139      */
 140     private boolean _has_autoScale;
 141
 142
 143       //----------------/
 144      //- Constructors -/
 145     //----------------/
 146
 147     public Setting() {
 148         super();
 149     }
 150
 151
 152       //-----------/
 153      //- Methods -/
 154     //-----------/
 155
 156     /**
 157      */
 158     public void deleteAutoScale(
 159     ) {
 160         this._has_autoScale= false;
 161     }
 162
 163     /**
 164      */
 165     public void deleteColour(
 166     ) {
 167         this._has_colour= false;
 168     }
 169
 170     /**
 171      */
 172     public void deleteColourByLabel(
 173     ) {
 174         this._has_colourByLabel= false;
 175     }
 176
 177     /**
 178      */
 179     public void deleteDisplay(
 180     ) {
 181         this._has_display= false;
 182     }
 183
 184     /**
 185      */
 186     public void deleteMax(
 187     ) {
 188         this._has_max= false;
 189     }
 190
 191     /**
 192      */
 193     public void deleteMin(
 194     ) {
 195         this._has_min= false;
 196     }
 197
 198     /**
 199      */
 200     public void deleteMincolour(
 201     ) {
 202         this._has_mincolour= false;
 203     }
 204
 205     /**
 206      */
 207     public void deleteOrder(
 208     ) {
 209         this._has_order= false;
 210     }
 211
 212     /**
 213      */
 214     public void deleteThreshold(
 215     ) {
 216         this._has_threshold= false;
 217     }
 218
 219     /**
 220      */
 221     public void deleteThreshstate(
 222     ) {
 223         this._has_threshstate= false;
 224     }
 225
 226     /**
 227      * Returns the value of field 'autoScale'.
 228      *
 229      * @return the value of field 'AutoScale'.
 230      */
 231     public boolean getAutoScale(
 232     ) {
 233         return this._autoScale;
 234     }
 235
 236     /**
 237      * Returns the value of field 'colour'.
 238      *
 239      * @return the value of field 'Colour'.
 240      */
 241     public int getColour(
 242     ) {
 243         return this._colour;
 244     }
 245
 246     /**
 247      * Returns the value of field 'colourByLabel'.
 248      *
 249      * @return the value of field 'ColourByLabel'.
 250      */
 251     public boolean getColourByLabel(
 252     ) {
 253         return this._colourByLabel;
 254     }
 255
 256     /**
 257      * Returns the value of field 'display'.
 258      *
 259      * @return the value of field 'Display'.
 260      */
 261     public boolean getDisplay(
 262     ) {
 263         return this._display;
 264     }
 265
 266     /**
 267      * Returns the value of field 'max'.
 268      *
 269      * @return the value of field 'Max'.
 270      */
 271     public float getMax(
 272     ) {
 273         return this._max;
 274     }
 275
 276     /**
 277      * Returns the value of field 'min'.
 278      *
 279      * @return the value of field 'Min'.
 280      */
 281     public float getMin(
 282     ) {
 283         return this._min;
 284     }
 285
 286     /**
 287      * Returns the value of field 'mincolour'. The field
 288      * 'mincolour' has the following description: Optional minimum
 289      * colour
 290      *  for graduated
 291      *  feature
 292      *  colour
 293      *
 294      *
 295      * @return the value of field 'Mincolour'.
 296      */
 297     public int getMincolour(
 298     ) {
 299         return this._mincolour;
 300     }
 301
 302     /**
 303      * Returns the value of field 'order'.
 304      *
 305      * @return the value of field 'Order'.
 306      */
 307     public float getOrder(
 308     ) {
 309         return this._order;
 310     }
 311
 312     /**
 313      * Returns the value of field 'threshold'. The field
 314      * 'threshold' has the following description: threshold value
 315      * for
 316      *  graduated feature colour
 317      *
 318      *
 319      * @return the value of field 'Threshold'.
 320      */
 321     public float getThreshold(
 322     ) {
 323         return this._threshold;
 324     }
 325
 326     /**
 327      * Returns the value of field 'threshstate'. The field
 328      * 'threshstate' has the following description: threshold type
 329      * for
 330      *  graduated feature colour
 331      *
 332      *
 333      * @return the value of field 'Threshstate'.
 334      */
 335     public int getThreshstate(
 336     ) {
 337         return this._threshstate;
 338     }
 339
 340     /**
 341      * Returns the value of field 'type'.
 342      *
 343      * @return the value of field 'Type'.
 344      */
 345     public java.lang.String getType(
 346     ) {
 347         return this._type;
 348     }
 349
 350     /**
 351      * Method hasAutoScale.
 352      *
 353      * @return true if at least one AutoScale has been added
 354      */
 355     public boolean hasAutoScale(
 356     ) {
 357         return this._has_autoScale;
 358     }
 359
 360     /**
 361      * Method hasColour.
 362      *
 363      * @return true if at least one Colour has been added
 364      */
 365     public boolean hasColour(
 366     ) {
 367         return this._has_colour;
 368     }
 369
 370     /**
 371      * Method hasColourByLabel.
 372      *
 373      * @return true if at least one ColourByLabel has been added
 374      */
 375     public boolean hasColourByLabel(
 376     ) {
 377         return this._has_colourByLabel;
 378     }
 379
 380     /**
 381      * Method hasDisplay.
 382      *
 383      * @return true if at least one Display has been added
 384      */
 385     public boolean hasDisplay(
 386     ) {
 387         return this._has_display;
 388     }
 389
 390     /**
 391      * Method hasMax.
 392      *
 393      * @return true if at least one Max has been added
 394      */
 395     public boolean hasMax(
 396     ) {
 397         return this._has_max;
 398     }
 399
 400     /**
 401      * Method hasMin.
 402      *
 403      * @return true if at least one Min has been added
 404      */
 405     public boolean hasMin(
 406     ) {
 407         return this._has_min;
 408     }
 409
 410     /**
 411      * Method hasMincolour.
 412      *
 413      * @return true if at least one Mincolour has been added
 414      */
 415     public boolean hasMincolour(
 416     ) {
 417         return this._has_mincolour;
 418     }
 419
 420     /**
 421      * Method hasOrder.
 422      *
 423      * @return true if at least one Order has been added
 424      */
 425     public boolean hasOrder(
 426     ) {
 427         return this._has_order;
 428     }
 429
 430     /**
 431      * Method hasThreshold.
 432      *
 433      * @return true if at least one Threshold has been added
 434      */
 435     public boolean hasThreshold(
 436     ) {
 437         return this._has_threshold;
 438     }
 439
 440     /**
 441      * Method hasThreshstate.
 442      *
 443      * @return true if at least one Threshstate has been added
 444      */
 445     public boolean hasThreshstate(
 446     ) {
 447         return this._has_threshstate;
 448     }
 449
 450     /**
 451      * Returns the value of field 'autoScale'.
 452      *
 453      * @return the value of field 'AutoScale'.
 454      */
 455     public boolean isAutoScale(
 456     ) {
 457         return this._autoScale;
 458     }
 459
 460     /**
 461      * Returns the value of field 'colourByLabel'.
 462      *
 463      * @return the value of field 'ColourByLabel'.
 464      */
 465     public boolean isColourByLabel(
 466     ) {
 467         return this._colourByLabel;
 468     }
 469
 470     /**
 471      * Returns the value of field 'display'.
 472      *
 473      * @return the value of field 'Display'.
 474      */
 475     public boolean isDisplay(
 476     ) {
 477         return this._display;
 478     }
 479
 480     /**
 481      * Method isValid.
 482      *
 483      * @return true if this object is valid according to the schema
 484      */
 485     public boolean isValid(
 486     ) {
 487         try {
 488             validate();
 489         } catch (org.exolab.castor.xml.ValidationException vex) {
 490             return false;
 491         }
 492         return true;
 493     }
 494
 495     /**
 496      *
 497      *
 498      * @param out
 499      * @throws org.exolab.castor.xml.MarshalException if object is
 500      * null or if any SAXException is thrown during marshaling
 501      * @throws org.exolab.castor.xml.ValidationException if this
 502      * object is an invalid instance according to the schema
 503      */
 504     public void marshal(
 505             final java.io.Writer out)
 506     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 507         Marshaller.marshal(this, out);
 508     }
 509
 510     /**
 511      *
 512      *
 513      * @param handler
 514      * @throws java.io.IOException if an IOException occurs during
 515      * marshaling
 516      * @throws org.exolab.castor.xml.ValidationException if this
 517      * object is an invalid instance according to the schema
 518      * @throws org.exolab.castor.xml.MarshalException if object is
 519      * null or if any SAXException is thrown during marshaling
 520      */
 521     public void marshal(
 522             final org.xml.sax.ContentHandler handler)
 523     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 524         Marshaller.marshal(this, handler);
 525     }
 526
 527     /**
 528      * Sets the value of field 'autoScale'.
 529      *
 530      * @param autoScale the value of field 'autoScale'.
 531      */
 532     public void setAutoScale(
 533             final boolean autoScale) {
 534         this._autoScale = autoScale;
 535         this._has_autoScale = true;
 536     }
 537
 538     /**
 539      * Sets the value of field 'colour'.
 540      *
 541      * @param colour the value of field 'colour'.
 542      */
 543     public void setColour(
 544             final int colour) {
 545         this._colour = colour;
 546         this._has_colour = true;
 547     }
 548
 549     /**
 550      * Sets the value of field 'colourByLabel'.
 551      *
 552      * @param colourByLabel the value of field 'colourByLabel'.
 553      */
 554     public void setColourByLabel(
 555             final boolean colourByLabel) {
 556         this._colourByLabel = colourByLabel;
 557         this._has_colourByLabel = true;
 558     }
 559
 560     /**
 561      * Sets the value of field 'display'.
 562      *
 563      * @param display the value of field 'display'.
 564      */
 565     public void setDisplay(
 566             final boolean display) {
 567         this._display = display;
 568         this._has_display = true;
 569     }
 570
 571     /**
 572      * Sets the value of field 'max'.
 573      *
 574      * @param max the value of field 'max'.
 575      */
 576     public void setMax(
 577             final float max) {
 578         this._max = max;
 579         this._has_max = true;
 580     }
 581
 582     /**
 583      * Sets the value of field 'min'.
 584      *
 585      * @param min the value of field 'min'.
 586      */
 587     public void setMin(
 588             final float min) {
 589         this._min = min;
 590         this._has_min = true;
 591     }
 592
 593     /**
 594      * Sets the value of field 'mincolour'. The field 'mincolour'
 595      * has the following description: Optional minimum colour
 596      *  for graduated
 597      *  feature
 598      *  colour
 599      *
 600      *
 601      * @param mincolour the value of field 'mincolour'.
 602      */
 603     public void setMincolour(
 604             final int mincolour) {
 605         this._mincolour = mincolour;
 606         this._has_mincolour = true;
 607     }
 608
 609     /**
 610      * Sets the value of field 'order'.
 611      *
 612      * @param order the value of field 'order'.
 613      */
 614     public void setOrder(
 615             final float order) {
 616         this._order = order;
 617         this._has_order = true;
 618     }
 619
 620     /**
 621      * Sets the value of field 'threshold'. The field 'threshold'
 622      * has the following description: threshold value for
 623      *  graduated feature colour
 624      *
 625      *
 626      * @param threshold the value of field 'threshold'.
 627      */
 628     public void setThreshold(
 629             final float threshold) {
 630         this._threshold = threshold;
 631         this._has_threshold = true;
 632     }
 633
 634     /**
 635      * Sets the value of field 'threshstate'. The field
 636      * 'threshstate' has the following description: threshold type
 637      * for
 638      *  graduated feature colour
 639      *
 640      *
 641      * @param threshstate the value of field 'threshstate'.
 642      */
 643     public void setThreshstate(
 644             final int threshstate) {
 645         this._threshstate = threshstate;
 646         this._has_threshstate = true;
 647     }
 648
 649     /**
 650      * Sets the value of field 'type'.
 651      *
 652      * @param type the value of field 'type'.
 653      */
 654     public void setType(
 655             final java.lang.String type) {
 656         this._type = type;
 657     }
 658
 659     /**
 660      * Method unmarshal.
 661      *
 662      * @param reader
 663      * @throws org.exolab.castor.xml.MarshalException if object is
 664      * null or if any SAXException is thrown during marshaling
 665      * @throws org.exolab.castor.xml.ValidationException if this
 666      * object is an invalid instance according to the schema
 667      * @return the unmarshaled jalview.schemabinding.version2.Settin
 668      */
 669     public static jalview.schemabinding.version2.Setting unmarshal(
 670             final java.io.Reader reader)
 671     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 672         return (jalview.schemabinding.version2.Setting) Unmarshaller.unmarshal(jalview.schemabinding.version2.Setting.class, reader);
 673     }
 674
 675     /**
 676      *
 677      *
 678      * @throws org.exolab.castor.xml.ValidationException if this
 679      * object is an invalid instance according to the schema
 680      */
 681     public void validate(
 682     )
 683     throws org.exolab.castor.xml.ValidationException {
 684         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 685         validator.validate(this);
 686     }
 687
 688 }