src/jalview/schemabinding/version2/Setting.java

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