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