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