2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ 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
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
21 package jalview.schemabinding.version2.descriptors;
23 //---------------------------------/
24 //- Imported classes and packages -/
25 //---------------------------------/
27 import jalview.schemabinding.version2.SequenceType;
30 * Class SequenceTypeDescriptor.
32 * @version $Revision$ $Date$
34 public class SequenceTypeDescriptor extends
35 org.exolab.castor.xml.util.XMLClassDescriptorImpl
38 // --------------------------/
39 // - Class/Member Variables -/
40 // --------------------------/
43 * Field _elementDefinition.
45 private boolean _elementDefinition;
50 private java.lang.String _nsPrefix;
55 private java.lang.String _nsURI;
60 private java.lang.String _xmlName;
66 public SequenceTypeDescriptor()
69 _nsURI = "www.vamsas.ac.uk/jalview/version2";
70 _xmlName = "SequenceType";
71 _elementDefinition = false;
73 // -- set grouping compositor
74 setCompositorAsSequence();
75 org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
76 org.exolab.castor.mapping.FieldHandler handler = null;
77 org.exolab.castor.xml.FieldValidator fieldValidator = null;
78 // -- initialize attribute descriptors
81 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
82 java.lang.String.class, "_id", "id",
83 org.exolab.castor.xml.NodeType.Attribute);
84 desc.setImmutable(true);
85 handler = new org.exolab.castor.xml.XMLFieldHandler()
87 public java.lang.Object getValue(java.lang.Object object)
88 throws IllegalStateException
90 SequenceType target = (SequenceType) object;
91 return target.getId();
94 public void setValue(java.lang.Object object, java.lang.Object value)
95 throws IllegalStateException, IllegalArgumentException
99 SequenceType target = (SequenceType) object;
100 target.setId((java.lang.String) value);
101 } catch (java.lang.Exception ex)
103 throw new IllegalStateException(ex.toString());
107 public java.lang.Object newInstance(java.lang.Object parent)
112 desc.setHandler(handler);
113 desc.setMultivalued(false);
114 addFieldDescriptor(desc);
116 // -- validation code for: _id
117 fieldValidator = new org.exolab.castor.xml.FieldValidator();
119 org.exolab.castor.xml.validators.StringValidator typeValidator;
120 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
121 fieldValidator.setValidator(typeValidator);
122 typeValidator.setWhiteSpace("preserve");
124 desc.setValidator(fieldValidator);
126 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
127 java.lang.String.class, "_description", "description",
128 org.exolab.castor.xml.NodeType.Attribute);
129 desc.setImmutable(true);
130 handler = new org.exolab.castor.xml.XMLFieldHandler()
132 public java.lang.Object getValue(java.lang.Object object)
133 throws IllegalStateException
135 SequenceType target = (SequenceType) object;
136 return target.getDescription();
139 public void setValue(java.lang.Object object, java.lang.Object value)
140 throws IllegalStateException, IllegalArgumentException
144 SequenceType target = (SequenceType) object;
145 target.setDescription((java.lang.String) value);
146 } catch (java.lang.Exception ex)
148 throw new IllegalStateException(ex.toString());
152 public java.lang.Object newInstance(java.lang.Object parent)
157 desc.setHandler(handler);
158 desc.setMultivalued(false);
159 addFieldDescriptor(desc);
161 // -- validation code for: _description
162 fieldValidator = new org.exolab.castor.xml.FieldValidator();
164 org.exolab.castor.xml.validators.StringValidator typeValidator;
165 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
166 fieldValidator.setValidator(typeValidator);
167 typeValidator.setWhiteSpace("preserve");
169 desc.setValidator(fieldValidator);
170 // -- initialize element descriptors
173 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
174 java.lang.String.class, "_sequence", "sequence",
175 org.exolab.castor.xml.NodeType.Element);
176 desc.setImmutable(true);
177 handler = new org.exolab.castor.xml.XMLFieldHandler()
179 public java.lang.Object getValue(java.lang.Object object)
180 throws IllegalStateException
182 SequenceType target = (SequenceType) object;
183 return target.getSequence();
186 public void setValue(java.lang.Object object, java.lang.Object value)
187 throws IllegalStateException, IllegalArgumentException
191 SequenceType target = (SequenceType) object;
192 target.setSequence((java.lang.String) value);
193 } catch (java.lang.Exception ex)
195 throw new IllegalStateException(ex.toString());
199 public java.lang.Object newInstance(java.lang.Object parent)
204 desc.setHandler(handler);
205 desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");
206 desc.setMultivalued(false);
207 addFieldDescriptor(desc);
209 // -- validation code for: _sequence
210 fieldValidator = new org.exolab.castor.xml.FieldValidator();
212 org.exolab.castor.xml.validators.StringValidator typeValidator;
213 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
214 fieldValidator.setValidator(typeValidator);
215 typeValidator.setWhiteSpace("preserve");
217 desc.setValidator(fieldValidator);
219 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
220 java.lang.String.class, "_name", "name",
221 org.exolab.castor.xml.NodeType.Element);
222 desc.setImmutable(true);
223 handler = new org.exolab.castor.xml.XMLFieldHandler()
225 public java.lang.Object getValue(java.lang.Object object)
226 throws IllegalStateException
228 SequenceType target = (SequenceType) object;
229 return target.getName();
232 public void setValue(java.lang.Object object, java.lang.Object value)
233 throws IllegalStateException, IllegalArgumentException
237 SequenceType target = (SequenceType) object;
238 target.setName((java.lang.String) value);
239 } catch (java.lang.Exception ex)
241 throw new IllegalStateException(ex.toString());
245 public java.lang.Object newInstance(java.lang.Object parent)
250 desc.setHandler(handler);
251 desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");
252 desc.setMultivalued(false);
253 addFieldDescriptor(desc);
255 // -- validation code for: _name
256 fieldValidator = new org.exolab.castor.xml.FieldValidator();
258 org.exolab.castor.xml.validators.StringValidator typeValidator;
259 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
260 fieldValidator.setValidator(typeValidator);
261 typeValidator.setWhiteSpace("preserve");
263 desc.setValidator(fieldValidator);
271 * Method getAccessMode.
273 * @return the access mode specified for this class.
275 public org.exolab.castor.mapping.AccessMode getAccessMode()
281 * Method getIdentity.
283 * @return the identity field, null if this class has no identity.
285 public org.exolab.castor.mapping.FieldDescriptor getIdentity()
287 return super.getIdentity();
291 * Method getJavaClass.
293 * @return the Java class represented by this descriptor.
295 public java.lang.Class getJavaClass()
297 return jalview.schemabinding.version2.SequenceType.class;
301 * Method getNameSpacePrefix.
303 * @return the namespace prefix to use when marshaling as XML.
305 public java.lang.String getNameSpacePrefix()
311 * Method getNameSpaceURI.
313 * @return the namespace URI used when marshaling and unmarshaling as XML.
315 public java.lang.String getNameSpaceURI()
321 * Method getValidator.
323 * @return a specific validator for the class described by this
326 public org.exolab.castor.xml.TypeValidator getValidator()
334 * @return the XML Name for the Class being described.
336 public java.lang.String getXMLName()
342 * Method isElementDefinition.
344 * @return true if XML schema definition of this Class is that of a global
345 * element or element with anonymous type definition.
347 public boolean isElementDefinition()
349 return _elementDefinition;