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