2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
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
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.UserColours;
30 * Class UserColoursDescriptor.
32 * @version $Revision$ $Date$
34 public class UserColoursDescriptor 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 UserColoursDescriptor()
69 _nsURI = "www.jalview.org";
70 _xmlName = "UserColours";
71 _elementDefinition = true;
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 UserColours target = (UserColours) object;
91 return target.getId();
94 public void setValue(java.lang.Object object, java.lang.Object value)
95 throws IllegalStateException, IllegalArgumentException
99 UserColours target = (UserColours) 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);
125 // -- initialize element descriptors
127 // -- _userColourScheme
128 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
129 jalview.schemabinding.version2.UserColourScheme.class,
130 "_userColourScheme", "UserColourScheme",
131 org.exolab.castor.xml.NodeType.Element);
132 handler = new org.exolab.castor.xml.XMLFieldHandler()
134 public java.lang.Object getValue(java.lang.Object object)
135 throws IllegalStateException
137 UserColours target = (UserColours) object;
138 return target.getUserColourScheme();
141 public void setValue(java.lang.Object object, java.lang.Object value)
142 throws IllegalStateException, IllegalArgumentException
146 UserColours target = (UserColours) object;
147 target.setUserColourScheme((jalview.schemabinding.version2.UserColourScheme) value);
148 } catch (java.lang.Exception ex)
150 throw new IllegalStateException(ex.toString());
154 public java.lang.Object newInstance(java.lang.Object parent)
156 return new jalview.schemabinding.version2.UserColourScheme();
159 desc.setHandler(handler);
160 desc.setNameSpaceURI("www.jalview.org");
161 desc.setRequired(true);
162 desc.setMultivalued(false);
163 addFieldDescriptor(desc);
165 // -- validation code for: _userColourScheme
166 fieldValidator = new org.exolab.castor.xml.FieldValidator();
167 fieldValidator.setMinOccurs(1);
170 desc.setValidator(fieldValidator);
178 * Method getAccessMode.
180 * @return the access mode specified for this class.
182 public org.exolab.castor.mapping.AccessMode getAccessMode()
188 * Method getIdentity.
190 * @return the identity field, null if this class has no identity.
192 public org.exolab.castor.mapping.FieldDescriptor getIdentity()
194 return super.getIdentity();
198 * Method getJavaClass.
200 * @return the Java class represented by this descriptor.
202 public java.lang.Class getJavaClass()
204 return jalview.schemabinding.version2.UserColours.class;
208 * Method getNameSpacePrefix.
210 * @return the namespace prefix to use when marshaling as XML.
212 public java.lang.String getNameSpacePrefix()
218 * Method getNameSpaceURI.
220 * @return the namespace URI used when marshaling and unmarshaling as XML.
222 public java.lang.String getNameSpaceURI()
228 * Method getValidator.
230 * @return a specific validator for the class described by this
233 public org.exolab.castor.xml.TypeValidator getValidator()
241 * @return the XML Name for the Class being described.
243 public java.lang.String getXMLName()
249 * Method isElementDefinition.
251 * @return true if XML schema definition of this Class is that of a global
252 * element or element with anonymous type definition.
254 public boolean isElementDefinition()
256 return _elementDefinition;