JAL-2587 prevented double overview recalc on opening overview
[jalview.git] / src / jalview / binding / AnnotationElement.java
1 /*
2  * This class was automatically generated with 
3  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
4  * Schema.
5  * $Id$
6  */
7
8 package jalview.binding;
9
10 //---------------------------------/
11 //- Imported classes and packages -/
12 //---------------------------------/
13
14 import org.exolab.castor.xml.Marshaller;
15 import org.exolab.castor.xml.Unmarshaller;
16
17 /**
18  * Class AnnotationElement.
19  * 
20  * @version $Revision$ $Date$
21  */
22 public class AnnotationElement implements java.io.Serializable
23 {
24
25   // --------------------------/
26   // - Class/Member Variables -/
27   // --------------------------/
28
29   /**
30    * Field _position.
31    */
32   private int _position;
33
34   /**
35    * keeps track of state for field: _position
36    */
37   private boolean _has_position;
38
39   /**
40    * Field _displayCharacter.
41    */
42   private java.lang.String _displayCharacter;
43
44   /**
45    * Field _description.
46    */
47   private java.lang.String _description;
48
49   /**
50    * Field _secondaryStructure.
51    */
52   private java.lang.String _secondaryStructure;
53
54   /**
55    * Field _value.
56    */
57   private float _value;
58
59   /**
60    * keeps track of state for field: _value
61    */
62   private boolean _has_value;
63
64   // ----------------/
65   // - Constructors -/
66   // ----------------/
67
68   public AnnotationElement()
69   {
70     super();
71   }
72
73   // -----------/
74   // - Methods -/
75   // -----------/
76
77   /**
78      */
79   public void deletePosition()
80   {
81     this._has_position = false;
82   }
83
84   /**
85      */
86   public void deleteValue()
87   {
88     this._has_value = false;
89   }
90
91   /**
92    * Returns the value of field 'description'.
93    * 
94    * @return the value of field 'Description'.
95    */
96   public java.lang.String getDescription()
97   {
98     return this._description;
99   }
100
101   /**
102    * Returns the value of field 'displayCharacter'.
103    * 
104    * @return the value of field 'DisplayCharacter'.
105    */
106   public java.lang.String getDisplayCharacter()
107   {
108     return this._displayCharacter;
109   }
110
111   /**
112    * Returns the value of field 'position'.
113    * 
114    * @return the value of field 'Position'.
115    */
116   public int getPosition()
117   {
118     return this._position;
119   }
120
121   /**
122    * Returns the value of field 'secondaryStructure'.
123    * 
124    * @return the value of field 'SecondaryStructure'.
125    */
126   public java.lang.String getSecondaryStructure()
127   {
128     return this._secondaryStructure;
129   }
130
131   /**
132    * Returns the value of field 'value'.
133    * 
134    * @return the value of field 'Value'.
135    */
136   public float getValue()
137   {
138     return this._value;
139   }
140
141   /**
142    * Method hasPosition.
143    * 
144    * @return true if at least one Position has been added
145    */
146   public boolean hasPosition()
147   {
148     return this._has_position;
149   }
150
151   /**
152    * Method hasValue.
153    * 
154    * @return true if at least one Value has been added
155    */
156   public boolean hasValue()
157   {
158     return this._has_value;
159   }
160
161   /**
162    * Method isValid.
163    * 
164    * @return true if this object is valid according to the schema
165    */
166   public boolean isValid()
167   {
168     try
169     {
170       validate();
171     } catch (org.exolab.castor.xml.ValidationException vex)
172     {
173       return false;
174     }
175     return true;
176   }
177
178   /**
179    * 
180    * 
181    * @param out
182    * @throws org.exolab.castor.xml.MarshalException
183    *           if object is null or if any SAXException is thrown during
184    *           marshaling
185    * @throws org.exolab.castor.xml.ValidationException
186    *           if this object is an invalid instance according to the schema
187    */
188   public void marshal(final java.io.Writer out)
189           throws org.exolab.castor.xml.MarshalException,
190           org.exolab.castor.xml.ValidationException
191   {
192     Marshaller.marshal(this, out);
193   }
194
195   /**
196    * 
197    * 
198    * @param handler
199    * @throws java.io.IOException
200    *           if an IOException occurs during marshaling
201    * @throws org.exolab.castor.xml.ValidationException
202    *           if this object is an invalid instance according to the schema
203    * @throws org.exolab.castor.xml.MarshalException
204    *           if object is null or if any SAXException is thrown during
205    *           marshaling
206    */
207   public void marshal(final org.xml.sax.ContentHandler handler)
208           throws java.io.IOException,
209           org.exolab.castor.xml.MarshalException,
210           org.exolab.castor.xml.ValidationException
211   {
212     Marshaller.marshal(this, handler);
213   }
214
215   /**
216    * Sets the value of field 'description'.
217    * 
218    * @param description
219    *          the value of field 'description'.
220    */
221   public void setDescription(final java.lang.String description)
222   {
223     this._description = description;
224   }
225
226   /**
227    * Sets the value of field 'displayCharacter'.
228    * 
229    * @param displayCharacter
230    *          the value of field 'displayCharacter'
231    */
232   public void setDisplayCharacter(final java.lang.String displayCharacter)
233   {
234     this._displayCharacter = displayCharacter;
235   }
236
237   /**
238    * Sets the value of field 'position'.
239    * 
240    * @param position
241    *          the value of field 'position'.
242    */
243   public void setPosition(final int position)
244   {
245     this._position = position;
246     this._has_position = true;
247   }
248
249   /**
250    * Sets the value of field 'secondaryStructure'.
251    * 
252    * @param secondaryStructure
253    *          the value of field 'secondaryStructure'.
254    */
255   public void setSecondaryStructure(
256           final java.lang.String secondaryStructure)
257   {
258     this._secondaryStructure = secondaryStructure;
259   }
260
261   /**
262    * Sets the value of field 'value'.
263    * 
264    * @param value
265    *          the value of field 'value'.
266    */
267   public void setValue(final float value)
268   {
269     this._value = value;
270     this._has_value = true;
271   }
272
273   /**
274    * Method unmarshal.
275    * 
276    * @param reader
277    * @throws org.exolab.castor.xml.MarshalException
278    *           if object is null or if any SAXException is thrown during
279    *           marshaling
280    * @throws org.exolab.castor.xml.ValidationException
281    *           if this object is an invalid instance according to the schema
282    * @return the unmarshaled jalview.binding.AnnotationElement
283    */
284   public static jalview.binding.AnnotationElement unmarshal(
285           final java.io.Reader reader)
286           throws org.exolab.castor.xml.MarshalException,
287           org.exolab.castor.xml.ValidationException
288   {
289     return (jalview.binding.AnnotationElement) Unmarshaller.unmarshal(
290             jalview.binding.AnnotationElement.class, reader);
291   }
292
293   /**
294    * 
295    * 
296    * @throws org.exolab.castor.xml.ValidationException
297    *           if this object is an invalid instance according to the schema
298    */
299   public void validate() throws org.exolab.castor.xml.ValidationException
300   {
301     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
302     validator.validate(this);
303   }
304
305 }