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