2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
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. If not, see <http://www.gnu.org/licenses/>.
17 * The Jalview Authors are detailed in the 'AUTHORS' file.
19 package jalview.schemabinding.version2;
21 //---------------------------------/
22 //- Imported classes and packages -/
23 //---------------------------------/
25 import org.exolab.castor.xml.Marshaller;
26 import org.exolab.castor.xml.Unmarshaller;
31 * @version $Revision$ $Date$
33 public class CalcIdParam extends WebServiceParameterSet implements
37 // --------------------------/
38 // - Class/Member Variables -/
39 // --------------------------/
42 * handle for the calculation which uses this parameter set
44 private java.lang.String _calcId;
47 * should the calculation be performed immediately after loading in order to
50 private boolean _needsUpdate = false;
53 * keeps track of state for field: _needsUpdate
55 private boolean _has_needsUpdate;
58 * should the calculation be automatically performed on edits
60 private boolean _autoUpdate;
63 * keeps track of state for field: _autoUpdate
65 private boolean _has_autoUpdate;
82 public void deleteAutoUpdate()
84 this._has_autoUpdate = false;
89 public void deleteNeedsUpdate()
91 this._has_needsUpdate = false;
95 * Returns the value of field 'autoUpdate'. The field 'autoUpdate' has the
96 * following description: should the calculation be automatically performed on
99 * @return the value of field 'AutoUpdate'.
101 public boolean getAutoUpdate()
103 return this._autoUpdate;
107 * Returns the value of field 'calcId'. The field 'calcId' has the following
108 * description: handle for the calculation which uses this parameter set
110 * @return the value of field 'CalcId'.
112 public java.lang.String getCalcId()
118 * Returns the value of field 'needsUpdate'. The field 'needsUpdate' has the
119 * following description: should the calculation be performed immediately
120 * after loading in order to refresh results
122 * @return the value of field 'NeedsUpdate'.
124 public boolean getNeedsUpdate()
126 return this._needsUpdate;
130 * Method hasAutoUpdate.
132 * @return true if at least one AutoUpdate has been added
134 public boolean hasAutoUpdate()
136 return this._has_autoUpdate;
140 * Method hasNeedsUpdate.
142 * @return true if at least one NeedsUpdate has been added
144 public boolean hasNeedsUpdate()
146 return this._has_needsUpdate;
150 * Returns the value of field 'autoUpdate'. The field 'autoUpdate' has the
151 * following description: should the calculation be automatically performed on
154 * @return the value of field 'AutoUpdate'.
156 public boolean isAutoUpdate()
158 return this._autoUpdate;
162 * Returns the value of field 'needsUpdate'. The field 'needsUpdate' has the
163 * following description: should the calculation be performed immediately
164 * after loading in order to refresh results
166 * @return the value of field 'NeedsUpdate'.
168 public boolean isNeedsUpdate()
170 return this._needsUpdate;
176 * @return true if this object is valid according to the schema
178 public boolean isValid()
183 } catch (org.exolab.castor.xml.ValidationException vex)
194 * @throws org.exolab.castor.xml.MarshalException
195 * if object is null or if any SAXException is thrown during
197 * @throws org.exolab.castor.xml.ValidationException
198 * if this object is an invalid instance according to the schema
200 public void marshal(final java.io.Writer out)
201 throws org.exolab.castor.xml.MarshalException,
202 org.exolab.castor.xml.ValidationException
204 Marshaller.marshal(this, out);
211 * @throws java.io.IOException
212 * if an IOException occurs during marshaling
213 * @throws org.exolab.castor.xml.ValidationException
214 * if this object is an invalid instance according to the schema
215 * @throws org.exolab.castor.xml.MarshalException
216 * if object is null or if any SAXException is thrown during
219 public void marshal(final org.xml.sax.ContentHandler handler)
220 throws java.io.IOException,
221 org.exolab.castor.xml.MarshalException,
222 org.exolab.castor.xml.ValidationException
224 Marshaller.marshal(this, handler);
228 * Sets the value of field 'autoUpdate'. The field 'autoUpdate' has the
229 * following description: should the calculation be automatically performed on
233 * the value of field 'autoUpdate'.
235 public void setAutoUpdate(final boolean autoUpdate)
237 this._autoUpdate = autoUpdate;
238 this._has_autoUpdate = true;
242 * Sets the value of field 'calcId'. The field 'calcId' has the following
243 * description: handle for the calculation which uses this parameter set
246 * the value of field 'calcId'.
248 public void setCalcId(final java.lang.String calcId)
250 this._calcId = calcId;
254 * Sets the value of field 'needsUpdate'. The field 'needsUpdate' has the
255 * following description: should the calculation be performed immediately
256 * after loading in order to refresh results
259 * the value of field 'needsUpdate'.
261 public void setNeedsUpdate(final boolean needsUpdate)
263 this._needsUpdate = needsUpdate;
264 this._has_needsUpdate = true;
271 * @throws org.exolab.castor.xml.MarshalException
272 * if object is null or if any SAXException is thrown during
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
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
283 return (jalview.schemabinding.version2.CalcIdParam) Unmarshaller
284 .unmarshal(jalview.schemabinding.version2.CalcIdParam.class,
291 * @throws org.exolab.castor.xml.ValidationException
292 * if this object is an invalid instance according to the schema
294 public void validate() throws org.exolab.castor.xml.ValidationException
296 org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
297 validator.validate(this);