src/jalview/schemabinding/version2/Colour.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 Colour.\r
  19  * \r
  20  * @version $Revision$ $Date$\r
  21  */\r
  22 public class Colour implements java.io.Serializable {\r
  23 \r
  24 \r
  25       //--------------------------/\r
  26      //- Class/Member Variables -/\r
  27     //--------------------------/\r
  28 \r
  29     /**\r
  30      * Field _name.\r
  31      */\r
  32     private java.lang.String _name;\r
  33 \r
  34     /**\r
  35      * Field _RGB.\r
  36      */\r
  37     private java.lang.String _RGB;\r
  38 \r
  39     /**\r
  40      * Field _minRGB.\r
  41      */\r
  42     private java.lang.String _minRGB;\r
  43 \r
  44     /**\r
  45      * loosely specified enumeration: NONE,ABOVE, or BELOW\r
  46      */\r
  47     private java.lang.String _threshType;\r
  48 \r
  49     /**\r
  50      * Field _threshold.\r
  51      */\r
  52     private float _threshold;\r
  53 \r
  54     /**\r
  55      * keeps track of state for field: _threshold\r
  56      */\r
  57     private boolean _has_threshold;\r
  58 \r
  59     /**\r
  60      * Field _max.\r
  61      */\r
  62     private float _max;\r
  63 \r
  64     /**\r
  65      * keeps track of state for field: _max\r
  66      */\r
  67     private boolean _has_max;\r
  68 \r
  69     /**\r
  70      * Field _min.\r
  71      */\r
  72     private float _min;\r
  73 \r
  74     /**\r
  75      * keeps track of state for field: _min\r
  76      */\r
  77     private boolean _has_min;\r
  78 \r
  79     /**\r
  80      * Field _colourByLabel.\r
  81      */\r
  82     private boolean _colourByLabel;\r
  83 \r
  84     /**\r
  85      * keeps track of state for field: _colourByLabel\r
  86      */\r
  87     private boolean _has_colourByLabel;\r
  88 \r
  89     /**\r
  90      * Field _autoScale.\r
  91      */\r
  92     private boolean _autoScale;\r
  93 \r
  94     /**\r
  95      * keeps track of state for field: _autoScale\r
  96      */\r
  97     private boolean _has_autoScale;\r
  98 \r
  99 \r
 100       //----------------/\r
 101      //- Constructors -/\r
 102     //----------------/\r
 103 \r
 104     public Colour() {\r
 105         super();\r
 106     }\r
 107 \r
 108 \r
 109       //-----------/\r
 110      //- Methods -/\r
 111     //-----------/\r
 112 \r
 113     /**\r
 114      */\r
 115     public void deleteAutoScale(\r
 116     ) {\r
 117         this._has_autoScale= false;\r
 118     }\r
 119 \r
 120     /**\r
 121      */\r
 122     public void deleteColourByLabel(\r
 123     ) {\r
 124         this._has_colourByLabel= false;\r
 125     }\r
 126 \r
 127     /**\r
 128      */\r
 129     public void deleteMax(\r
 130     ) {\r
 131         this._has_max= false;\r
 132     }\r
 133 \r
 134     /**\r
 135      */\r
 136     public void deleteMin(\r
 137     ) {\r
 138         this._has_min= false;\r
 139     }\r
 140 \r
 141     /**\r
 142      */\r
 143     public void deleteThreshold(\r
 144     ) {\r
 145         this._has_threshold= false;\r
 146     }\r
 147 \r
 148     /**\r
 149      * Returns the value of field 'autoScale'.\r
 150      * \r
 151      * @return the value of field 'AutoScale'.\r
 152      */\r
 153     public boolean getAutoScale(\r
 154     ) {\r
 155         return this._autoScale;\r
 156     }\r
 157 \r
 158     /**\r
 159      * Returns the value of field 'colourByLabel'.\r
 160      * \r
 161      * @return the value of field 'ColourByLabel'.\r
 162      */\r
 163     public boolean getColourByLabel(\r
 164     ) {\r
 165         return this._colourByLabel;\r
 166     }\r
 167 \r
 168     /**\r
 169      * Returns the value of field 'max'.\r
 170      * \r
 171      * @return the value of field 'Max'.\r
 172      */\r
 173     public float getMax(\r
 174     ) {\r
 175         return this._max;\r
 176     }\r
 177 \r
 178     /**\r
 179      * Returns the value of field 'min'.\r
 180      * \r
 181      * @return the value of field 'Min'.\r
 182      */\r
 183     public float getMin(\r
 184     ) {\r
 185         return this._min;\r
 186     }\r
 187 \r
 188     /**\r
 189      * Returns the value of field 'minRGB'.\r
 190      * \r
 191      * @return the value of field 'MinRGB'.\r
 192      */\r
 193     public java.lang.String getMinRGB(\r
 194     ) {\r
 195         return this._minRGB;\r
 196     }\r
 197 \r
 198     /**\r
 199      * Returns the value of field 'name'.\r
 200      * \r
 201      * @return the value of field 'Name'.\r
 202      */\r
 203     public java.lang.String getName(\r
 204     ) {\r
 205         return this._name;\r
 206     }\r
 207 \r
 208     /**\r
 209      * Returns the value of field 'RGB'.\r
 210      * \r
 211      * @return the value of field 'RGB'.\r
 212      */\r
 213     public java.lang.String getRGB(\r
 214     ) {\r
 215         return this._RGB;\r
 216     }\r
 217 \r
 218     /**\r
 219      * Returns the value of field 'threshType'. The field\r
 220      * 'threshType' has the following description: loosely\r
 221      * specified enumeration: NONE,ABOVE, or BELOW\r
 222      * \r
 223      * @return the value of field 'ThreshType'.\r
 224      */\r
 225     public java.lang.String getThreshType(\r
 226     ) {\r
 227         return this._threshType;\r
 228     }\r
 229 \r
 230     /**\r
 231      * Returns the value of field 'threshold'.\r
 232      * \r
 233      * @return the value of field 'Threshold'.\r
 234      */\r
 235     public float getThreshold(\r
 236     ) {\r
 237         return this._threshold;\r
 238     }\r
 239 \r
 240     /**\r
 241      * Method hasAutoScale.\r
 242      * \r
 243      * @return true if at least one AutoScale has been added\r
 244      */\r
 245     public boolean hasAutoScale(\r
 246     ) {\r
 247         return this._has_autoScale;\r
 248     }\r
 249 \r
 250     /**\r
 251      * Method hasColourByLabel.\r
 252      * \r
 253      * @return true if at least one ColourByLabel has been added\r
 254      */\r
 255     public boolean hasColourByLabel(\r
 256     ) {\r
 257         return this._has_colourByLabel;\r
 258     }\r
 259 \r
 260     /**\r
 261      * Method hasMax.\r
 262      * \r
 263      * @return true if at least one Max has been added\r
 264      */\r
 265     public boolean hasMax(\r
 266     ) {\r
 267         return this._has_max;\r
 268     }\r
 269 \r
 270     /**\r
 271      * Method hasMin.\r
 272      * \r
 273      * @return true if at least one Min has been added\r
 274      */\r
 275     public boolean hasMin(\r
 276     ) {\r
 277         return this._has_min;\r
 278     }\r
 279 \r
 280     /**\r
 281      * Method hasThreshold.\r
 282      * \r
 283      * @return true if at least one Threshold has been added\r
 284      */\r
 285     public boolean hasThreshold(\r
 286     ) {\r
 287         return this._has_threshold;\r
 288     }\r
 289 \r
 290     /**\r
 291      * Returns the value of field 'autoScale'.\r
 292      * \r
 293      * @return the value of field 'AutoScale'.\r
 294      */\r
 295     public boolean isAutoScale(\r
 296     ) {\r
 297         return this._autoScale;\r
 298     }\r
 299 \r
 300     /**\r
 301      * Returns the value of field 'colourByLabel'.\r
 302      * \r
 303      * @return the value of field 'ColourByLabel'.\r
 304      */\r
 305     public boolean isColourByLabel(\r
 306     ) {\r
 307         return this._colourByLabel;\r
 308     }\r
 309 \r
 310     /**\r
 311      * Method isValid.\r
 312      * \r
 313      * @return true if this object is valid according to the schema\r
 314      */\r
 315     public boolean isValid(\r
 316     ) {\r
 317         try {\r
 318             validate();\r
 319         } catch (org.exolab.castor.xml.ValidationException vex) {\r
 320             return false;\r
 321         }\r
 322         return true;\r
 323     }\r
 324 \r
 325     /**\r
 326      * \r
 327      * \r
 328      * @param out\r
 329      * @throws org.exolab.castor.xml.MarshalException if object is\r
 330      * null or if any SAXException is thrown during marshaling\r
 331      * @throws org.exolab.castor.xml.ValidationException if this\r
 332      * object is an invalid instance according to the schema\r
 333      */\r
 334     public void marshal(\r
 335             final java.io.Writer out)\r
 336     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
 337         Marshaller.marshal(this, out);\r
 338     }\r
 339 \r
 340     /**\r
 341      * \r
 342      * \r
 343      * @param handler\r
 344      * @throws java.io.IOException if an IOException occurs during\r
 345      * marshaling\r
 346      * @throws org.exolab.castor.xml.ValidationException if this\r
 347      * object is an invalid instance according to the schema\r
 348      * @throws org.exolab.castor.xml.MarshalException if object is\r
 349      * null or if any SAXException is thrown during marshaling\r
 350      */\r
 351     public void marshal(\r
 352             final org.xml.sax.ContentHandler handler)\r
 353     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
 354         Marshaller.marshal(this, handler);\r
 355     }\r
 356 \r
 357     /**\r
 358      * Sets the value of field 'autoScale'.\r
 359      * \r
 360      * @param autoScale the value of field 'autoScale'.\r
 361      */\r
 362     public void setAutoScale(\r
 363             final boolean autoScale) {\r
 364         this._autoScale = autoScale;\r
 365         this._has_autoScale = true;\r
 366     }\r
 367 \r
 368     /**\r
 369      * Sets the value of field 'colourByLabel'.\r
 370      * \r
 371      * @param colourByLabel the value of field 'colourByLabel'.\r
 372      */\r
 373     public void setColourByLabel(\r
 374             final boolean colourByLabel) {\r
 375         this._colourByLabel = colourByLabel;\r
 376         this._has_colourByLabel = true;\r
 377     }\r
 378 \r
 379     /**\r
 380      * Sets the value of field 'max'.\r
 381      * \r
 382      * @param max the value of field 'max'.\r
 383      */\r
 384     public void setMax(\r
 385             final float max) {\r
 386         this._max = max;\r
 387         this._has_max = true;\r
 388     }\r
 389 \r
 390     /**\r
 391      * Sets the value of field 'min'.\r
 392      * \r
 393      * @param min the value of field 'min'.\r
 394      */\r
 395     public void setMin(\r
 396             final float min) {\r
 397         this._min = min;\r
 398         this._has_min = true;\r
 399     }\r
 400 \r
 401     /**\r
 402      * Sets the value of field 'minRGB'.\r
 403      * \r
 404      * @param minRGB the value of field 'minRGB'.\r
 405      */\r
 406     public void setMinRGB(\r
 407             final java.lang.String minRGB) {\r
 408         this._minRGB = minRGB;\r
 409     }\r
 410 \r
 411     /**\r
 412      * Sets the value of field 'name'.\r
 413      * \r
 414      * @param name the value of field 'name'.\r
 415      */\r
 416     public void setName(\r
 417             final java.lang.String name) {\r
 418         this._name = name;\r
 419     }\r
 420 \r
 421     /**\r
 422      * Sets the value of field 'RGB'.\r
 423      * \r
 424      * @param RGB the value of field 'RGB'.\r
 425      */\r
 426     public void setRGB(\r
 427             final java.lang.String RGB) {\r
 428         this._RGB = RGB;\r
 429     }\r
 430 \r
 431     /**\r
 432      * Sets the value of field 'threshType'. The field 'threshType'\r
 433      * has the following description: loosely specified\r
 434      * enumeration: NONE,ABOVE, or BELOW\r
 435      * \r
 436      * @param threshType the value of field 'threshType'.\r
 437      */\r
 438     public void setThreshType(\r
 439             final java.lang.String threshType) {\r
 440         this._threshType = threshType;\r
 441     }\r
 442 \r
 443     /**\r
 444      * Sets the value of field 'threshold'.\r
 445      * \r
 446      * @param threshold the value of field 'threshold'.\r
 447      */\r
 448     public void setThreshold(\r
 449             final float threshold) {\r
 450         this._threshold = threshold;\r
 451         this._has_threshold = true;\r
 452     }\r
 453 \r
 454     /**\r
 455      * Method unmarshal.\r
 456      * \r
 457      * @param reader\r
 458      * @throws org.exolab.castor.xml.MarshalException if object is\r
 459      * null or if any SAXException is thrown during marshaling\r
 460      * @throws org.exolab.castor.xml.ValidationException if this\r
 461      * object is an invalid instance according to the schema\r
 462      * @return the unmarshaled jalview.schemabinding.version2.Colour\r
 463      */\r
 464     public static jalview.schemabinding.version2.Colour unmarshal(\r
 465             final java.io.Reader reader)\r
 466     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
 467         return (jalview.schemabinding.version2.Colour) Unmarshaller.unmarshal(jalview.schemabinding.version2.Colour.class, reader);\r
 468     }\r
 469 \r
 470     /**\r
 471      * \r
 472      * \r
 473      * @throws org.exolab.castor.xml.ValidationException if this\r
 474      * object is an invalid instance according to the schema\r
 475      */\r
 476     public void validate(\r
 477     )\r
 478     throws org.exolab.castor.xml.ValidationException {\r
 479         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 480         validator.validate(this);\r
 481     }\r
 482 \r
 483 }\r