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.SequenceType;
28 * Class SequenceTypeDescriptor.
30 * @version $Revision$ $Date$
32 public class SequenceTypeDescriptor 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 SequenceTypeDescriptor()
67 _nsURI = "www.vamsas.ac.uk/jalview/version2";
68 _xmlName = "SequenceType";
69 _elementDefinition = false;
71 // -- set grouping compositor
72 setCompositorAsSequence();
73 org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
74 org.exolab.castor.mapping.FieldHandler handler = null;
75 org.exolab.castor.xml.FieldValidator fieldValidator = null;
76 // -- initialize attribute descriptors
79 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
80 java.lang.String.class, "_id", "id",
81 org.exolab.castor.xml.NodeType.Attribute);
82 desc.setImmutable(true);
83 handler = new org.exolab.castor.xml.XMLFieldHandler()
85 public java.lang.Object getValue(java.lang.Object object)
86 throws IllegalStateException
88 SequenceType target = (SequenceType) object;
89 return target.getId();
92 public void setValue(java.lang.Object object, java.lang.Object value)
93 throws IllegalStateException, IllegalArgumentException
97 SequenceType target = (SequenceType) object;
98 target.setId((java.lang.String) value);
99 } catch (java.lang.Exception ex)
101 throw new IllegalStateException(ex.toString());
105 public java.lang.Object newInstance(java.lang.Object parent)
110 desc.setHandler(handler);
111 desc.setMultivalued(false);
112 addFieldDescriptor(desc);
114 // -- validation code for: _id
115 fieldValidator = new org.exolab.castor.xml.FieldValidator();
117 org.exolab.castor.xml.validators.StringValidator typeValidator;
118 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
119 fieldValidator.setValidator(typeValidator);
120 typeValidator.setWhiteSpace("preserve");
122 desc.setValidator(fieldValidator);
124 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
125 java.lang.String.class, "_description", "description",
126 org.exolab.castor.xml.NodeType.Attribute);
127 desc.setImmutable(true);
128 handler = new org.exolab.castor.xml.XMLFieldHandler()
130 public java.lang.Object getValue(java.lang.Object object)
131 throws IllegalStateException
133 SequenceType target = (SequenceType) object;
134 return target.getDescription();
137 public void setValue(java.lang.Object object, java.lang.Object value)
138 throws IllegalStateException, IllegalArgumentException
142 SequenceType target = (SequenceType) object;
143 target.setDescription((java.lang.String) value);
144 } catch (java.lang.Exception ex)
146 throw new IllegalStateException(ex.toString());
150 public java.lang.Object newInstance(java.lang.Object parent)
155 desc.setHandler(handler);
156 desc.setMultivalued(false);
157 addFieldDescriptor(desc);
159 // -- validation code for: _description
160 fieldValidator = new org.exolab.castor.xml.FieldValidator();
162 org.exolab.castor.xml.validators.StringValidator typeValidator;
163 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
164 fieldValidator.setValidator(typeValidator);
165 typeValidator.setWhiteSpace("preserve");
167 desc.setValidator(fieldValidator);
168 // -- initialize element descriptors
171 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
172 java.lang.String.class, "_sequence", "sequence",
173 org.exolab.castor.xml.NodeType.Element);
174 desc.setImmutable(true);
175 handler = new org.exolab.castor.xml.XMLFieldHandler()
177 public java.lang.Object getValue(java.lang.Object object)
178 throws IllegalStateException
180 SequenceType target = (SequenceType) object;
181 return target.getSequence();
184 public void setValue(java.lang.Object object, java.lang.Object value)
185 throws IllegalStateException, IllegalArgumentException
189 SequenceType target = (SequenceType) object;
190 target.setSequence((java.lang.String) value);
191 } catch (java.lang.Exception ex)
193 throw new IllegalStateException(ex.toString());
197 public java.lang.Object newInstance(java.lang.Object parent)
202 desc.setHandler(handler);
203 desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");
204 desc.setMultivalued(false);
205 addFieldDescriptor(desc);
207 // -- validation code for: _sequence
208 fieldValidator = new org.exolab.castor.xml.FieldValidator();
210 org.exolab.castor.xml.validators.StringValidator typeValidator;
211 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
212 fieldValidator.setValidator(typeValidator);
213 typeValidator.setWhiteSpace("preserve");
215 desc.setValidator(fieldValidator);
217 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
218 java.lang.String.class, "_name", "name",
219 org.exolab.castor.xml.NodeType.Element);
220 desc.setImmutable(true);
221 handler = new org.exolab.castor.xml.XMLFieldHandler()
223 public java.lang.Object getValue(java.lang.Object object)
224 throws IllegalStateException
226 SequenceType target = (SequenceType) object;
227 return target.getName();
230 public void setValue(java.lang.Object object, java.lang.Object value)
231 throws IllegalStateException, IllegalArgumentException
235 SequenceType target = (SequenceType) object;
236 target.setName((java.lang.String) value);
237 } catch (java.lang.Exception ex)
239 throw new IllegalStateException(ex.toString());
243 public java.lang.Object newInstance(java.lang.Object parent)
248 desc.setHandler(handler);
249 desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");
250 desc.setMultivalued(false);
251 addFieldDescriptor(desc);
253 // -- validation code for: _name
254 fieldValidator = new org.exolab.castor.xml.FieldValidator();
256 org.exolab.castor.xml.validators.StringValidator typeValidator;
257 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
258 fieldValidator.setValidator(typeValidator);
259 typeValidator.setWhiteSpace("preserve");
261 desc.setValidator(fieldValidator);
269 * Method getAccessMode.
271 * @return the access mode specified for this class.
273 public org.exolab.castor.mapping.AccessMode getAccessMode()
279 * Method getIdentity.
281 * @return the identity field, null if this class has no identity.
283 public org.exolab.castor.mapping.FieldDescriptor getIdentity()
285 return super.getIdentity();
289 * Method getJavaClass.
291 * @return the Java class represented by this descriptor.
293 public java.lang.Class getJavaClass()
295 return jalview.schemabinding.version2.SequenceType.class;
299 * Method getNameSpacePrefix.
301 * @return the namespace prefix to use when marshaling as XML.
303 public java.lang.String getNameSpacePrefix()
309 * Method getNameSpaceURI.
311 * @return the namespace URI used when marshaling and unmarshaling as XML.
313 public java.lang.String getNameSpaceURI()
319 * Method getValidator.
321 * @return a specific validator for the class described by this
324 public org.exolab.castor.xml.TypeValidator getValidator()
332 * @return the XML Name for the Class being described.
334 public java.lang.String getXMLName()
340 * Method isElementDefinition.
342 * @return true if XML schema definition of this Class is that of a global
343 * element or element with anonymous type definition.
345 public boolean isElementDefinition()
347 return _elementDefinition;