2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
3 * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
5 * This file is part of Jalview.
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.
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.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
18 package jalview.schemabinding.version2.descriptors;
20 //---------------------------------/
21 //- Imported classes and packages -/
22 //---------------------------------/
24 import jalview.schemabinding.version2.JalviewModelSequence;
27 * Class JalviewModelSequenceDescriptor.
29 * @version $Revision$ $Date$
31 public class JalviewModelSequenceDescriptor extends
32 org.exolab.castor.xml.util.XMLClassDescriptorImpl
35 // --------------------------/
36 // - Class/Member Variables -/
37 // --------------------------/
40 * Field _elementDefinition.
42 private boolean _elementDefinition;
47 private java.lang.String _nsPrefix;
52 private java.lang.String _nsURI;
57 private java.lang.String _xmlName;
63 public JalviewModelSequenceDescriptor()
66 _nsURI = "www.jalview.org";
67 _elementDefinition = false;
69 // -- set grouping compositor
70 setCompositorAsSequence();
71 org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
72 org.exolab.castor.mapping.FieldHandler handler = null;
73 org.exolab.castor.xml.FieldValidator fieldValidator = null;
74 // -- initialize attribute descriptors
76 // -- initialize element descriptors
79 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
80 jalview.schemabinding.version2.JSeq.class, "_JSeqList", "JSeq",
81 org.exolab.castor.xml.NodeType.Element);
82 handler = new org.exolab.castor.xml.XMLFieldHandler()
84 public java.lang.Object getValue(java.lang.Object object)
85 throws IllegalStateException
87 JalviewModelSequence target = (JalviewModelSequence) object;
88 return target.getJSeq();
91 public void setValue(java.lang.Object object, java.lang.Object value)
92 throws IllegalStateException, IllegalArgumentException
96 JalviewModelSequence target = (JalviewModelSequence) object;
97 target.addJSeq((jalview.schemabinding.version2.JSeq) value);
98 } catch (java.lang.Exception ex)
100 throw new IllegalStateException(ex.toString());
104 public void resetValue(Object object) throws IllegalStateException,
105 IllegalArgumentException
109 JalviewModelSequence target = (JalviewModelSequence) object;
110 target.removeAllJSeq();
111 } catch (java.lang.Exception ex)
113 throw new IllegalStateException(ex.toString());
117 public java.lang.Object newInstance(java.lang.Object parent)
119 return new jalview.schemabinding.version2.JSeq();
122 desc.setHandler(handler);
123 desc.setNameSpaceURI("www.jalview.org");
124 desc.setRequired(true);
125 desc.setMultivalued(true);
126 addFieldDescriptor(desc);
128 // -- validation code for: _JSeqList
129 fieldValidator = new org.exolab.castor.xml.FieldValidator();
130 fieldValidator.setMinOccurs(1);
133 desc.setValidator(fieldValidator);
135 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
136 jalview.schemabinding.version2.JGroup.class, "_JGroupList",
137 "JGroup", org.exolab.castor.xml.NodeType.Element);
138 handler = new org.exolab.castor.xml.XMLFieldHandler()
140 public java.lang.Object getValue(java.lang.Object object)
141 throws IllegalStateException
143 JalviewModelSequence target = (JalviewModelSequence) object;
144 return target.getJGroup();
147 public void setValue(java.lang.Object object, java.lang.Object value)
148 throws IllegalStateException, IllegalArgumentException
152 JalviewModelSequence target = (JalviewModelSequence) object;
153 target.addJGroup((jalview.schemabinding.version2.JGroup) value);
154 } catch (java.lang.Exception ex)
156 throw new IllegalStateException(ex.toString());
160 public void resetValue(Object object) throws IllegalStateException,
161 IllegalArgumentException
165 JalviewModelSequence target = (JalviewModelSequence) object;
166 target.removeAllJGroup();
167 } catch (java.lang.Exception ex)
169 throw new IllegalStateException(ex.toString());
173 public java.lang.Object newInstance(java.lang.Object parent)
175 return new jalview.schemabinding.version2.JGroup();
178 desc.setHandler(handler);
179 desc.setNameSpaceURI("www.jalview.org");
180 desc.setMultivalued(true);
181 addFieldDescriptor(desc);
183 // -- validation code for: _JGroupList
184 fieldValidator = new org.exolab.castor.xml.FieldValidator();
185 fieldValidator.setMinOccurs(0);
188 desc.setValidator(fieldValidator);
190 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
191 jalview.schemabinding.version2.Viewport.class, "_viewportList",
192 "Viewport", org.exolab.castor.xml.NodeType.Element);
193 handler = new org.exolab.castor.xml.XMLFieldHandler()
195 public java.lang.Object getValue(java.lang.Object object)
196 throws IllegalStateException
198 JalviewModelSequence target = (JalviewModelSequence) object;
199 return target.getViewport();
202 public void setValue(java.lang.Object object, java.lang.Object value)
203 throws IllegalStateException, IllegalArgumentException
207 JalviewModelSequence target = (JalviewModelSequence) object;
208 target.addViewport((jalview.schemabinding.version2.Viewport) value);
209 } catch (java.lang.Exception ex)
211 throw new IllegalStateException(ex.toString());
215 public void resetValue(Object object) throws IllegalStateException,
216 IllegalArgumentException
220 JalviewModelSequence target = (JalviewModelSequence) object;
221 target.removeAllViewport();
222 } catch (java.lang.Exception ex)
224 throw new IllegalStateException(ex.toString());
228 public java.lang.Object newInstance(java.lang.Object parent)
230 return new jalview.schemabinding.version2.Viewport();
233 desc.setHandler(handler);
234 desc.setNameSpaceURI("www.jalview.org");
235 desc.setRequired(true);
236 desc.setMultivalued(true);
237 addFieldDescriptor(desc);
239 // -- validation code for: _viewportList
240 fieldValidator = new org.exolab.castor.xml.FieldValidator();
241 fieldValidator.setMinOccurs(1);
244 desc.setValidator(fieldValidator);
245 // -- _userColoursList
246 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
247 jalview.schemabinding.version2.UserColours.class,
248 "_userColoursList", "UserColours",
249 org.exolab.castor.xml.NodeType.Element);
250 handler = new org.exolab.castor.xml.XMLFieldHandler()
252 public java.lang.Object getValue(java.lang.Object object)
253 throws IllegalStateException
255 JalviewModelSequence target = (JalviewModelSequence) object;
256 return target.getUserColours();
259 public void setValue(java.lang.Object object, java.lang.Object value)
260 throws IllegalStateException, IllegalArgumentException
264 JalviewModelSequence target = (JalviewModelSequence) object;
265 target.addUserColours((jalview.schemabinding.version2.UserColours) value);
266 } catch (java.lang.Exception ex)
268 throw new IllegalStateException(ex.toString());
272 public void resetValue(Object object) throws IllegalStateException,
273 IllegalArgumentException
277 JalviewModelSequence target = (JalviewModelSequence) object;
278 target.removeAllUserColours();
279 } catch (java.lang.Exception ex)
281 throw new IllegalStateException(ex.toString());
285 public java.lang.Object newInstance(java.lang.Object parent)
287 return new jalview.schemabinding.version2.UserColours();
290 desc.setHandler(handler);
291 desc.setNameSpaceURI("www.jalview.org");
292 desc.setMultivalued(true);
293 addFieldDescriptor(desc);
295 // -- validation code for: _userColoursList
296 fieldValidator = new org.exolab.castor.xml.FieldValidator();
297 fieldValidator.setMinOccurs(0);
300 desc.setValidator(fieldValidator);
302 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
303 jalview.schemabinding.version2.Tree.class, "_treeList", "tree",
304 org.exolab.castor.xml.NodeType.Element);
305 handler = new org.exolab.castor.xml.XMLFieldHandler()
307 public java.lang.Object getValue(java.lang.Object object)
308 throws IllegalStateException
310 JalviewModelSequence target = (JalviewModelSequence) object;
311 return target.getTree();
314 public void setValue(java.lang.Object object, java.lang.Object value)
315 throws IllegalStateException, IllegalArgumentException
319 JalviewModelSequence target = (JalviewModelSequence) object;
320 target.addTree((jalview.schemabinding.version2.Tree) value);
321 } catch (java.lang.Exception ex)
323 throw new IllegalStateException(ex.toString());
327 public void resetValue(Object object) throws IllegalStateException,
328 IllegalArgumentException
332 JalviewModelSequence target = (JalviewModelSequence) object;
333 target.removeAllTree();
334 } catch (java.lang.Exception ex)
336 throw new IllegalStateException(ex.toString());
340 public java.lang.Object newInstance(java.lang.Object parent)
342 return new jalview.schemabinding.version2.Tree();
345 desc.setHandler(handler);
346 desc.setNameSpaceURI("www.jalview.org");
347 desc.setMultivalued(true);
348 addFieldDescriptor(desc);
350 // -- validation code for: _treeList
351 fieldValidator = new org.exolab.castor.xml.FieldValidator();
352 fieldValidator.setMinOccurs(0);
355 desc.setValidator(fieldValidator);
356 // -- _featureSettings
357 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
358 jalview.schemabinding.version2.FeatureSettings.class,
359 "_featureSettings", "FeatureSettings",
360 org.exolab.castor.xml.NodeType.Element);
361 handler = new org.exolab.castor.xml.XMLFieldHandler()
363 public java.lang.Object getValue(java.lang.Object object)
364 throws IllegalStateException
366 JalviewModelSequence target = (JalviewModelSequence) object;
367 return target.getFeatureSettings();
370 public void setValue(java.lang.Object object, java.lang.Object value)
371 throws IllegalStateException, IllegalArgumentException
375 JalviewModelSequence target = (JalviewModelSequence) object;
376 target.setFeatureSettings((jalview.schemabinding.version2.FeatureSettings) value);
377 } catch (java.lang.Exception ex)
379 throw new IllegalStateException(ex.toString());
383 public java.lang.Object newInstance(java.lang.Object parent)
385 return new jalview.schemabinding.version2.FeatureSettings();
388 desc.setHandler(handler);
389 desc.setNameSpaceURI("www.jalview.org");
390 desc.setMultivalued(false);
391 addFieldDescriptor(desc);
393 // -- validation code for: _featureSettings
394 fieldValidator = new org.exolab.castor.xml.FieldValidator();
397 desc.setValidator(fieldValidator);
405 * Method getAccessMode.
407 * @return the access mode specified for this class.
409 public org.exolab.castor.mapping.AccessMode getAccessMode()
415 * Method getIdentity.
417 * @return the identity field, null if this class has no identity.
419 public org.exolab.castor.mapping.FieldDescriptor getIdentity()
421 return super.getIdentity();
425 * Method getJavaClass.
427 * @return the Java class represented by this descriptor.
429 public java.lang.Class getJavaClass()
431 return jalview.schemabinding.version2.JalviewModelSequence.class;
435 * Method getNameSpacePrefix.
437 * @return the namespace prefix to use when marshaling as XML.
439 public java.lang.String getNameSpacePrefix()
445 * Method getNameSpaceURI.
447 * @return the namespace URI used when marshaling and unmarshaling as XML.
449 public java.lang.String getNameSpaceURI()
455 * Method getValidator.
457 * @return a specific validator for the class described by this
460 public org.exolab.castor.xml.TypeValidator getValidator()
468 * @return the XML Name for the Class being described.
470 public java.lang.String getXMLName()
476 * Method isElementDefinition.
478 * @return true if XML schema definition of this Class is that of a global
479 * element or element with anonymous type definition.
481 public boolean isElementDefinition()
483 return _elementDefinition;