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. If not, see <http://www.gnu.org/licenses/>.
17 * The Jalview Authors are detailed in the 'AUTHORS' file.
19 package jalview.binding;
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 Feature implements java.io.Serializable
36 // --------------------------/
37 // - Class/Member Variables -/
38 // --------------------------/
46 * keeps track of state for field: _begin
48 private boolean _has_begin;
56 * keeps track of state for field: _end
58 private boolean _has_end;
63 private java.lang.String _type;
68 private java.lang.String _description;
73 private java.lang.String _status;
90 public void deleteBegin()
92 this._has_begin = false;
97 public void deleteEnd()
99 this._has_end = false;
103 * Returns the value of field 'begin'.
105 * @return the value of field 'Begin'.
107 public int getBegin()
113 * Returns the value of field 'description'.
115 * @return the value of field 'Description'.
117 public java.lang.String getDescription()
119 return this._description;
123 * Returns the value of field 'end'.
125 * @return the value of field 'End'.
133 * Returns the value of field 'status'.
135 * @return the value of field 'Status'.
137 public java.lang.String getStatus()
143 * Returns the value of field 'type'.
145 * @return the value of field 'Type'.
147 public java.lang.String getType()
155 * @return true if at least one Begin has been added
157 public boolean hasBegin()
159 return this._has_begin;
165 * @return true if at least one End has been added
167 public boolean hasEnd()
169 return this._has_end;
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 'begin'.
230 * the value of field 'begin'.
232 public void setBegin(final int begin)
235 this._has_begin = true;
239 * Sets the value of field 'description'.
242 * the value of field 'description'.
244 public void setDescription(final java.lang.String description)
246 this._description = description;
250 * Sets the value of field 'end'.
253 * the value of field 'end'.
255 public void setEnd(final int end)
258 this._has_end = true;
262 * Sets the value of field 'status'.
265 * the value of field 'status'.
267 public void setStatus(final java.lang.String status)
269 this._status = status;
273 * Sets the value of field 'type'.
276 * the value of field 'type'.
278 public void setType(final java.lang.String type)
287 * @throws org.exolab.castor.xml.MarshalException
288 * if object is null or if any SAXException is thrown during
290 * @throws org.exolab.castor.xml.ValidationException
291 * if this object is an invalid instance according to the schema
292 * @return the unmarshaled jalview.binding.Feature
294 public static jalview.binding.Feature unmarshal(
295 final java.io.Reader reader)
296 throws org.exolab.castor.xml.MarshalException,
297 org.exolab.castor.xml.ValidationException
299 return (jalview.binding.Feature) Unmarshaller.unmarshal(
300 jalview.binding.Feature.class, reader);
306 * @throws org.exolab.castor.xml.ValidationException
307 * if this object is an invalid instance according to the schema
309 public void validate() throws org.exolab.castor.xml.ValidationException
311 org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
312 validator.validate(this);