2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
3 * Copyright (C) 2014 The Jalview Authors
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/>.
17 * The Jalview Authors are detailed in the 'AUTHORS' file.
19 package jalview.schemabinding.version2.descriptors;
21 //---------------------------------/
22 //- Imported classes and packages -/
23 //---------------------------------/
25 import jalview.schemabinding.version2.JalviewModelSequence;
28 * Class JalviewModelSequenceDescriptor.
30 * @version $Revision$ $Date$
32 public class JalviewModelSequenceDescriptor extends
33 org.exolab.castor.xml.util.XMLClassDescriptorImpl
36 // --------------------------/
37 // - Class/Member Variables -/
38 // --------------------------/
41 * Field _elementDefinition.
43 private boolean _elementDefinition;
48 private java.lang.String _nsPrefix;
53 private java.lang.String _nsURI;
58 private java.lang.String _xmlName;
64 public JalviewModelSequenceDescriptor()
67 _nsURI = "www.jalview.org";
68 _elementDefinition = false;
70 // -- set grouping compositor
71 setCompositorAsSequence();
72 org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
73 org.exolab.castor.mapping.FieldHandler handler = null;
74 org.exolab.castor.xml.FieldValidator fieldValidator = null;
75 // -- initialize attribute descriptors
77 // -- initialize element descriptors
80 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
81 jalview.schemabinding.version2.JSeq.class, "_JSeqList", "JSeq",
82 org.exolab.castor.xml.NodeType.Element);
83 handler = new org.exolab.castor.xml.XMLFieldHandler()
85 public java.lang.Object getValue(java.lang.Object object)
86 throws IllegalStateException
88 JalviewModelSequence target = (JalviewModelSequence) object;
89 return target.getJSeq();
92 public void setValue(java.lang.Object object, java.lang.Object value)
93 throws IllegalStateException, IllegalArgumentException
97 JalviewModelSequence target = (JalviewModelSequence) object;
98 target.addJSeq((jalview.schemabinding.version2.JSeq) value);
99 } catch (java.lang.Exception ex)
101 throw new IllegalStateException(ex.toString());
105 public void resetValue(Object object) throws IllegalStateException,
106 IllegalArgumentException
110 JalviewModelSequence target = (JalviewModelSequence) object;
111 target.removeAllJSeq();
112 } catch (java.lang.Exception ex)
114 throw new IllegalStateException(ex.toString());
118 public java.lang.Object newInstance(java.lang.Object parent)
120 return new jalview.schemabinding.version2.JSeq();
123 desc.setHandler(handler);
124 desc.setNameSpaceURI("www.jalview.org");
125 desc.setRequired(true);
126 desc.setMultivalued(true);
127 addFieldDescriptor(desc);
129 // -- validation code for: _JSeqList
130 fieldValidator = new org.exolab.castor.xml.FieldValidator();
131 fieldValidator.setMinOccurs(1);
134 desc.setValidator(fieldValidator);
136 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
137 jalview.schemabinding.version2.JGroup.class, "_JGroupList",
138 "JGroup", org.exolab.castor.xml.NodeType.Element);
139 handler = new org.exolab.castor.xml.XMLFieldHandler()
141 public java.lang.Object getValue(java.lang.Object object)
142 throws IllegalStateException
144 JalviewModelSequence target = (JalviewModelSequence) object;
145 return target.getJGroup();
148 public void setValue(java.lang.Object object, java.lang.Object value)
149 throws IllegalStateException, IllegalArgumentException
153 JalviewModelSequence target = (JalviewModelSequence) object;
154 target.addJGroup((jalview.schemabinding.version2.JGroup) value);
155 } catch (java.lang.Exception ex)
157 throw new IllegalStateException(ex.toString());
161 public void resetValue(Object object) throws IllegalStateException,
162 IllegalArgumentException
166 JalviewModelSequence target = (JalviewModelSequence) object;
167 target.removeAllJGroup();
168 } catch (java.lang.Exception ex)
170 throw new IllegalStateException(ex.toString());
174 public java.lang.Object newInstance(java.lang.Object parent)
176 return new jalview.schemabinding.version2.JGroup();
179 desc.setHandler(handler);
180 desc.setNameSpaceURI("www.jalview.org");
181 desc.setMultivalued(true);
182 addFieldDescriptor(desc);
184 // -- validation code for: _JGroupList
185 fieldValidator = new org.exolab.castor.xml.FieldValidator();
186 fieldValidator.setMinOccurs(0);
189 desc.setValidator(fieldValidator);
191 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
192 jalview.schemabinding.version2.Viewport.class, "_viewportList",
193 "Viewport", org.exolab.castor.xml.NodeType.Element);
194 handler = new org.exolab.castor.xml.XMLFieldHandler()
196 public java.lang.Object getValue(java.lang.Object object)
197 throws IllegalStateException
199 JalviewModelSequence target = (JalviewModelSequence) object;
200 return target.getViewport();
203 public void setValue(java.lang.Object object, java.lang.Object value)
204 throws IllegalStateException, IllegalArgumentException
208 JalviewModelSequence target = (JalviewModelSequence) object;
209 target.addViewport((jalview.schemabinding.version2.Viewport) value);
210 } catch (java.lang.Exception ex)
212 throw new IllegalStateException(ex.toString());
216 public void resetValue(Object object) throws IllegalStateException,
217 IllegalArgumentException
221 JalviewModelSequence target = (JalviewModelSequence) object;
222 target.removeAllViewport();
223 } catch (java.lang.Exception ex)
225 throw new IllegalStateException(ex.toString());
229 public java.lang.Object newInstance(java.lang.Object parent)
231 return new jalview.schemabinding.version2.Viewport();
234 desc.setHandler(handler);
235 desc.setNameSpaceURI("www.jalview.org");
236 desc.setRequired(true);
237 desc.setMultivalued(true);
238 addFieldDescriptor(desc);
240 // -- validation code for: _viewportList
241 fieldValidator = new org.exolab.castor.xml.FieldValidator();
242 fieldValidator.setMinOccurs(1);
245 desc.setValidator(fieldValidator);
246 // -- _userColoursList
247 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
248 jalview.schemabinding.version2.UserColours.class,
249 "_userColoursList", "UserColours",
250 org.exolab.castor.xml.NodeType.Element);
251 handler = new org.exolab.castor.xml.XMLFieldHandler()
253 public java.lang.Object getValue(java.lang.Object object)
254 throws IllegalStateException
256 JalviewModelSequence target = (JalviewModelSequence) object;
257 return target.getUserColours();
260 public void setValue(java.lang.Object object, java.lang.Object value)
261 throws IllegalStateException, IllegalArgumentException
265 JalviewModelSequence target = (JalviewModelSequence) object;
266 target.addUserColours((jalview.schemabinding.version2.UserColours) value);
267 } catch (java.lang.Exception ex)
269 throw new IllegalStateException(ex.toString());
273 public void resetValue(Object object) throws IllegalStateException,
274 IllegalArgumentException
278 JalviewModelSequence target = (JalviewModelSequence) object;
279 target.removeAllUserColours();
280 } catch (java.lang.Exception ex)
282 throw new IllegalStateException(ex.toString());
286 public java.lang.Object newInstance(java.lang.Object parent)
288 return new jalview.schemabinding.version2.UserColours();
291 desc.setHandler(handler);
292 desc.setNameSpaceURI("www.jalview.org");
293 desc.setMultivalued(true);
294 addFieldDescriptor(desc);
296 // -- validation code for: _userColoursList
297 fieldValidator = new org.exolab.castor.xml.FieldValidator();
298 fieldValidator.setMinOccurs(0);
301 desc.setValidator(fieldValidator);
303 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
304 jalview.schemabinding.version2.Tree.class, "_treeList", "tree",
305 org.exolab.castor.xml.NodeType.Element);
306 handler = new org.exolab.castor.xml.XMLFieldHandler()
308 public java.lang.Object getValue(java.lang.Object object)
309 throws IllegalStateException
311 JalviewModelSequence target = (JalviewModelSequence) object;
312 return target.getTree();
315 public void setValue(java.lang.Object object, java.lang.Object value)
316 throws IllegalStateException, IllegalArgumentException
320 JalviewModelSequence target = (JalviewModelSequence) object;
321 target.addTree((jalview.schemabinding.version2.Tree) value);
322 } catch (java.lang.Exception ex)
324 throw new IllegalStateException(ex.toString());
328 public void resetValue(Object object) throws IllegalStateException,
329 IllegalArgumentException
333 JalviewModelSequence target = (JalviewModelSequence) object;
334 target.removeAllTree();
335 } catch (java.lang.Exception ex)
337 throw new IllegalStateException(ex.toString());
341 public java.lang.Object newInstance(java.lang.Object parent)
343 return new jalview.schemabinding.version2.Tree();
346 desc.setHandler(handler);
347 desc.setNameSpaceURI("www.jalview.org");
348 desc.setMultivalued(true);
349 addFieldDescriptor(desc);
351 // -- validation code for: _treeList
352 fieldValidator = new org.exolab.castor.xml.FieldValidator();
353 fieldValidator.setMinOccurs(0);
356 desc.setValidator(fieldValidator);
357 // -- _featureSettings
358 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
359 jalview.schemabinding.version2.FeatureSettings.class,
360 "_featureSettings", "FeatureSettings",
361 org.exolab.castor.xml.NodeType.Element);
362 handler = new org.exolab.castor.xml.XMLFieldHandler()
364 public java.lang.Object getValue(java.lang.Object object)
365 throws IllegalStateException
367 JalviewModelSequence target = (JalviewModelSequence) object;
368 return target.getFeatureSettings();
371 public void setValue(java.lang.Object object, java.lang.Object value)
372 throws IllegalStateException, IllegalArgumentException
376 JalviewModelSequence target = (JalviewModelSequence) object;
377 target.setFeatureSettings((jalview.schemabinding.version2.FeatureSettings) value);
378 } catch (java.lang.Exception ex)
380 throw new IllegalStateException(ex.toString());
384 public java.lang.Object newInstance(java.lang.Object parent)
386 return new jalview.schemabinding.version2.FeatureSettings();
389 desc.setHandler(handler);
390 desc.setNameSpaceURI("www.jalview.org");
391 desc.setMultivalued(false);
392 addFieldDescriptor(desc);
394 // -- validation code for: _featureSettings
395 fieldValidator = new org.exolab.castor.xml.FieldValidator();
398 desc.setValidator(fieldValidator);
406 * Method getAccessMode.
408 * @return the access mode specified for this class.
410 public org.exolab.castor.mapping.AccessMode getAccessMode()
416 * Method getIdentity.
418 * @return the identity field, null if this class has no identity.
420 public org.exolab.castor.mapping.FieldDescriptor getIdentity()
422 return super.getIdentity();
426 * Method getJavaClass.
428 * @return the Java class represented by this descriptor.
430 public java.lang.Class getJavaClass()
432 return jalview.schemabinding.version2.JalviewModelSequence.class;
436 * Method getNameSpacePrefix.
438 * @return the namespace prefix to use when marshaling as XML.
440 public java.lang.String getNameSpacePrefix()
446 * Method getNameSpaceURI.
448 * @return the namespace URI used when marshaling and unmarshaling as XML.
450 public java.lang.String getNameSpaceURI()
456 * Method getValidator.
458 * @return a specific validator for the class described by this
461 public org.exolab.castor.xml.TypeValidator getValidator()
469 * @return the XML Name for the Class being described.
471 public java.lang.String getXMLName()
477 * Method isElementDefinition.
479 * @return true if XML schema definition of this Class is that of a global
480 * element or element with anonymous type definition.
482 public boolean isElementDefinition()
484 return _elementDefinition;