2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ 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
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
21 package jalview.schemabinding.version2;
23 //---------------------------------/
24 //- Imported classes and packages -/
25 //---------------------------------/
27 import org.exolab.castor.xml.Marshaller;
28 import org.exolab.castor.xml.Unmarshaller;
33 * @version $Revision$ $Date$
35 public class CalcIdParam extends WebServiceParameterSet implements
39 // --------------------------/
40 // - Class/Member Variables -/
41 // --------------------------/
44 * handle for the calculation which uses this parameter set
46 private java.lang.String _calcId;
49 * should the calculation be performed immediately after loading in order to
52 private boolean _needsUpdate = false;
55 * keeps track of state for field: _needsUpdate
57 private boolean _has_needsUpdate;
60 * should the calculation be automatically performed on edits
62 private boolean _autoUpdate;
65 * keeps track of state for field: _autoUpdate
67 private boolean _has_autoUpdate;
84 public void deleteAutoUpdate()
86 this._has_autoUpdate = false;
91 public void deleteNeedsUpdate()
93 this._has_needsUpdate = false;
97 * Returns the value of field 'autoUpdate'. The field 'autoUpdate' has the
98 * following description: should the calculation be automatically performed on
101 * @return the value of field 'AutoUpdate'.
103 public boolean getAutoUpdate()
105 return this._autoUpdate;
109 * Returns the value of field 'calcId'. The field 'calcId' has the following
110 * description: handle for the calculation which uses this parameter set
112 * @return the value of field 'CalcId'.
114 public java.lang.String getCalcId()
120 * Returns the value of field 'needsUpdate'. The field 'needsUpdate' has the
121 * following description: should the calculation be performed immediately
122 * after loading in order to refresh results
124 * @return the value of field 'NeedsUpdate'.
126 public boolean getNeedsUpdate()
128 return this._needsUpdate;
132 * Method hasAutoUpdate.
134 * @return true if at least one AutoUpdate has been added
136 public boolean hasAutoUpdate()
138 return this._has_autoUpdate;
142 * Method hasNeedsUpdate.
144 * @return true if at least one NeedsUpdate has been added
146 public boolean hasNeedsUpdate()
148 return this._has_needsUpdate;
152 * Returns the value of field 'autoUpdate'. The field 'autoUpdate' has the
153 * following description: should the calculation be automatically performed on
156 * @return the value of field 'AutoUpdate'.
158 public boolean isAutoUpdate()
160 return this._autoUpdate;
164 * Returns the value of field 'needsUpdate'. The field 'needsUpdate' has the
165 * following description: should the calculation be performed immediately
166 * after loading in order to refresh results
168 * @return the value of field 'NeedsUpdate'.
170 public boolean isNeedsUpdate()
172 return this._needsUpdate;
178 * @return true if this object is valid according to the schema
180 public boolean isValid()
185 } catch (org.exolab.castor.xml.ValidationException vex)
196 * @throws org.exolab.castor.xml.MarshalException
197 * if object is null or if any SAXException is thrown during
199 * @throws org.exolab.castor.xml.ValidationException
200 * if this object is an invalid instance according to the schema
202 public void marshal(final java.io.Writer out)
203 throws org.exolab.castor.xml.MarshalException,
204 org.exolab.castor.xml.ValidationException
206 Marshaller.marshal(this, out);
213 * @throws java.io.IOException
214 * if an IOException occurs during marshaling
215 * @throws org.exolab.castor.xml.ValidationException
216 * if this object is an invalid instance according to the schema
217 * @throws org.exolab.castor.xml.MarshalException
218 * if object is null or if any SAXException is thrown during
221 public void marshal(final org.xml.sax.ContentHandler handler)
222 throws java.io.IOException,
223 org.exolab.castor.xml.MarshalException,
224 org.exolab.castor.xml.ValidationException
226 Marshaller.marshal(this, handler);
230 * Sets the value of field 'autoUpdate'. The field 'autoUpdate' has the
231 * following description: should the calculation be automatically performed on
235 * the value of field 'autoUpdate'.
237 public void setAutoUpdate(final boolean autoUpdate)
239 this._autoUpdate = autoUpdate;
240 this._has_autoUpdate = true;
244 * Sets the value of field 'calcId'. The field 'calcId' has the following
245 * description: handle for the calculation which uses this parameter set
248 * the value of field 'calcId'.
250 public void setCalcId(final java.lang.String calcId)
252 this._calcId = calcId;
256 * Sets the value of field 'needsUpdate'. The field 'needsUpdate' has the
257 * following description: should the calculation be performed immediately
258 * after loading in order to refresh results
261 * the value of field 'needsUpdate'.
263 public void setNeedsUpdate(final boolean needsUpdate)
265 this._needsUpdate = needsUpdate;
266 this._has_needsUpdate = true;
273 * @throws org.exolab.castor.xml.MarshalException
274 * if object is null or if any SAXException is thrown during
276 * @throws org.exolab.castor.xml.ValidationException
277 * if this object is an invalid instance according to the schema
278 * @return the unmarshaled jalview.schemabinding.version2.CalcIdParam
280 public static jalview.schemabinding.version2.CalcIdParam unmarshal(
281 final java.io.Reader reader)
282 throws org.exolab.castor.xml.MarshalException,
283 org.exolab.castor.xml.ValidationException
285 return (jalview.schemabinding.version2.CalcIdParam) Unmarshaller
286 .unmarshal(jalview.schemabinding.version2.CalcIdParam.class,
293 * @throws org.exolab.castor.xml.ValidationException
294 * if this object is an invalid instance according to the schema
296 public void validate() throws org.exolab.castor.xml.ValidationException
298 org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
299 validator.validate(this);