1 /*******************************************************************************
2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
3 * Copyright (C) 2014 The Jalview Authors
5 * This file is part of Jalview.
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.
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.
16 * You should have received a copy of the GNU General Public License along with Jalview.
17 * If not, see <http://www.gnu.org/licenses/>.
18 * The Jalview Authors are detailed in the 'AUTHORS' file.
19 ******************************************************************************/
21 * This class was automatically generated with
22 * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
27 package jalview.schemabinding.version2;
29 //---------------------------------/
30 //- Imported classes and packages -/
31 //---------------------------------/
33 import org.exolab.castor.xml.Marshaller;
34 import org.exolab.castor.xml.Unmarshaller;
39 * @version $Revision$ $Date$
41 public class CalcIdParam extends WebServiceParameterSet implements
45 // --------------------------/
46 // - Class/Member Variables -/
47 // --------------------------/
50 * handle for the calculation which uses this parameter set
52 private java.lang.String _calcId;
55 * should the calculation be performed immediately after loading in order to
58 private boolean _needsUpdate = false;
61 * keeps track of state for field: _needsUpdate
63 private boolean _has_needsUpdate;
66 * should the calculation be automatically performed on edits
68 private boolean _autoUpdate;
71 * keeps track of state for field: _autoUpdate
73 private boolean _has_autoUpdate;
90 public void deleteAutoUpdate()
92 this._has_autoUpdate = false;
97 public void deleteNeedsUpdate()
99 this._has_needsUpdate = false;
103 * Returns the value of field 'autoUpdate'. The field 'autoUpdate' has the
104 * following description: should the calculation be automatically performed on
107 * @return the value of field 'AutoUpdate'.
109 public boolean getAutoUpdate()
111 return this._autoUpdate;
115 * Returns the value of field 'calcId'. The field 'calcId' has the following
116 * description: handle for the calculation which uses this parameter set
118 * @return the value of field 'CalcId'.
120 public java.lang.String getCalcId()
126 * Returns the value of field 'needsUpdate'. The field 'needsUpdate' has the
127 * following description: should the calculation be performed immediately
128 * after loading in order to refresh results
130 * @return the value of field 'NeedsUpdate'.
132 public boolean getNeedsUpdate()
134 return this._needsUpdate;
138 * Method hasAutoUpdate.
140 * @return true if at least one AutoUpdate has been added
142 public boolean hasAutoUpdate()
144 return this._has_autoUpdate;
148 * Method hasNeedsUpdate.
150 * @return true if at least one NeedsUpdate has been added
152 public boolean hasNeedsUpdate()
154 return this._has_needsUpdate;
158 * Returns the value of field 'autoUpdate'. The field 'autoUpdate' has the
159 * following description: should the calculation be automatically performed on
162 * @return the value of field 'AutoUpdate'.
164 public boolean isAutoUpdate()
166 return this._autoUpdate;
170 * Returns the value of field 'needsUpdate'. The field 'needsUpdate' has the
171 * following description: should the calculation be performed immediately
172 * after loading in order to refresh results
174 * @return the value of field 'NeedsUpdate'.
176 public boolean isNeedsUpdate()
178 return this._needsUpdate;
184 * @return true if this object is valid according to the schema
186 public boolean isValid()
191 } catch (org.exolab.castor.xml.ValidationException vex)
202 * @throws org.exolab.castor.xml.MarshalException
203 * if object is null or if any SAXException is thrown during
205 * @throws org.exolab.castor.xml.ValidationException
206 * if this object is an invalid instance according to the schema
208 public void marshal(final java.io.Writer out)
209 throws org.exolab.castor.xml.MarshalException,
210 org.exolab.castor.xml.ValidationException
212 Marshaller.marshal(this, out);
219 * @throws java.io.IOException
220 * if an IOException occurs during marshaling
221 * @throws org.exolab.castor.xml.ValidationException
222 * if this object is an invalid instance according to the schema
223 * @throws org.exolab.castor.xml.MarshalException
224 * if object is null or if any SAXException is thrown during
227 public void marshal(final org.xml.sax.ContentHandler handler)
228 throws java.io.IOException,
229 org.exolab.castor.xml.MarshalException,
230 org.exolab.castor.xml.ValidationException
232 Marshaller.marshal(this, handler);
236 * Sets the value of field 'autoUpdate'. The field 'autoUpdate' has the
237 * following description: should the calculation be automatically performed on
241 * the value of field 'autoUpdate'.
243 public void setAutoUpdate(final boolean autoUpdate)
245 this._autoUpdate = autoUpdate;
246 this._has_autoUpdate = true;
250 * Sets the value of field 'calcId'. The field 'calcId' has the following
251 * description: handle for the calculation which uses this parameter set
254 * the value of field 'calcId'.
256 public void setCalcId(final java.lang.String calcId)
258 this._calcId = calcId;
262 * Sets the value of field 'needsUpdate'. The field 'needsUpdate' has the
263 * following description: should the calculation be performed immediately
264 * after loading in order to refresh results
267 * the value of field 'needsUpdate'.
269 public void setNeedsUpdate(final boolean needsUpdate)
271 this._needsUpdate = needsUpdate;
272 this._has_needsUpdate = true;
279 * @throws org.exolab.castor.xml.MarshalException
280 * if object is null or if any SAXException is thrown during
282 * @throws org.exolab.castor.xml.ValidationException
283 * if this object is an invalid instance according to the schema
284 * @return the unmarshaled jalview.schemabinding.version2.CalcIdParam
286 public static jalview.schemabinding.version2.CalcIdParam unmarshal(
287 final java.io.Reader reader)
288 throws org.exolab.castor.xml.MarshalException,
289 org.exolab.castor.xml.ValidationException
291 return (jalview.schemabinding.version2.CalcIdParam) Unmarshaller
292 .unmarshal(jalview.schemabinding.version2.CalcIdParam.class,
299 * @throws org.exolab.castor.xml.ValidationException
300 * if this object is an invalid instance according to the schema
302 public void validate() throws org.exolab.castor.xml.ValidationException
304 org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
305 validator.validate(this);