d18b8c122dcc0749fad5e049d079103952e6bf60
[vamsas.git] / src / uk / ac / vamsas / objects / core / descriptors / SequenceDescriptor.java
1 /*\r
2  * This class was automatically generated with \r
3  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
4  * Schema.\r
5  * $Id$\r
6  */\r
7 \r
8 package uk.ac.vamsas.objects.core.descriptors;\r
9 \r
10   //---------------------------------/\r
11  //- Imported classes and packages -/\r
12 //---------------------------------/\r
13 \r
14 import uk.ac.vamsas.objects.core.Sequence;\r
15 \r
16 /**\r
17  * Class SequenceDescriptor.\r
18  * \r
19  * @version $Revision$ $Date$\r
20  */\r
21 public class SequenceDescriptor extends uk.ac.vamsas.objects.core.descriptors.SequenceTypeDescriptor {\r
22 \r
23 \r
24       //--------------------------/\r
25      //- Class/Member Variables -/\r
26     //--------------------------/\r
27 \r
28     /**\r
29      * Field _elementDefinition.\r
30      */\r
31     private boolean _elementDefinition;\r
32 \r
33     /**\r
34      * Field _nsPrefix.\r
35      */\r
36     private java.lang.String _nsPrefix;\r
37 \r
38     /**\r
39      * Field _nsURI.\r
40      */\r
41     private java.lang.String _nsURI;\r
42 \r
43     /**\r
44      * Field _xmlName.\r
45      */\r
46     private java.lang.String _xmlName;\r
47 \r
48 \r
49       //----------------/\r
50      //- Constructors -/\r
51     //----------------/\r
52 \r
53     public SequenceDescriptor() {\r
54         super();\r
55         setExtendsWithoutFlatten(new uk.ac.vamsas.objects.core.descriptors.SequenceTypeDescriptor());\r
56         _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
57         _xmlName = "Sequence";\r
58         _elementDefinition = true;\r
59         \r
60         //-- set grouping compositor\r
61         setCompositorAsSequence();\r
62         org.exolab.castor.xml.util.XMLFieldDescriptorImpl  desc           = null;\r
63         org.exolab.castor.mapping.FieldHandler             handler        = null;\r
64         org.exolab.castor.xml.FieldValidator               fieldValidator = null;\r
65         //-- initialize attribute descriptors\r
66         \r
67         //-- _id\r
68         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.String.class, "_id", "id", org.exolab.castor.xml.NodeType.Attribute);\r
69         super.setIdentity(desc);\r
70         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
71             public java.lang.Object getValue( java.lang.Object object ) \r
72                 throws IllegalStateException\r
73             {\r
74                 Sequence target = (Sequence) object;\r
75                 return target.getId();\r
76             }\r
77             public void setValue( java.lang.Object object, java.lang.Object value) \r
78                 throws IllegalStateException, IllegalArgumentException\r
79             {\r
80                 try {\r
81                     Sequence target = (Sequence) object;\r
82                     target.setId( (java.lang.String) value);\r
83                 } catch (java.lang.Exception ex) {\r
84                     throw new IllegalStateException(ex.toString());\r
85                 }\r
86             }\r
87             public java.lang.Object newInstance(java.lang.Object parent) {\r
88                 return new java.lang.String();\r
89             }\r
90         };\r
91         desc.setHandler(handler);\r
92         desc.setMultivalued(false);\r
93         addFieldDescriptor(desc);\r
94         \r
95         //-- validation code for: _id\r
96         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
97         { //-- local scope\r
98             org.exolab.castor.xml.validators.IdValidator typeValidator;\r
99             typeValidator = new org.exolab.castor.xml.validators.IdValidator();\r
100             fieldValidator.setValidator(typeValidator);\r
101         }\r
102         desc.setValidator(fieldValidator);\r
103         //-- _dictionary\r
104         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.String.class, "_dictionary", "dictionary", org.exolab.castor.xml.NodeType.Attribute);\r
105         desc.setImmutable(true);\r
106         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
107             public java.lang.Object getValue( java.lang.Object object ) \r
108                 throws IllegalStateException\r
109             {\r
110                 Sequence target = (Sequence) object;\r
111                 return target.getDictionary();\r
112             }\r
113             public void setValue( java.lang.Object object, java.lang.Object value) \r
114                 throws IllegalStateException, IllegalArgumentException\r
115             {\r
116                 try {\r
117                     Sequence target = (Sequence) object;\r
118                     target.setDictionary( (java.lang.String) value);\r
119                 } catch (java.lang.Exception ex) {\r
120                     throw new IllegalStateException(ex.toString());\r
121                 }\r
122             }\r
123             public java.lang.Object newInstance(java.lang.Object parent) {\r
124                 return null;\r
125             }\r
126         };\r
127         desc.setHandler(handler);\r
128         desc.setRequired(true);\r
129         desc.setMultivalued(false);\r
130         addFieldDescriptor(desc);\r
131         \r
132         //-- validation code for: _dictionary\r
133         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
134         fieldValidator.setMinOccurs(1);\r
135         { //-- local scope\r
136             org.exolab.castor.xml.validators.StringValidator typeValidator;\r
137             typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
138             fieldValidator.setValidator(typeValidator);\r
139             typeValidator.setWhiteSpace("preserve");\r
140         }\r
141         desc.setValidator(fieldValidator);\r
142         //-- initialize element descriptors\r
143         \r
144         //-- _dbRefList\r
145         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.DbRef.class, "_dbRefList", "dbRef", org.exolab.castor.xml.NodeType.Element);\r
146         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
147             public java.lang.Object getValue( java.lang.Object object ) \r
148                 throws IllegalStateException\r
149             {\r
150                 Sequence target = (Sequence) object;\r
151                 return target.getDbRef();\r
152             }\r
153             public void setValue( java.lang.Object object, java.lang.Object value) \r
154                 throws IllegalStateException, IllegalArgumentException\r
155             {\r
156                 try {\r
157                     Sequence target = (Sequence) object;\r
158                     target.addDbRef( (uk.ac.vamsas.objects.core.DbRef) value);\r
159                 } catch (java.lang.Exception ex) {\r
160                     throw new IllegalStateException(ex.toString());\r
161                 }\r
162             }\r
163             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
164                 try {\r
165                     Sequence target = (Sequence) object;\r
166                     target.removeAllDbRef();\r
167                 } catch (java.lang.Exception ex) {\r
168                     throw new IllegalStateException(ex.toString());\r
169                 }\r
170             }\r
171             public java.lang.Object newInstance(java.lang.Object parent) {\r
172                 return new uk.ac.vamsas.objects.core.DbRef();\r
173             }\r
174         };\r
175         desc.setHandler(handler);\r
176         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
177         desc.setMultivalued(true);\r
178         addFieldDescriptor(desc);\r
179         \r
180         //-- validation code for: _dbRefList\r
181         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
182         fieldValidator.setMinOccurs(0);\r
183         { //-- local scope\r
184         }\r
185         desc.setValidator(fieldValidator);\r
186         //-- _vxrefList\r
187         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.Vxref.class, "_vxrefList", "vxref", org.exolab.castor.xml.NodeType.Element);\r
188         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
189             public java.lang.Object getValue( java.lang.Object object ) \r
190                 throws IllegalStateException\r
191             {\r
192                 Sequence target = (Sequence) object;\r
193                 return target.getVxref();\r
194             }\r
195             public void setValue( java.lang.Object object, java.lang.Object value) \r
196                 throws IllegalStateException, IllegalArgumentException\r
197             {\r
198                 try {\r
199                     Sequence target = (Sequence) object;\r
200                     target.addVxref( (uk.ac.vamsas.objects.core.Vxref) value);\r
201                 } catch (java.lang.Exception ex) {\r
202                     throw new IllegalStateException(ex.toString());\r
203                 }\r
204             }\r
205             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
206                 try {\r
207                     Sequence target = (Sequence) object;\r
208                     target.removeAllVxref();\r
209                 } catch (java.lang.Exception ex) {\r
210                     throw new IllegalStateException(ex.toString());\r
211                 }\r
212             }\r
213             public java.lang.Object newInstance(java.lang.Object parent) {\r
214                 return new uk.ac.vamsas.objects.core.Vxref();\r
215             }\r
216         };\r
217         desc.setHandler(handler);\r
218         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
219         desc.setMultivalued(true);\r
220         addFieldDescriptor(desc);\r
221         \r
222         //-- validation code for: _vxrefList\r
223         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
224         fieldValidator.setMinOccurs(0);\r
225         { //-- local scope\r
226         }\r
227         desc.setValidator(fieldValidator);\r
228     }\r
229 \r
230 \r
231       //-----------/\r
232      //- Methods -/\r
233     //-----------/\r
234 \r
235     /**\r
236      * Method getAccessMode.\r
237      * \r
238      * @return the access mode specified for this class.\r
239      */\r
240     public org.exolab.castor.mapping.AccessMode getAccessMode(\r
241     ) {\r
242         return null;\r
243     }\r
244 \r
245     /**\r
246      * Method getIdentity.\r
247      * \r
248      * @return the identity field, null if this class has no\r
249      * identity.\r
250      */\r
251     public org.exolab.castor.mapping.FieldDescriptor getIdentity(\r
252     ) {\r
253         return super.getIdentity();\r
254     }\r
255 \r
256     /**\r
257      * Method getJavaClass.\r
258      * \r
259      * @return the Java class represented by this descriptor.\r
260      */\r
261     public java.lang.Class getJavaClass(\r
262     ) {\r
263         return uk.ac.vamsas.objects.core.Sequence.class;\r
264     }\r
265 \r
266     /**\r
267      * Method getNameSpacePrefix.\r
268      * \r
269      * @return the namespace prefix to use when marshaling as XML.\r
270      */\r
271     public java.lang.String getNameSpacePrefix(\r
272     ) {\r
273         return _nsPrefix;\r
274     }\r
275 \r
276     /**\r
277      * Method getNameSpaceURI.\r
278      * \r
279      * @return the namespace URI used when marshaling and\r
280      * unmarshaling as XML.\r
281      */\r
282     public java.lang.String getNameSpaceURI(\r
283     ) {\r
284         return _nsURI;\r
285     }\r
286 \r
287     /**\r
288      * Method getValidator.\r
289      * \r
290      * @return a specific validator for the class described by this\r
291      * ClassDescriptor.\r
292      */\r
293     public org.exolab.castor.xml.TypeValidator getValidator(\r
294     ) {\r
295         return this;\r
296     }\r
297 \r
298     /**\r
299      * Method getXMLName.\r
300      * \r
301      * @return the XML Name for the Class being described.\r
302      */\r
303     public java.lang.String getXMLName(\r
304     ) {\r
305         return _xmlName;\r
306     }\r
307 \r
308     /**\r
309      * Method isElementDefinition.\r
310      * \r
311      * @return true if XML schema definition of this Class is that\r
312      * of a global\r
313      * element or element with anonymous type definition.\r
314      */\r
315     public boolean isElementDefinition(\r
316     ) {\r
317         return _elementDefinition;\r
318     }\r
319 \r
320 }\r