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.UserColours;
27 * Class UserColoursDescriptor.
29 * @version $Revision$ $Date$
31 public class UserColoursDescriptor 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 UserColoursDescriptor()
66 _nsURI = "www.jalview.org";
67 _xmlName = "UserColours";
68 _elementDefinition = true;
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
78 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
79 java.lang.String.class, "_id", "id",
80 org.exolab.castor.xml.NodeType.Attribute);
81 desc.setImmutable(true);
82 handler = new org.exolab.castor.xml.XMLFieldHandler()
84 public java.lang.Object getValue(java.lang.Object object)
85 throws IllegalStateException
87 UserColours target = (UserColours) object;
88 return target.getId();
91 public void setValue(java.lang.Object object, java.lang.Object value)
92 throws IllegalStateException, IllegalArgumentException
96 UserColours target = (UserColours) object;
97 target.setId((java.lang.String) value);
98 } catch (java.lang.Exception ex)
100 throw new IllegalStateException(ex.toString());
104 public java.lang.Object newInstance(java.lang.Object parent)
109 desc.setHandler(handler);
110 desc.setMultivalued(false);
111 addFieldDescriptor(desc);
113 // -- validation code for: _id
114 fieldValidator = new org.exolab.castor.xml.FieldValidator();
116 org.exolab.castor.xml.validators.StringValidator typeValidator;
117 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
118 fieldValidator.setValidator(typeValidator);
119 typeValidator.setWhiteSpace("preserve");
121 desc.setValidator(fieldValidator);
122 // -- initialize element descriptors
124 // -- _userColourScheme
125 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
126 jalview.schemabinding.version2.UserColourScheme.class,
127 "_userColourScheme", "UserColourScheme",
128 org.exolab.castor.xml.NodeType.Element);
129 handler = new org.exolab.castor.xml.XMLFieldHandler()
131 public java.lang.Object getValue(java.lang.Object object)
132 throws IllegalStateException
134 UserColours target = (UserColours) object;
135 return target.getUserColourScheme();
138 public void setValue(java.lang.Object object, java.lang.Object value)
139 throws IllegalStateException, IllegalArgumentException
143 UserColours target = (UserColours) object;
144 target.setUserColourScheme((jalview.schemabinding.version2.UserColourScheme) value);
145 } catch (java.lang.Exception ex)
147 throw new IllegalStateException(ex.toString());
151 public java.lang.Object newInstance(java.lang.Object parent)
153 return new jalview.schemabinding.version2.UserColourScheme();
156 desc.setHandler(handler);
157 desc.setNameSpaceURI("www.jalview.org");
158 desc.setRequired(true);
159 desc.setMultivalued(false);
160 addFieldDescriptor(desc);
162 // -- validation code for: _userColourScheme
163 fieldValidator = new org.exolab.castor.xml.FieldValidator();
164 fieldValidator.setMinOccurs(1);
167 desc.setValidator(fieldValidator);
175 * Method getAccessMode.
177 * @return the access mode specified for this class.
179 public org.exolab.castor.mapping.AccessMode getAccessMode()
185 * Method getIdentity.
187 * @return the identity field, null if this class has no identity.
189 public org.exolab.castor.mapping.FieldDescriptor getIdentity()
191 return super.getIdentity();
195 * Method getJavaClass.
197 * @return the Java class represented by this descriptor.
199 public java.lang.Class getJavaClass()
201 return jalview.schemabinding.version2.UserColours.class;
205 * Method getNameSpacePrefix.
207 * @return the namespace prefix to use when marshaling as XML.
209 public java.lang.String getNameSpacePrefix()
215 * Method getNameSpaceURI.
217 * @return the namespace URI used when marshaling and unmarshaling as XML.
219 public java.lang.String getNameSpaceURI()
225 * Method getValidator.
227 * @return a specific validator for the class described by this
230 public org.exolab.castor.xml.TypeValidator getValidator()
238 * @return the XML Name for the Class being described.
240 public java.lang.String getXMLName()
246 * Method isElementDefinition.
248 * @return true if XML schema definition of this Class is that of a global
249 * element or element with anonymous type definition.
251 public boolean isElementDefinition()
253 return _elementDefinition;