src/jalview/schemabinding/version2/AnnotationColours.java

   1 /*\r
   2  * This class was automatically generated with\r
   3  * <a href="http://www.castor.org">Castor 0.9.6</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.*;\r
  15 \r
  16 /**\r
  17  * Class AnnotationColours.\r
  18  *\r
  19  * @version $Revision$ $Date$\r
  20  */\r
  21 public class AnnotationColours\r
  22     implements java.io.Serializable\r
  23 {\r
  24 \r
  25   //--------------------------/\r
  26   //- Class/Member Variables -/\r
  27   //--------------------------/\r
  28 \r
  29   /**\r
  30    * Field _aboveThreshold\r
  31    */\r
  32   private int _aboveThreshold;\r
  33 \r
  34   /**\r
  35    * keeps track of state for field: _aboveThreshold\r
  36    */\r
  37   private boolean _has_aboveThreshold;\r
  38 \r
  39   /**\r
  40    * Field _annotation\r
  41    */\r
  42   private java.lang.String _annotation;\r
  43 \r
  44   /**\r
  45    * Field _minColour\r
  46    */\r
  47   private int _minColour;\r
  48 \r
  49   /**\r
  50    * keeps track of state for field: _minColour\r
  51    */\r
  52   private boolean _has_minColour;\r
  53 \r
  54   /**\r
  55    * Field _maxColour\r
  56    */\r
  57   private int _maxColour;\r
  58 \r
  59   /**\r
  60    * keeps track of state for field: _maxColour\r
  61    */\r
  62   private boolean _has_maxColour;\r
  63 \r
  64   /**\r
  65    * Field _colourScheme\r
  66    */\r
  67   private java.lang.String _colourScheme;\r
  68 \r
  69   /**\r
  70    * Field _threshold\r
  71    */\r
  72   private float _threshold;\r
  73 \r
  74   /**\r
  75    * keeps track of state for field: _threshold\r
  76    */\r
  77   private boolean _has_threshold;\r
  78 \r
  79   //----------------/\r
  80   //- Constructors -/\r
  81   //----------------/\r
  82 \r
  83   public AnnotationColours()\r
  84   {\r
  85     super();\r
  86   } //-- jalview.schemabinding.version2.AnnotationColours()\r
  87 \r
  88   //-----------/\r
  89   //- Methods -/\r
  90   //-----------/\r
  91 \r
  92   /**\r
  93    * Method deleteAboveThreshold\r
  94    *\r
  95    */\r
  96   public void deleteAboveThreshold()\r
  97   {\r
  98     this._has_aboveThreshold = false;\r
  99   } //-- void deleteAboveThreshold()\r
 100 \r
 101   /**\r
 102    * Method deleteMaxColour\r
 103    *\r
 104    */\r
 105   public void deleteMaxColour()\r
 106   {\r
 107     this._has_maxColour = false;\r
 108   } //-- void deleteMaxColour()\r
 109 \r
 110   /**\r
 111    * Method deleteMinColour\r
 112    *\r
 113    */\r
 114   public void deleteMinColour()\r
 115   {\r
 116     this._has_minColour = false;\r
 117   } //-- void deleteMinColour()\r
 118 \r
 119   /**\r
 120    * Method deleteThreshold\r
 121    *\r
 122    */\r
 123   public void deleteThreshold()\r
 124   {\r
 125     this._has_threshold = false;\r
 126   } //-- void deleteThreshold()\r
 127 \r
 128   /**\r
 129    * Returns the value of field 'aboveThreshold'.\r
 130    *\r
 131    * @return int\r
 132    * @return the value of field 'aboveThreshold'.\r
 133    */\r
 134   public int getAboveThreshold()\r
 135   {\r
 136     return this._aboveThreshold;\r
 137   } //-- int getAboveThreshold()\r
 138 \r
 139   /**\r
 140    * Returns the value of field 'annotation'.\r
 141    *\r
 142    * @return String\r
 143    * @return the value of field 'annotation'.\r
 144    */\r
 145   public java.lang.String getAnnotation()\r
 146   {\r
 147     return this._annotation;\r
 148   } //-- java.lang.String getAnnotation()\r
 149 \r
 150   /**\r
 151    * Returns the value of field 'colourScheme'.\r
 152    *\r
 153    * @return String\r
 154    * @return the value of field 'colourScheme'.\r
 155    */\r
 156   public java.lang.String getColourScheme()\r
 157   {\r
 158     return this._colourScheme;\r
 159   } //-- java.lang.String getColourScheme()\r
 160 \r
 161   /**\r
 162    * Returns the value of field 'maxColour'.\r
 163    *\r
 164    * @return int\r
 165    * @return the value of field 'maxColour'.\r
 166    */\r
 167   public int getMaxColour()\r
 168   {\r
 169     return this._maxColour;\r
 170   } //-- int getMaxColour()\r
 171 \r
 172   /**\r
 173    * Returns the value of field 'minColour'.\r
 174    *\r
 175    * @return int\r
 176    * @return the value of field 'minColour'.\r
 177    */\r
 178   public int getMinColour()\r
 179   {\r
 180     return this._minColour;\r
 181   } //-- int getMinColour()\r
 182 \r
 183   /**\r
 184    * Returns the value of field 'threshold'.\r
 185    *\r
 186    * @return float\r
 187    * @return the value of field 'threshold'.\r
 188    */\r
 189   public float getThreshold()\r
 190   {\r
 191     return this._threshold;\r
 192   } //-- float getThreshold()\r
 193 \r
 194   /**\r
 195    * Method hasAboveThreshold\r
 196    *\r
 197    *\r
 198    *\r
 199    * @return boolean\r
 200    */\r
 201   public boolean hasAboveThreshold()\r
 202   {\r
 203     return this._has_aboveThreshold;\r
 204   } //-- boolean hasAboveThreshold()\r
 205 \r
 206   /**\r
 207    * Method hasMaxColour\r
 208    *\r
 209    *\r
 210    *\r
 211    * @return boolean\r
 212    */\r
 213   public boolean hasMaxColour()\r
 214   {\r
 215     return this._has_maxColour;\r
 216   } //-- boolean hasMaxColour()\r
 217 \r
 218   /**\r
 219    * Method hasMinColour\r
 220    *\r
 221    *\r
 222    *\r
 223    * @return boolean\r
 224    */\r
 225   public boolean hasMinColour()\r
 226   {\r
 227     return this._has_minColour;\r
 228   } //-- boolean hasMinColour()\r
 229 \r
 230   /**\r
 231    * Method hasThreshold\r
 232    *\r
 233    *\r
 234    *\r
 235    * @return boolean\r
 236    */\r
 237   public boolean hasThreshold()\r
 238   {\r
 239     return this._has_threshold;\r
 240   } //-- boolean hasThreshold()\r
 241 \r
 242   /**\r
 243    * Method isValid\r
 244    *\r
 245    *\r
 246    *\r
 247    * @return boolean\r
 248    */\r
 249   public boolean isValid()\r
 250   {\r
 251     try\r
 252     {\r
 253       validate();\r
 254     }\r
 255     catch (org.exolab.castor.xml.ValidationException vex)\r
 256     {\r
 257       return false;\r
 258     }\r
 259     return true;\r
 260   } //-- boolean isValid()\r
 261 \r
 262   /**\r
 263    * Method marshal\r
 264    *\r
 265    *\r
 266    *\r
 267    * @param out\r
 268    */\r
 269   public void marshal(java.io.Writer out)\r
 270       throws org.exolab.castor.xml.MarshalException,\r
 271       org.exolab.castor.xml.ValidationException\r
 272   {\r
 273 \r
 274     Marshaller.marshal(this, out);\r
 275   } //-- void marshal(java.io.Writer)\r
 276 \r
 277   /**\r
 278    * Method marshal\r
 279    *\r
 280    *\r
 281    *\r
 282    * @param handler\r
 283    */\r
 284   public void marshal(org.xml.sax.ContentHandler handler)\r
 285       throws java.io.IOException, org.exolab.castor.xml.MarshalException,\r
 286       org.exolab.castor.xml.ValidationException\r
 287   {\r
 288 \r
 289     Marshaller.marshal(this, handler);\r
 290   } //-- void marshal(org.xml.sax.ContentHandler)\r
 291 \r
 292   /**\r
 293    * Sets the value of field 'aboveThreshold'.\r
 294    *\r
 295    * @param aboveThreshold the value of field 'aboveThreshold'.\r
 296    */\r
 297   public void setAboveThreshold(int aboveThreshold)\r
 298   {\r
 299     this._aboveThreshold = aboveThreshold;\r
 300     this._has_aboveThreshold = true;\r
 301   } //-- void setAboveThreshold(int)\r
 302 \r
 303   /**\r
 304    * Sets the value of field 'annotation'.\r
 305    *\r
 306    * @param annotation the value of field 'annotation'.\r
 307    */\r
 308   public void setAnnotation(java.lang.String annotation)\r
 309   {\r
 310     this._annotation = annotation;\r
 311   } //-- void setAnnotation(java.lang.String)\r
 312 \r
 313   /**\r
 314    * Sets the value of field 'colourScheme'.\r
 315    *\r
 316    * @param colourScheme the value of field 'colourScheme'.\r
 317    */\r
 318   public void setColourScheme(java.lang.String colourScheme)\r
 319   {\r
 320     this._colourScheme = colourScheme;\r
 321   } //-- void setColourScheme(java.lang.String)\r
 322 \r
 323   /**\r
 324    * Sets the value of field 'maxColour'.\r
 325    *\r
 326    * @param maxColour the value of field 'maxColour'.\r
 327    */\r
 328   public void setMaxColour(int maxColour)\r
 329   {\r
 330     this._maxColour = maxColour;\r
 331     this._has_maxColour = true;\r
 332   } //-- void setMaxColour(int)\r
 333 \r
 334   /**\r
 335    * Sets the value of field 'minColour'.\r
 336    *\r
 337    * @param minColour the value of field 'minColour'.\r
 338    */\r
 339   public void setMinColour(int minColour)\r
 340   {\r
 341     this._minColour = minColour;\r
 342     this._has_minColour = true;\r
 343   } //-- void setMinColour(int)\r
 344 \r
 345   /**\r
 346    * Sets the value of field 'threshold'.\r
 347    *\r
 348    * @param threshold the value of field 'threshold'.\r
 349    */\r
 350   public void setThreshold(float threshold)\r
 351   {\r
 352     this._threshold = threshold;\r
 353     this._has_threshold = true;\r
 354   } //-- void setThreshold(float)\r
 355 \r
 356   /**\r
 357    * Method unmarshal\r
 358    *\r
 359    *\r
 360    *\r
 361    * @param reader\r
 362    * @return Object\r
 363    */\r
 364   public static java.lang.Object unmarshal(java.io.Reader reader)\r
 365       throws org.exolab.castor.xml.MarshalException,\r
 366       org.exolab.castor.xml.ValidationException\r
 367   {\r
 368     return (jalview.schemabinding.version2.AnnotationColours) Unmarshaller.\r
 369         unmarshal(jalview.schemabinding.version2.AnnotationColours.class,\r
 370                   reader);\r
 371   } //-- java.lang.Object unmarshal(java.io.Reader)\r
 372 \r
 373   /**\r
 374    * Method validate\r
 375    *\r
 376    */\r
 377   public void validate()\r
 378       throws org.exolab.castor.xml.ValidationException\r
 379   {\r
 380     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.\r
 381         Validator();\r
 382     validator.validate(this);\r
 383   } //-- void validate()\r
 384 \r
 385 }\r