2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
3 * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
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/>.
18 package jalview.schemabinding.version2;
20 //---------------------------------/
21 //- Imported classes and packages -/
22 //---------------------------------/
24 import org.exolab.castor.xml.Marshaller;
25 import org.exolab.castor.xml.Unmarshaller;
30 * @version $Revision$ $Date$
32 public class CalcIdParam extends WebServiceParameterSet implements
36 // --------------------------/
37 // - Class/Member Variables -/
38 // --------------------------/
41 * handle for the calculation which uses this parameter set
43 private java.lang.String _calcId;
46 * should the calculation be performed immediately after loading in order to
49 private boolean _needsUpdate = false;
52 * keeps track of state for field: _needsUpdate
54 private boolean _has_needsUpdate;
57 * should the calculation be automatically performed on edits
59 private boolean _autoUpdate;
62 * keeps track of state for field: _autoUpdate
64 private boolean _has_autoUpdate;
81 public void deleteAutoUpdate()
83 this._has_autoUpdate = false;
88 public void deleteNeedsUpdate()
90 this._has_needsUpdate = false;
94 * Returns the value of field 'autoUpdate'. The field 'autoUpdate' has the
95 * following description: should the calculation be automatically performed on
98 * @return the value of field 'AutoUpdate'.
100 public boolean getAutoUpdate()
102 return this._autoUpdate;
106 * Returns the value of field 'calcId'. The field 'calcId' has the following
107 * description: handle for the calculation which uses this parameter set
109 * @return the value of field 'CalcId'.
111 public java.lang.String getCalcId()
117 * Returns the value of field 'needsUpdate'. The field 'needsUpdate' has the
118 * following description: should the calculation be performed immediately
119 * after loading in order to refresh results
121 * @return the value of field 'NeedsUpdate'.
123 public boolean getNeedsUpdate()
125 return this._needsUpdate;
129 * Method hasAutoUpdate.
131 * @return true if at least one AutoUpdate has been added
133 public boolean hasAutoUpdate()
135 return this._has_autoUpdate;
139 * Method hasNeedsUpdate.
141 * @return true if at least one NeedsUpdate has been added
143 public boolean hasNeedsUpdate()
145 return this._has_needsUpdate;
149 * Returns the value of field 'autoUpdate'. The field 'autoUpdate' has the
150 * following description: should the calculation be automatically performed on
153 * @return the value of field 'AutoUpdate'.
155 public boolean isAutoUpdate()
157 return this._autoUpdate;
161 * Returns the value of field 'needsUpdate'. The field 'needsUpdate' has the
162 * following description: should the calculation be performed immediately
163 * after loading in order to refresh results
165 * @return the value of field 'NeedsUpdate'.
167 public boolean isNeedsUpdate()
169 return this._needsUpdate;
175 * @return true if this object is valid according to the schema
177 public boolean isValid()
182 } catch (org.exolab.castor.xml.ValidationException vex)
193 * @throws org.exolab.castor.xml.MarshalException
194 * if object is null or if any SAXException is thrown during
196 * @throws org.exolab.castor.xml.ValidationException
197 * if this object is an invalid instance according to the schema
199 public void marshal(final java.io.Writer out)
200 throws org.exolab.castor.xml.MarshalException,
201 org.exolab.castor.xml.ValidationException
203 Marshaller.marshal(this, out);
210 * @throws java.io.IOException
211 * if an IOException occurs during marshaling
212 * @throws org.exolab.castor.xml.ValidationException
213 * if this object is an invalid instance according to the schema
214 * @throws org.exolab.castor.xml.MarshalException
215 * if object is null or if any SAXException is thrown during
218 public void marshal(final org.xml.sax.ContentHandler handler)
219 throws java.io.IOException,
220 org.exolab.castor.xml.MarshalException,
221 org.exolab.castor.xml.ValidationException
223 Marshaller.marshal(this, handler);
227 * Sets the value of field 'autoUpdate'. The field 'autoUpdate' has the
228 * following description: should the calculation be automatically performed on
232 * the value of field 'autoUpdate'.
234 public void setAutoUpdate(final boolean autoUpdate)
236 this._autoUpdate = autoUpdate;
237 this._has_autoUpdate = true;
241 * Sets the value of field 'calcId'. The field 'calcId' has the following
242 * description: handle for the calculation which uses this parameter set
245 * the value of field 'calcId'.
247 public void setCalcId(final java.lang.String calcId)
249 this._calcId = calcId;
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
258 * the value of field 'needsUpdate'.
260 public void setNeedsUpdate(final boolean needsUpdate)
262 this._needsUpdate = needsUpdate;
263 this._has_needsUpdate = true;
270 * @throws org.exolab.castor.xml.MarshalException
271 * if object is null or if any SAXException is thrown during
273 * @throws org.exolab.castor.xml.ValidationException
274 * if this object is an invalid instance according to the schema
275 * @return the unmarshaled jalview.schemabinding.version2.CalcIdParam
277 public static jalview.schemabinding.version2.CalcIdParam unmarshal(
278 final java.io.Reader reader)
279 throws org.exolab.castor.xml.MarshalException,
280 org.exolab.castor.xml.ValidationException
282 return (jalview.schemabinding.version2.CalcIdParam) Unmarshaller
283 .unmarshal(jalview.schemabinding.version2.CalcIdParam.class,
290 * @throws org.exolab.castor.xml.ValidationException
291 * if this object is an invalid instance according to the schema
293 public void validate() throws org.exolab.castor.xml.ValidationException
295 org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
296 validator.validate(this);