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