src/jalview/schemabinding/version2/AnnotationColours.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 AnnotationColours.\r
  19  * \r
  20  * @version $Revision$ $Date$\r
  21  */\r
  22 public class AnnotationColours 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       //----------------/\r
  81      //- Constructors -/\r
  82     //----------------/\r
  83 \r
  84     public AnnotationColours() {\r
  85         super();\r
  86     }\r
  87 \r
  88 \r
  89       //-----------/\r
  90      //- Methods -/\r
  91     //-----------/\r
  92 \r
  93     /**\r
  94      */\r
  95     public void deleteAboveThreshold(\r
  96     ) {\r
  97         this._has_aboveThreshold= false;\r
  98     }\r
  99 \r
 100     /**\r
 101      */\r
 102     public void deleteMaxColour(\r
 103     ) {\r
 104         this._has_maxColour= false;\r
 105     }\r
 106 \r
 107     /**\r
 108      */\r
 109     public void deleteMinColour(\r
 110     ) {\r
 111         this._has_minColour= false;\r
 112     }\r
 113 \r
 114     /**\r
 115      */\r
 116     public void deleteThreshold(\r
 117     ) {\r
 118         this._has_threshold= false;\r
 119     }\r
 120 \r
 121     /**\r
 122      * Returns the value of field 'aboveThreshold'.\r
 123      * \r
 124      * @return the value of field 'AboveThreshold'.\r
 125      */\r
 126     public int getAboveThreshold(\r
 127     ) {\r
 128         return this._aboveThreshold;\r
 129     }\r
 130 \r
 131     /**\r
 132      * Returns the value of field 'annotation'.\r
 133      * \r
 134      * @return the value of field 'Annotation'.\r
 135      */\r
 136     public java.lang.String getAnnotation(\r
 137     ) {\r
 138         return this._annotation;\r
 139     }\r
 140 \r
 141     /**\r
 142      * Returns the value of field 'colourScheme'.\r
 143      * \r
 144      * @return the value of field 'ColourScheme'.\r
 145      */\r
 146     public java.lang.String getColourScheme(\r
 147     ) {\r
 148         return this._colourScheme;\r
 149     }\r
 150 \r
 151     /**\r
 152      * Returns the value of field 'maxColour'.\r
 153      * \r
 154      * @return the value of field 'MaxColour'.\r
 155      */\r
 156     public int getMaxColour(\r
 157     ) {\r
 158         return this._maxColour;\r
 159     }\r
 160 \r
 161     /**\r
 162      * Returns the value of field 'minColour'.\r
 163      * \r
 164      * @return the value of field 'MinColour'.\r
 165      */\r
 166     public int getMinColour(\r
 167     ) {\r
 168         return this._minColour;\r
 169     }\r
 170 \r
 171     /**\r
 172      * Returns the value of field 'threshold'.\r
 173      * \r
 174      * @return the value of field 'Threshold'.\r
 175      */\r
 176     public float getThreshold(\r
 177     ) {\r
 178         return this._threshold;\r
 179     }\r
 180 \r
 181     /**\r
 182      * Method hasAboveThreshold.\r
 183      * \r
 184      * @return true if at least one AboveThreshold has been added\r
 185      */\r
 186     public boolean hasAboveThreshold(\r
 187     ) {\r
 188         return this._has_aboveThreshold;\r
 189     }\r
 190 \r
 191     /**\r
 192      * Method hasMaxColour.\r
 193      * \r
 194      * @return true if at least one MaxColour has been added\r
 195      */\r
 196     public boolean hasMaxColour(\r
 197     ) {\r
 198         return this._has_maxColour;\r
 199     }\r
 200 \r
 201     /**\r
 202      * Method hasMinColour.\r
 203      * \r
 204      * @return true if at least one MinColour has been added\r
 205      */\r
 206     public boolean hasMinColour(\r
 207     ) {\r
 208         return this._has_minColour;\r
 209     }\r
 210 \r
 211     /**\r
 212      * Method hasThreshold.\r
 213      * \r
 214      * @return true if at least one Threshold has been added\r
 215      */\r
 216     public boolean hasThreshold(\r
 217     ) {\r
 218         return this._has_threshold;\r
 219     }\r
 220 \r
 221     /**\r
 222      * Method isValid.\r
 223      * \r
 224      * @return true if this object is valid according to the schema\r
 225      */\r
 226     public boolean isValid(\r
 227     ) {\r
 228         try {\r
 229             validate();\r
 230         } catch (org.exolab.castor.xml.ValidationException vex) {\r
 231             return false;\r
 232         }\r
 233         return true;\r
 234     }\r
 235 \r
 236     /**\r
 237      * \r
 238      * \r
 239      * @param out\r
 240      * @throws org.exolab.castor.xml.MarshalException if object is\r
 241      * null or if any SAXException is thrown during marshaling\r
 242      * @throws org.exolab.castor.xml.ValidationException if this\r
 243      * object is an invalid instance according to the schema\r
 244      */\r
 245     public void marshal(\r
 246             final java.io.Writer out)\r
 247     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
 248         Marshaller.marshal(this, out);\r
 249     }\r
 250 \r
 251     /**\r
 252      * \r
 253      * \r
 254      * @param handler\r
 255      * @throws java.io.IOException if an IOException occurs during\r
 256      * marshaling\r
 257      * @throws org.exolab.castor.xml.ValidationException if this\r
 258      * object is an invalid instance according to the schema\r
 259      * @throws org.exolab.castor.xml.MarshalException if object is\r
 260      * null or if any SAXException is thrown during marshaling\r
 261      */\r
 262     public void marshal(\r
 263             final org.xml.sax.ContentHandler handler)\r
 264     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
 265         Marshaller.marshal(this, handler);\r
 266     }\r
 267 \r
 268     /**\r
 269      * Sets the value of field 'aboveThreshold'.\r
 270      * \r
 271      * @param aboveThreshold the value of field 'aboveThreshold'.\r
 272      */\r
 273     public void setAboveThreshold(\r
 274             final int aboveThreshold) {\r
 275         this._aboveThreshold = aboveThreshold;\r
 276         this._has_aboveThreshold = true;\r
 277     }\r
 278 \r
 279     /**\r
 280      * Sets the value of field 'annotation'.\r
 281      * \r
 282      * @param annotation the value of field 'annotation'.\r
 283      */\r
 284     public void setAnnotation(\r
 285             final java.lang.String annotation) {\r
 286         this._annotation = annotation;\r
 287     }\r
 288 \r
 289     /**\r
 290      * Sets the value of field 'colourScheme'.\r
 291      * \r
 292      * @param colourScheme the value of field 'colourScheme'.\r
 293      */\r
 294     public void setColourScheme(\r
 295             final java.lang.String colourScheme) {\r
 296         this._colourScheme = colourScheme;\r
 297     }\r
 298 \r
 299     /**\r
 300      * Sets the value of field 'maxColour'.\r
 301      * \r
 302      * @param maxColour the value of field 'maxColour'.\r
 303      */\r
 304     public void setMaxColour(\r
 305             final int maxColour) {\r
 306         this._maxColour = maxColour;\r
 307         this._has_maxColour = true;\r
 308     }\r
 309 \r
 310     /**\r
 311      * Sets the value of field 'minColour'.\r
 312      * \r
 313      * @param minColour the value of field 'minColour'.\r
 314      */\r
 315     public void setMinColour(\r
 316             final int minColour) {\r
 317         this._minColour = minColour;\r
 318         this._has_minColour = true;\r
 319     }\r
 320 \r
 321     /**\r
 322      * Sets the value of field 'threshold'.\r
 323      * \r
 324      * @param threshold the value of field 'threshold'.\r
 325      */\r
 326     public void setThreshold(\r
 327             final float threshold) {\r
 328         this._threshold = threshold;\r
 329         this._has_threshold = true;\r
 330     }\r
 331 \r
 332     /**\r
 333      * Method unmarshal.\r
 334      * \r
 335      * @param reader\r
 336      * @throws org.exolab.castor.xml.MarshalException if object is\r
 337      * null or if any SAXException is thrown during marshaling\r
 338      * @throws org.exolab.castor.xml.ValidationException if this\r
 339      * object is an invalid instance according to the schema\r
 340      * @return the unmarshaled\r
 341      * jalview.schemabinding.version2.AnnotationColours\r
 342      */\r
 343     public static jalview.schemabinding.version2.AnnotationColours unmarshal(\r
 344             final java.io.Reader reader)\r
 345     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
 346         return (jalview.schemabinding.version2.AnnotationColours) Unmarshaller.unmarshal(jalview.schemabinding.version2.AnnotationColours.class, reader);\r
 347     }\r
 348 \r
 349     /**\r
 350      * \r
 351      * \r
 352      * @throws org.exolab.castor.xml.ValidationException if this\r
 353      * object is an invalid instance according to the schema\r
 354      */\r
 355     public void validate(\r
 356     )\r
 357     throws org.exolab.castor.xml.ValidationException {\r
 358         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 359         validator.validate(this);\r
 360     }\r
 361 \r
 362 }\r