applied LGPLv3 and source code formatting.
[vamsas.git] / src / uk / ac / vamsas / objects / core / descriptors / AppDataDescriptor.java
1 /*\r
2  * This file is part of the Vamsas Client version 0.1. \r
3  * Copyright 2009 by Jim Procter, Iain Milne, Pierre Marguerite, \r
4  *  Andrew Waterhouse and Dominik Lindner.\r
5  * \r
6  * Earlier versions have also been incorporated into Jalview version 2.4 \r
7  * since 2008, and TOPALi version 2 since 2007.\r
8  * \r
9  * The Vamsas Client is free software: you can redistribute it and/or modify\r
10  * it under the terms of the GNU Lesser General Public License as published by\r
11  * the Free Software Foundation, either version 3 of the License, or\r
12  * (at your option) any later version.\r
13  *  \r
14  * The Vamsas Client is distributed in the hope that it will be useful,\r
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
17  * GNU Lesser General Public License for more details.\r
18  * \r
19  * You should have received a copy of the GNU Lesser General Public License\r
20  * along with the Vamsas Client.  If not, see <http://www.gnu.org/licenses/>.\r
21  */\r
22 package uk.ac.vamsas.objects.core.descriptors;\r
23 \r
24 //---------------------------------/\r
25 //- Imported classes and packages -/\r
26 //---------------------------------/\r
27 \r
28 import uk.ac.vamsas.objects.core.AppData;\r
29 \r
30 /**\r
31  * Class AppDataDescriptor.\r
32  * \r
33  * @version $Revision$ $Date$\r
34  */\r
35 public class AppDataDescriptor extends\r
36     org.exolab.castor.xml.util.XMLClassDescriptorImpl {\r
37 \r
38   // --------------------------/\r
39   // - Class/Member Variables -/\r
40   // --------------------------/\r
41 \r
42   /**\r
43    * Field _elementDefinition.\r
44    */\r
45   private boolean _elementDefinition;\r
46 \r
47   /**\r
48    * Field _nsPrefix.\r
49    */\r
50   private java.lang.String _nsPrefix;\r
51 \r
52   /**\r
53    * Field _nsURI.\r
54    */\r
55   private java.lang.String _nsURI;\r
56 \r
57   /**\r
58    * Field _xmlName.\r
59    */\r
60   private java.lang.String _xmlName;\r
61 \r
62   // ----------------/\r
63   // - Constructors -/\r
64   // ----------------/\r
65 \r
66   public AppDataDescriptor() {\r
67     super();\r
68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
69     _xmlName = "appData";\r
70     _elementDefinition = false;\r
71 \r
72     // -- set grouping compositor\r
73     setCompositorAsChoice();\r
74     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;\r
75     org.exolab.castor.mapping.FieldHandler handler = null;\r
76     org.exolab.castor.xml.FieldValidator fieldValidator = null;\r
77     // -- initialize attribute descriptors\r
78 \r
79     // -- initialize element descriptors\r
80 \r
81     // -- _data\r
82     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(byte[].class,\r
83         "_data", "data", org.exolab.castor.xml.NodeType.Element);\r
84     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
85       public java.lang.Object getValue(java.lang.Object object)\r
86           throws IllegalStateException {\r
87         AppData target = (AppData) object;\r
88         return target.getData();\r
89       }\r
90 \r
91       public void setValue(java.lang.Object object, java.lang.Object value)\r
92           throws IllegalStateException, IllegalArgumentException {\r
93         try {\r
94           AppData target = (AppData) object;\r
95           target.setData((byte[]) value);\r
96         } catch (java.lang.Exception ex) {\r
97           throw new IllegalStateException(ex.toString());\r
98         }\r
99       }\r
100 \r
101       public java.lang.Object newInstance(java.lang.Object parent) {\r
102         return null;\r
103       }\r
104     };\r
105     desc.setHandler(handler);\r
106     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
107     desc.setRequired(true);\r
108     desc.setMultivalued(false);\r
109     addFieldDescriptor(desc);\r
110 \r
111     // -- validation code for: _data\r
112     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
113     fieldValidator.setMinOccurs(1);\r
114     { // -- local scope\r
115     }\r
116     desc.setValidator(fieldValidator);\r
117     // -- _dataReference\r
118     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
119         java.lang.String.class, "_dataReference", "dataReference",\r
120         org.exolab.castor.xml.NodeType.Element);\r
121     desc.setImmutable(true);\r
122     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
123       public java.lang.Object getValue(java.lang.Object object)\r
124           throws IllegalStateException {\r
125         AppData target = (AppData) object;\r
126         return target.getDataReference();\r
127       }\r
128 \r
129       public void setValue(java.lang.Object object, java.lang.Object value)\r
130           throws IllegalStateException, IllegalArgumentException {\r
131         try {\r
132           AppData target = (AppData) object;\r
133           target.setDataReference((java.lang.String) value);\r
134         } catch (java.lang.Exception ex) {\r
135           throw new IllegalStateException(ex.toString());\r
136         }\r
137       }\r
138 \r
139       public java.lang.Object newInstance(java.lang.Object parent) {\r
140         return null;\r
141       }\r
142     };\r
143     desc.setHandler(handler);\r
144     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
145     desc.setRequired(true);\r
146     desc.setMultivalued(false);\r
147     addFieldDescriptor(desc);\r
148 \r
149     // -- validation code for: _dataReference\r
150     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
151     fieldValidator.setMinOccurs(1);\r
152     { // -- local scope\r
153       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
154       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
155       fieldValidator.setValidator(typeValidator);\r
156       typeValidator.setWhiteSpace("preserve");\r
157     }\r
158     desc.setValidator(fieldValidator);\r
159   }\r
160 \r
161   // -----------/\r
162   // - Methods -/\r
163   // -----------/\r
164 \r
165   /**\r
166    * Method getAccessMode.\r
167    * \r
168    * @return the access mode specified for this class.\r
169    */\r
170   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
171     return null;\r
172   }\r
173 \r
174   /**\r
175    * Method getIdentity.\r
176    * \r
177    * @return the identity field, null if this class has no identity.\r
178    */\r
179   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
180     return super.getIdentity();\r
181   }\r
182 \r
183   /**\r
184    * Method getJavaClass.\r
185    * \r
186    * @return the Java class represented by this descriptor.\r
187    */\r
188   public java.lang.Class getJavaClass() {\r
189     return uk.ac.vamsas.objects.core.AppData.class;\r
190   }\r
191 \r
192   /**\r
193    * Method getNameSpacePrefix.\r
194    * \r
195    * @return the namespace prefix to use when marshaling as XML.\r
196    */\r
197   public java.lang.String getNameSpacePrefix() {\r
198     return _nsPrefix;\r
199   }\r
200 \r
201   /**\r
202    * Method getNameSpaceURI.\r
203    * \r
204    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
205    */\r
206   public java.lang.String getNameSpaceURI() {\r
207     return _nsURI;\r
208   }\r
209 \r
210   /**\r
211    * Method getValidator.\r
212    * \r
213    * @return a specific validator for the class described by this\r
214    *         ClassDescriptor.\r
215    */\r
216   public org.exolab.castor.xml.TypeValidator getValidator() {\r
217     return this;\r
218   }\r
219 \r
220   /**\r
221    * Method getXMLName.\r
222    * \r
223    * @return the XML Name for the Class being described.\r
224    */\r
225   public java.lang.String getXMLName() {\r
226     return _xmlName;\r
227   }\r
228 \r
229   /**\r
230    * Method isElementDefinition.\r
231    * \r
232    * @return true if XML schema definition of this Class is that of a global\r
233    *         element or element with anonymous type definition.\r
234    */\r
235   public boolean isElementDefinition() {\r
236     return _elementDefinition;\r
237   }\r
238 \r
239 }\r