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