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
6 * Earlier versions have also been incorporated into Jalview version 2.4
\r
7 * since 2008, and TOPALi version 2 since 2007.
\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
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
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
22 package uk.ac.vamsas.objects.core.descriptors;
\r
24 //---------------------------------/
\r
25 //- Imported classes and packages -/
\r
26 //---------------------------------/
\r
28 import uk.ac.vamsas.objects.core.VamsasDocument;
\r
31 * Class VamsasDocumentDescriptor.
\r
33 * @version $Revision$ $Date$
\r
35 public class VamsasDocumentDescriptor extends
\r
36 org.exolab.castor.xml.util.XMLClassDescriptorImpl {
\r
38 // --------------------------/
\r
39 // - Class/Member Variables -/
\r
40 // --------------------------/
\r
43 * Field _elementDefinition.
\r
45 private boolean _elementDefinition;
\r
50 private java.lang.String _nsPrefix;
\r
55 private java.lang.String _nsURI;
\r
60 private java.lang.String _xmlName;
\r
62 // ----------------/
\r
63 // - Constructors -/
\r
64 // ----------------/
\r
66 public VamsasDocumentDescriptor() {
\r
68 _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasDocument";
\r
69 _xmlName = "VamsasDocument";
\r
70 _elementDefinition = true;
\r
72 // -- set grouping compositor
\r
73 setCompositorAsSequence();
\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
79 // -- initialize element descriptors
\r
82 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
\r
83 java.lang.String.class, "_version", "Version",
\r
84 org.exolab.castor.xml.NodeType.Element);
\r
85 desc.setImmutable(true);
\r
86 handler = new org.exolab.castor.xml.XMLFieldHandler() {
\r
87 public java.lang.Object getValue(java.lang.Object object)
\r
88 throws IllegalStateException {
\r
89 VamsasDocument target = (VamsasDocument) object;
\r
90 return target.getVersion();
\r
93 public void setValue(java.lang.Object object, java.lang.Object value)
\r
94 throws IllegalStateException, IllegalArgumentException {
\r
96 VamsasDocument target = (VamsasDocument) object;
\r
97 target.setVersion((java.lang.String) value);
\r
98 } catch (java.lang.Exception ex) {
\r
99 throw new IllegalStateException(ex.toString());
\r
103 public java.lang.Object newInstance(java.lang.Object parent) {
\r
107 desc.setHandler(handler);
\r
108 desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasDocument");
\r
109 desc.setRequired(true);
\r
110 desc.setMultivalued(false);
\r
111 addFieldDescriptor(desc);
\r
113 // -- validation code for: _version
\r
114 fieldValidator = new org.exolab.castor.xml.FieldValidator();
\r
115 fieldValidator.setMinOccurs(1);
\r
116 { // -- local scope
\r
117 org.exolab.castor.xml.validators.StringValidator typeValidator;
\r
118 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
\r
119 fieldValidator.setValidator(typeValidator);
\r
120 typeValidator.setWhiteSpace("preserve");
\r
122 desc.setValidator(fieldValidator);
\r
124 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
\r
125 uk.ac.vamsas.objects.core.LockFile.class, "_lockFile", "LockFile",
\r
126 org.exolab.castor.xml.NodeType.Element);
\r
127 handler = new org.exolab.castor.xml.XMLFieldHandler() {
\r
128 public java.lang.Object getValue(java.lang.Object object)
\r
129 throws IllegalStateException {
\r
130 VamsasDocument target = (VamsasDocument) object;
\r
131 return target.getLockFile();
\r
134 public void setValue(java.lang.Object object, java.lang.Object value)
\r
135 throws IllegalStateException, IllegalArgumentException {
\r
137 VamsasDocument target = (VamsasDocument) object;
\r
138 target.setLockFile((uk.ac.vamsas.objects.core.LockFile) value);
\r
139 } catch (java.lang.Exception ex) {
\r
140 throw new IllegalStateException(ex.toString());
\r
144 public java.lang.Object newInstance(java.lang.Object parent) {
\r
145 return new uk.ac.vamsas.objects.core.LockFile();
\r
148 desc.setHandler(handler);
\r
149 desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasDocument");
\r
150 desc.setMultivalued(false);
\r
151 addFieldDescriptor(desc);
\r
153 // -- validation code for: _lockFile
\r
154 fieldValidator = new org.exolab.castor.xml.FieldValidator();
\r
155 { // -- local scope
\r
157 desc.setValidator(fieldValidator);
\r
159 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
\r
160 uk.ac.vamsas.objects.core.Provenance.class, "_provenance",
\r
161 "Provenance", org.exolab.castor.xml.NodeType.Element);
\r
162 handler = new org.exolab.castor.xml.XMLFieldHandler() {
\r
163 public java.lang.Object getValue(java.lang.Object object)
\r
164 throws IllegalStateException {
\r
165 VamsasDocument target = (VamsasDocument) object;
\r
166 return target.getProvenance();
\r
169 public void setValue(java.lang.Object object, java.lang.Object value)
\r
170 throws IllegalStateException, IllegalArgumentException {
\r
172 VamsasDocument target = (VamsasDocument) object;
\r
173 target.setProvenance((uk.ac.vamsas.objects.core.Provenance) value);
\r
174 } catch (java.lang.Exception ex) {
\r
175 throw new IllegalStateException(ex.toString());
\r
179 public java.lang.Object newInstance(java.lang.Object parent) {
\r
180 return new uk.ac.vamsas.objects.core.Provenance();
\r
183 desc.setHandler(handler);
\r
184 desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");
\r
185 desc.setMultivalued(false);
\r
186 addFieldDescriptor(desc);
\r
188 // -- validation code for: _provenance
\r
189 fieldValidator = new org.exolab.castor.xml.FieldValidator();
\r
190 { // -- local scope
\r
192 desc.setValidator(fieldValidator);
\r
194 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
\r
195 uk.ac.vamsas.objects.core.VAMSAS.class, "_VAMSASList", "VAMSAS",
\r
196 org.exolab.castor.xml.NodeType.Element);
\r
197 handler = new org.exolab.castor.xml.XMLFieldHandler() {
\r
198 public java.lang.Object getValue(java.lang.Object object)
\r
199 throws IllegalStateException {
\r
200 VamsasDocument target = (VamsasDocument) object;
\r
201 return target.getVAMSAS();
\r
204 public void setValue(java.lang.Object object, java.lang.Object value)
\r
205 throws IllegalStateException, IllegalArgumentException {
\r
207 VamsasDocument target = (VamsasDocument) object;
\r
208 target.addVAMSAS((uk.ac.vamsas.objects.core.VAMSAS) value);
\r
209 } catch (java.lang.Exception ex) {
\r
210 throw new IllegalStateException(ex.toString());
\r
214 public void resetValue(Object object) throws IllegalStateException,
\r
215 IllegalArgumentException {
\r
217 VamsasDocument target = (VamsasDocument) object;
\r
218 target.removeAllVAMSAS();
\r
219 } catch (java.lang.Exception ex) {
\r
220 throw new IllegalStateException(ex.toString());
\r
224 public java.lang.Object newInstance(java.lang.Object parent) {
\r
225 return new uk.ac.vamsas.objects.core.VAMSAS();
\r
228 desc.setHandler(handler);
\r
229 desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");
\r
230 desc.setRequired(true);
\r
231 desc.setMultivalued(true);
\r
232 addFieldDescriptor(desc);
\r
234 // -- validation code for: _VAMSASList
\r
235 fieldValidator = new org.exolab.castor.xml.FieldValidator();
\r
236 fieldValidator.setMinOccurs(1);
\r
237 { // -- local scope
\r
239 desc.setValidator(fieldValidator);
\r
240 // -- _applicationDataList
\r
241 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
\r
242 uk.ac.vamsas.objects.core.ApplicationData.class,
\r
243 "_applicationDataList", "ApplicationData",
\r
244 org.exolab.castor.xml.NodeType.Element);
\r
245 handler = new org.exolab.castor.xml.XMLFieldHandler() {
\r
246 public java.lang.Object getValue(java.lang.Object object)
\r
247 throws IllegalStateException {
\r
248 VamsasDocument target = (VamsasDocument) object;
\r
249 return target.getApplicationData();
\r
252 public void setValue(java.lang.Object object, java.lang.Object value)
\r
253 throws IllegalStateException, IllegalArgumentException {
\r
255 VamsasDocument target = (VamsasDocument) object;
\r
257 .addApplicationData((uk.ac.vamsas.objects.core.ApplicationData) value);
\r
258 } catch (java.lang.Exception ex) {
\r
259 throw new IllegalStateException(ex.toString());
\r
263 public void resetValue(Object object) throws IllegalStateException,
\r
264 IllegalArgumentException {
\r
266 VamsasDocument target = (VamsasDocument) object;
\r
267 target.removeAllApplicationData();
\r
268 } catch (java.lang.Exception ex) {
\r
269 throw new IllegalStateException(ex.toString());
\r
273 public java.lang.Object newInstance(java.lang.Object parent) {
\r
274 return new uk.ac.vamsas.objects.core.ApplicationData();
\r
277 desc.setHandler(handler);
\r
278 desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");
\r
279 desc.setMultivalued(true);
\r
280 addFieldDescriptor(desc);
\r
282 // -- validation code for: _applicationDataList
\r
283 fieldValidator = new org.exolab.castor.xml.FieldValidator();
\r
284 fieldValidator.setMinOccurs(0);
\r
285 { // -- local scope
\r
287 desc.setValidator(fieldValidator);
\r
288 // -- _attachmentList
\r
289 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
\r
290 uk.ac.vamsas.objects.core.Attachment.class, "_attachmentList",
\r
291 "Attachment", org.exolab.castor.xml.NodeType.Element);
\r
292 handler = new org.exolab.castor.xml.XMLFieldHandler() {
\r
293 public java.lang.Object getValue(java.lang.Object object)
\r
294 throws IllegalStateException {
\r
295 VamsasDocument target = (VamsasDocument) object;
\r
296 return target.getAttachment();
\r
299 public void setValue(java.lang.Object object, java.lang.Object value)
\r
300 throws IllegalStateException, IllegalArgumentException {
\r
302 VamsasDocument target = (VamsasDocument) object;
\r
303 target.addAttachment((uk.ac.vamsas.objects.core.Attachment) value);
\r
304 } catch (java.lang.Exception ex) {
\r
305 throw new IllegalStateException(ex.toString());
\r
309 public void resetValue(Object object) throws IllegalStateException,
\r
310 IllegalArgumentException {
\r
312 VamsasDocument target = (VamsasDocument) object;
\r
313 target.removeAllAttachment();
\r
314 } catch (java.lang.Exception ex) {
\r
315 throw new IllegalStateException(ex.toString());
\r
319 public java.lang.Object newInstance(java.lang.Object parent) {
\r
320 return new uk.ac.vamsas.objects.core.Attachment();
\r
323 desc.setHandler(handler);
\r
324 desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");
\r
325 desc.setMultivalued(true);
\r
326 addFieldDescriptor(desc);
\r
328 // -- validation code for: _attachmentList
\r
329 fieldValidator = new org.exolab.castor.xml.FieldValidator();
\r
330 fieldValidator.setMinOccurs(0);
\r
331 { // -- local scope
\r
333 desc.setValidator(fieldValidator);
\r
341 * Method getAccessMode.
\r
343 * @return the access mode specified for this class.
\r
345 public org.exolab.castor.mapping.AccessMode getAccessMode() {
\r
350 * Method getIdentity.
\r
352 * @return the identity field, null if this class has no identity.
\r
354 public org.exolab.castor.mapping.FieldDescriptor getIdentity() {
\r
355 return super.getIdentity();
\r
359 * Method getJavaClass.
\r
361 * @return the Java class represented by this descriptor.
\r
363 public java.lang.Class getJavaClass() {
\r
364 return uk.ac.vamsas.objects.core.VamsasDocument.class;
\r
368 * Method getNameSpacePrefix.
\r
370 * @return the namespace prefix to use when marshaling as XML.
\r
372 public java.lang.String getNameSpacePrefix() {
\r
377 * Method getNameSpaceURI.
\r
379 * @return the namespace URI used when marshaling and unmarshaling as XML.
\r
381 public java.lang.String getNameSpaceURI() {
\r
386 * Method getValidator.
\r
388 * @return a specific validator for the class described by this
\r
391 public org.exolab.castor.xml.TypeValidator getValidator() {
\r
396 * Method getXMLName.
\r
398 * @return the XML Name for the Class being described.
\r
400 public java.lang.String getXMLName() {
\r
405 * Method isElementDefinition.
\r
407 * @return true if XML schema definition of this Class is that of a global
\r
408 * element or element with anonymous type definition.
\r
410 public boolean isElementDefinition() {
\r
411 return _elementDefinition;
\r