src/jalview/schemabinding/version2/CalcIdParam.java

   1 /*
   2  * This class was automatically generated with
   3  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
   4  * Schema.
   5  * $Id$
   6  */
   7
   8 package jalview.schemabinding.version2;
   9
  10   //---------------------------------/
  11  //- Imported classes and packages -/
  12 //---------------------------------/
  13
  14 import org.exolab.castor.xml.Marshaller;
  15 import org.exolab.castor.xml.Unmarshaller;
  16
  17 /**
  18  * Class CalcIdParam.
  19  *
  20  * @version $Revision$ $Date$
  21  */
  22 public class CalcIdParam extends WebServiceParameterSet
  23 implements java.io.Serializable
  24 {
  25
  26
  27       //--------------------------/
  28      //- Class/Member Variables -/
  29     //--------------------------/
  30
  31     /**
  32      * handle for the calculation which uses this parameter set
  33      */
  34     private java.lang.String _calcId;
  35
  36     /**
  37      * should the calculation be performed immediately after
  38      * loading in order to refresh results
  39      */
  40     private boolean _needsUpdate = false;
  41
  42     /**
  43      * keeps track of state for field: _needsUpdate
  44      */
  45     private boolean _has_needsUpdate;
  46
  47     /**
  48      * should the calculation be automatically performed on edits
  49      */
  50     private boolean _autoUpdate;
  51
  52     /**
  53      * keeps track of state for field: _autoUpdate
  54      */
  55     private boolean _has_autoUpdate;
  56
  57
  58       //----------------/
  59      //- Constructors -/
  60     //----------------/
  61
  62     public CalcIdParam() {
  63         super();
  64     }
  65
  66
  67       //-----------/
  68      //- Methods -/
  69     //-----------/
  70
  71     /**
  72      */
  73     public void deleteAutoUpdate(
  74     ) {
  75         this._has_autoUpdate= false;
  76     }
  77
  78     /**
  79      */
  80     public void deleteNeedsUpdate(
  81     ) {
  82         this._has_needsUpdate= false;
  83     }
  84
  85     /**
  86      * Returns the value of field 'autoUpdate'. The field
  87      * 'autoUpdate' has the following description: should the
  88      * calculation be automatically performed on edits
  89      *
  90      * @return the value of field 'AutoUpdate'.
  91      */
  92     public boolean getAutoUpdate(
  93     ) {
  94         return this._autoUpdate;
  95     }
  96
  97     /**
  98      * Returns the value of field 'calcId'. The field 'calcId' has
  99      * the following description: handle for the calculation which
 100      * uses this parameter set
 101      *
 102      * @return the value of field 'CalcId'.
 103      */
 104     public java.lang.String getCalcId(
 105     ) {
 106         return this._calcId;
 107     }
 108
 109     /**
 110      * Returns the value of field 'needsUpdate'. The field
 111      * 'needsUpdate' has the following description: should the
 112      * calculation be performed immediately after loading in order
 113      * to refresh results
 114      *
 115      * @return the value of field 'NeedsUpdate'.
 116      */
 117     public boolean getNeedsUpdate(
 118     ) {
 119         return this._needsUpdate;
 120     }
 121
 122     /**
 123      * Method hasAutoUpdate.
 124      *
 125      * @return true if at least one AutoUpdate has been added
 126      */
 127     public boolean hasAutoUpdate(
 128     ) {
 129         return this._has_autoUpdate;
 130     }
 131
 132     /**
 133      * Method hasNeedsUpdate.
 134      *
 135      * @return true if at least one NeedsUpdate has been added
 136      */
 137     public boolean hasNeedsUpdate(
 138     ) {
 139         return this._has_needsUpdate;
 140     }
 141
 142     /**
 143      * Returns the value of field 'autoUpdate'. The field
 144      * 'autoUpdate' has the following description: should the
 145      * calculation be automatically performed on edits
 146      *
 147      * @return the value of field 'AutoUpdate'.
 148      */
 149     public boolean isAutoUpdate(
 150     ) {
 151         return this._autoUpdate;
 152     }
 153
 154     /**
 155      * Returns the value of field 'needsUpdate'. The field
 156      * 'needsUpdate' has the following description: should the
 157      * calculation be performed immediately after loading in order
 158      * to refresh results
 159      *
 160      * @return the value of field 'NeedsUpdate'.
 161      */
 162     public boolean isNeedsUpdate(
 163     ) {
 164         return this._needsUpdate;
 165     }
 166
 167     /**
 168      * Method isValid.
 169      *
 170      * @return true if this object is valid according to the schema
 171      */
 172     public boolean isValid(
 173     ) {
 174         try {
 175             validate();
 176         } catch (org.exolab.castor.xml.ValidationException vex) {
 177             return false;
 178         }
 179         return true;
 180     }
 181
 182     /**
 183      *
 184      *
 185      * @param out
 186      * @throws org.exolab.castor.xml.MarshalException if object is
 187      * null or if any SAXException is thrown during marshaling
 188      * @throws org.exolab.castor.xml.ValidationException if this
 189      * object is an invalid instance according to the schema
 190      */
 191     public void marshal(
 192             final java.io.Writer out)
 193     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 194         Marshaller.marshal(this, out);
 195     }
 196
 197     /**
 198      *
 199      *
 200      * @param handler
 201      * @throws java.io.IOException if an IOException occurs during
 202      * marshaling
 203      * @throws org.exolab.castor.xml.ValidationException if this
 204      * object is an invalid instance according to the schema
 205      * @throws org.exolab.castor.xml.MarshalException if object is
 206      * null or if any SAXException is thrown during marshaling
 207      */
 208     public void marshal(
 209             final org.xml.sax.ContentHandler handler)
 210     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 211         Marshaller.marshal(this, handler);
 212     }
 213
 214     /**
 215      * Sets the value of field 'autoUpdate'. The field 'autoUpdate'
 216      * has the following description: should the calculation be
 217      * automatically performed on edits
 218      *
 219      * @param autoUpdate the value of field 'autoUpdate'.
 220      */
 221     public void setAutoUpdate(
 222             final boolean autoUpdate) {
 223         this._autoUpdate = autoUpdate;
 224         this._has_autoUpdate = true;
 225     }
 226
 227     /**
 228      * Sets the value of field 'calcId'. The field 'calcId' has the
 229      * following description: handle for the calculation which uses
 230      * this parameter set
 231      *
 232      * @param calcId the value of field 'calcId'.
 233      */
 234     public void setCalcId(
 235             final java.lang.String calcId) {
 236         this._calcId = calcId;
 237     }
 238
 239     /**
 240      * Sets the value of field 'needsUpdate'. The field
 241      * 'needsUpdate' has the following description: should the
 242      * calculation be performed immediately after loading in order
 243      * to refresh results
 244      *
 245      * @param needsUpdate the value of field 'needsUpdate'.
 246      */
 247     public void setNeedsUpdate(
 248             final boolean needsUpdate) {
 249         this._needsUpdate = needsUpdate;
 250         this._has_needsUpdate = true;
 251     }
 252
 253     /**
 254      * Method unmarshal.
 255      *
 256      * @param reader
 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      * @return the unmarshaled
 262      * jalview.schemabinding.version2.CalcIdParam
 263      */
 264     public static jalview.schemabinding.version2.CalcIdParam unmarshal(
 265             final java.io.Reader reader)
 266     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 267         return (jalview.schemabinding.version2.CalcIdParam) Unmarshaller.unmarshal(jalview.schemabinding.version2.CalcIdParam.class, reader);
 268     }
 269
 270     /**
 271      *
 272      *
 273      * @throws org.exolab.castor.xml.ValidationException if this
 274      * object is an invalid instance according to the schema
 275      */
 276     public void validate(
 277     )
 278     throws org.exolab.castor.xml.ValidationException {
 279         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 280         validator.validate(this);
 281     }
 282
 283 }