src/jalview/schemabinding/version2/Setting.java

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