2cf4e0153dd11972e483597472d8bc6302c25414
[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      * Field _identity.\r
50      */\r
51     private org.exolab.castor.xml.XMLFieldDescriptor _identity;\r
52 \r
53 \r
54       //----------------/\r
55      //- Constructors -/\r
56     //----------------/\r
57 \r
58     public SequenceDescriptor() {\r
59         super();\r
60         setExtendsWithoutFlatten(new uk.ac.vamsas.objects.core.descriptors.SequenceTypeDescriptor());\r
61         _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
62         _xmlName = "Sequence";\r
63         _elementDefinition = true;\r
64         \r
65         //-- set grouping compositor\r
66         setCompositorAsSequence();\r
67         org.exolab.castor.xml.util.XMLFieldDescriptorImpl  desc           = null;\r
68         org.exolab.castor.mapping.FieldHandler             handler        = null;\r
69         org.exolab.castor.xml.FieldValidator               fieldValidator = null;\r
70         //-- initialize attribute descriptors\r
71         \r
72         //-- _id\r
73         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.String.class, "_id", "id", org.exolab.castor.xml.NodeType.Attribute);\r
74         this._identity = desc;\r
75         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
76             public java.lang.Object getValue( java.lang.Object object ) \r
77                 throws IllegalStateException\r
78             {\r
79                 Sequence target = (Sequence) object;\r
80                 return target.getId();\r
81             }\r
82             public void setValue( java.lang.Object object, java.lang.Object value) \r
83                 throws IllegalStateException, IllegalArgumentException\r
84             {\r
85                 try {\r
86                     Sequence target = (Sequence) object;\r
87                     target.setId( (java.lang.String) value);\r
88                 } catch (java.lang.Exception ex) {\r
89                     throw new IllegalStateException(ex.toString());\r
90                 }\r
91             }\r
92             public java.lang.Object newInstance(java.lang.Object parent) {\r
93                 return new java.lang.String();\r
94             }\r
95         };\r
96         desc.setHandler(handler);\r
97         desc.setMultivalued(false);\r
98         addFieldDescriptor(desc);\r
99         \r
100         //-- validation code for: _id\r
101         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
102         { //-- local scope\r
103             org.exolab.castor.xml.validators.IdValidator typeValidator;\r
104             typeValidator = new org.exolab.castor.xml.validators.IdValidator();\r
105             fieldValidator.setValidator(typeValidator);\r
106         }\r
107         desc.setValidator(fieldValidator);\r
108         //-- _dictionary\r
109         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.String.class, "_dictionary", "dictionary", org.exolab.castor.xml.NodeType.Attribute);\r
110         desc.setImmutable(true);\r
111         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
112             public java.lang.Object getValue( java.lang.Object object ) \r
113                 throws IllegalStateException\r
114             {\r
115                 Sequence target = (Sequence) object;\r
116                 return target.getDictionary();\r
117             }\r
118             public void setValue( java.lang.Object object, java.lang.Object value) \r
119                 throws IllegalStateException, IllegalArgumentException\r
120             {\r
121                 try {\r
122                     Sequence target = (Sequence) object;\r
123                     target.setDictionary( (java.lang.String) value);\r
124                 } catch (java.lang.Exception ex) {\r
125                     throw new IllegalStateException(ex.toString());\r
126                 }\r
127             }\r
128             public java.lang.Object newInstance(java.lang.Object parent) {\r
129                 return null;\r
130             }\r
131         };\r
132         desc.setHandler(handler);\r
133         desc.setRequired(true);\r
134         desc.setMultivalued(false);\r
135         addFieldDescriptor(desc);\r
136         \r
137         //-- validation code for: _dictionary\r
138         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
139         fieldValidator.setMinOccurs(1);\r
140         { //-- local scope\r
141             org.exolab.castor.xml.validators.StringValidator typeValidator;\r
142             typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
143             fieldValidator.setValidator(typeValidator);\r
144             typeValidator.setWhiteSpace("preserve");\r
145         }\r
146         desc.setValidator(fieldValidator);\r
147         //-- initialize element descriptors\r
148         \r
149         //-- _dbRefList\r
150         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.DbRef.class, "_dbRefList", "dbRef", org.exolab.castor.xml.NodeType.Element);\r
151         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
152             public java.lang.Object getValue( java.lang.Object object ) \r
153                 throws IllegalStateException\r
154             {\r
155                 Sequence target = (Sequence) object;\r
156                 return target.getDbRef();\r
157             }\r
158             public void setValue( java.lang.Object object, java.lang.Object value) \r
159                 throws IllegalStateException, IllegalArgumentException\r
160             {\r
161                 try {\r
162                     Sequence target = (Sequence) object;\r
163                     target.addDbRef( (uk.ac.vamsas.objects.core.DbRef) value);\r
164                 } catch (java.lang.Exception ex) {\r
165                     throw new IllegalStateException(ex.toString());\r
166                 }\r
167             }\r
168             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
169                 try {\r
170                     Sequence target = (Sequence) object;\r
171                     target.removeAllDbRef();\r
172                 } catch (java.lang.Exception ex) {\r
173                     throw new IllegalStateException(ex.toString());\r
174                 }\r
175             }\r
176             public java.lang.Object newInstance(java.lang.Object parent) {\r
177                 return new uk.ac.vamsas.objects.core.DbRef();\r
178             }\r
179         };\r
180         desc.setHandler(handler);\r
181         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
182         desc.setMultivalued(true);\r
183         addFieldDescriptor(desc);\r
184         \r
185         //-- validation code for: _dbRefList\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       //-----------/\r
195      //- Methods -/\r
196     //-----------/\r
197 \r
198     /**\r
199      * Method getAccessMode.\r
200      * \r
201      * @return the access mode specified for this class.\r
202      */\r
203     public org.exolab.castor.mapping.AccessMode getAccessMode(\r
204     ) {\r
205         return null;\r
206     }\r
207 \r
208     /**\r
209      * Method getIdentity.\r
210      * \r
211      * @return the identity field, null if this class has no\r
212      * identity.\r
213      */\r
214     public org.exolab.castor.mapping.FieldDescriptor getIdentity(\r
215     ) {\r
216         if (_identity == null) {\r
217             return super.getIdentity();\r
218         }\r
219         return _identity;\r
220     }\r
221 \r
222     /**\r
223      * Method getJavaClass.\r
224      * \r
225      * @return the Java class represented by this descriptor.\r
226      */\r
227     public java.lang.Class getJavaClass(\r
228     ) {\r
229         return uk.ac.vamsas.objects.core.Sequence.class;\r
230     }\r
231 \r
232     /**\r
233      * Method getNameSpacePrefix.\r
234      * \r
235      * @return the namespace prefix to use when marshaling as XML.\r
236      */\r
237     public java.lang.String getNameSpacePrefix(\r
238     ) {\r
239         return _nsPrefix;\r
240     }\r
241 \r
242     /**\r
243      * Method getNameSpaceURI.\r
244      * \r
245      * @return the namespace URI used when marshaling and\r
246      * unmarshaling as XML.\r
247      */\r
248     public java.lang.String getNameSpaceURI(\r
249     ) {\r
250         return _nsURI;\r
251     }\r
252 \r
253     /**\r
254      * Method getValidator.\r
255      * \r
256      * @return a specific validator for the class described by this\r
257      * ClassDescriptor.\r
258      */\r
259     public org.exolab.castor.xml.TypeValidator getValidator(\r
260     ) {\r
261         return this;\r
262     }\r
263 \r
264     /**\r
265      * Method getXMLName.\r
266      * \r
267      * @return the XML Name for the Class being described.\r
268      */\r
269     public java.lang.String getXMLName(\r
270     ) {\r
271         return _xmlName;\r
272     }\r
273 \r
274     /**\r
275      * Method isElementDefinition.\r
276      * \r
277      * @return true if XML schema definition of this Class is that\r
278      * of a global\r
279      * element or element with anonymous type definition.\r
280      */\r
281     public boolean isElementDefinition(\r
282     ) {\r
283         return _elementDefinition;\r
284     }\r
285 \r
286 }\r