applied 2009 GPL license
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / AlcodonFrameDescriptor.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4.0.b2)\r
3  * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
4  * \r
5  * This program is free software; you can redistribute it and/or\r
6  * modify it under the terms of the GNU General Public License\r
7  * as published by the Free Software Foundation; either version 2\r
8  * of the License, or (at your option) any later version.\r
9  * \r
10  * This program is distributed in the hope that it will be useful,\r
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
13  * GNU General Public License for more details.\r
14  * \r
15  * You should have received a copy of the GNU General Public License\r
16  * along with this program; if not, write to the Free Software\r
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
18  */\r
19 package jalview.schemabinding.version2.descriptors;\r
20 \r
21 // ---------------------------------/\r
22 // - Imported classes and packages -/\r
23 // ---------------------------------/\r
24 \r
25 import jalview.schemabinding.version2.AlcodonFrame;\r
26 \r
27 /**\r
28  * Class AlcodonFrameDescriptor.\r
29  * \r
30  * @version $Revision$ $Date$\r
31  */\r
32 public class AlcodonFrameDescriptor extends\r
33         org.exolab.castor.xml.util.XMLClassDescriptorImpl\r
34 {\r
35 \r
36   // --------------------------/\r
37   // - Class/Member Variables -/\r
38   // --------------------------/\r
39 \r
40   /**\r
41    * Field _elementDefinition.\r
42    */\r
43   private boolean _elementDefinition;\r
44 \r
45   /**\r
46    * Field _nsPrefix.\r
47    */\r
48   private java.lang.String _nsPrefix;\r
49 \r
50   /**\r
51    * Field _nsURI.\r
52    */\r
53   private java.lang.String _nsURI;\r
54 \r
55   /**\r
56    * Field _xmlName.\r
57    */\r
58   private java.lang.String _xmlName;\r
59 \r
60   // ----------------/\r
61   // - Constructors -/\r
62   // ----------------/\r
63 \r
64   public AlcodonFrameDescriptor()\r
65   {\r
66     super();\r
67     _nsURI = "www.vamsas.ac.uk/jalview/version2";\r
68     _xmlName = "AlcodonFrame";\r
69     _elementDefinition = true;\r
70 \r
71     // -- set grouping compositor\r
72     setCompositorAsSequence();\r
73     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;\r
74     org.exolab.castor.mapping.FieldHandler handler = null;\r
75     org.exolab.castor.xml.FieldValidator fieldValidator = null;\r
76     // -- initialize attribute descriptors\r
77 \r
78     // -- initialize element descriptors\r
79 \r
80     // -- _alcodonList\r
81     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
82             jalview.schemabinding.version2.Alcodon.class, "_alcodonList",\r
83             "alcodon", org.exolab.castor.xml.NodeType.Element);\r
84     handler = new org.exolab.castor.xml.XMLFieldHandler()\r
85     {\r
86       public java.lang.Object getValue(java.lang.Object object)\r
87               throws IllegalStateException\r
88       {\r
89         AlcodonFrame target = (AlcodonFrame) object;\r
90         return target.getAlcodon();\r
91       }\r
92 \r
93       public void setValue(java.lang.Object object, java.lang.Object value)\r
94               throws IllegalStateException, IllegalArgumentException\r
95       {\r
96         try\r
97         {\r
98           AlcodonFrame target = (AlcodonFrame) object;\r
99           target.addAlcodon((jalview.schemabinding.version2.Alcodon) value);\r
100         } catch (java.lang.Exception ex)\r
101         {\r
102           throw new IllegalStateException(ex.toString());\r
103         }\r
104       }\r
105 \r
106       public void resetValue(Object object) throws IllegalStateException,\r
107               IllegalArgumentException\r
108       {\r
109         try\r
110         {\r
111           AlcodonFrame target = (AlcodonFrame) object;\r
112           target.removeAllAlcodon();\r
113         } catch (java.lang.Exception ex)\r
114         {\r
115           throw new IllegalStateException(ex.toString());\r
116         }\r
117       }\r
118 \r
119       public java.lang.Object newInstance(java.lang.Object parent)\r
120       {\r
121         return new jalview.schemabinding.version2.Alcodon();\r
122       }\r
123     };\r
124     desc.setHandler(handler);\r
125     desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");\r
126     desc.setMultivalued(true);\r
127     addFieldDescriptor(desc);\r
128 \r
129     // -- validation code for: _alcodonList\r
130     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
131     fieldValidator.setMinOccurs(0);\r
132     { // -- local scope\r
133     }\r
134     desc.setValidator(fieldValidator);\r
135     // -- _alcodMapList\r
136     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
137             jalview.schemabinding.version2.AlcodMap.class, "_alcodMapList",\r
138             "alcodMap", org.exolab.castor.xml.NodeType.Element);\r
139     handler = new org.exolab.castor.xml.XMLFieldHandler()\r
140     {\r
141       public java.lang.Object getValue(java.lang.Object object)\r
142               throws IllegalStateException\r
143       {\r
144         AlcodonFrame target = (AlcodonFrame) object;\r
145         return target.getAlcodMap();\r
146       }\r
147 \r
148       public void setValue(java.lang.Object object, java.lang.Object value)\r
149               throws IllegalStateException, IllegalArgumentException\r
150       {\r
151         try\r
152         {\r
153           AlcodonFrame target = (AlcodonFrame) object;\r
154           target\r
155                   .addAlcodMap((jalview.schemabinding.version2.AlcodMap) value);\r
156         } catch (java.lang.Exception ex)\r
157         {\r
158           throw new IllegalStateException(ex.toString());\r
159         }\r
160       }\r
161 \r
162       public void resetValue(Object object) throws IllegalStateException,\r
163               IllegalArgumentException\r
164       {\r
165         try\r
166         {\r
167           AlcodonFrame target = (AlcodonFrame) object;\r
168           target.removeAllAlcodMap();\r
169         } catch (java.lang.Exception ex)\r
170         {\r
171           throw new IllegalStateException(ex.toString());\r
172         }\r
173       }\r
174 \r
175       public java.lang.Object newInstance(java.lang.Object parent)\r
176       {\r
177         return new jalview.schemabinding.version2.AlcodMap();\r
178       }\r
179     };\r
180     desc.setHandler(handler);\r
181     desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");\r
182     desc.setMultivalued(true);\r
183     addFieldDescriptor(desc);\r
184 \r
185     // -- validation code for: _alcodMapList\r
186     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
187     fieldValidator.setMinOccurs(0);\r
188     { // -- local scope\r
189     }\r
190     desc.setValidator(fieldValidator);\r
191   }\r
192 \r
193   // -----------/\r
194   // - Methods -/\r
195   // -----------/\r
196 \r
197   /**\r
198    * Method getAccessMode.\r
199    * \r
200    * @return the access mode specified for this class.\r
201    */\r
202   public org.exolab.castor.mapping.AccessMode getAccessMode()\r
203   {\r
204     return null;\r
205   }\r
206 \r
207   /**\r
208    * Method getIdentity.\r
209    * \r
210    * @return the identity field, null if this class has no identity.\r
211    */\r
212   public org.exolab.castor.mapping.FieldDescriptor getIdentity()\r
213   {\r
214     return super.getIdentity();\r
215   }\r
216 \r
217   /**\r
218    * Method getJavaClass.\r
219    * \r
220    * @return the Java class represented by this descriptor.\r
221    */\r
222   public java.lang.Class getJavaClass()\r
223   {\r
224     return jalview.schemabinding.version2.AlcodonFrame.class;\r
225   }\r
226 \r
227   /**\r
228    * Method getNameSpacePrefix.\r
229    * \r
230    * @return the namespace prefix to use when marshaling as XML.\r
231    */\r
232   public java.lang.String getNameSpacePrefix()\r
233   {\r
234     return _nsPrefix;\r
235   }\r
236 \r
237   /**\r
238    * Method getNameSpaceURI.\r
239    * \r
240    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
241    */\r
242   public java.lang.String getNameSpaceURI()\r
243   {\r
244     return _nsURI;\r
245   }\r
246 \r
247   /**\r
248    * Method getValidator.\r
249    * \r
250    * @return a specific validator for the class described by this\r
251    *         ClassDescriptor.\r
252    */\r
253   public org.exolab.castor.xml.TypeValidator getValidator()\r
254   {\r
255     return this;\r
256   }\r
257 \r
258   /**\r
259    * Method getXMLName.\r
260    * \r
261    * @return the XML Name for the Class being described.\r
262    */\r
263   public java.lang.String getXMLName()\r
264   {\r
265     return _xmlName;\r
266   }\r
267 \r
268   /**\r
269    * Method isElementDefinition.\r
270    * \r
271    * @return true if XML schema definition of this Class is that of a global\r
272    *         element or element with anonymous type definition.\r
273    */\r
274   public boolean isElementDefinition()\r
275   {\r
276     return _elementDefinition;\r
277   }\r
278 \r
279 }\r