JAL-1432 updated copyright notices
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / UserColoursDescriptor.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
3  * Copyright (C) 2014 The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
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.
10  *  
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.
15  * 
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.
18  */
19 package jalview.schemabinding.version2.descriptors;
20
21 //---------------------------------/
22 //- Imported classes and packages -/
23 //---------------------------------/
24
25 import jalview.schemabinding.version2.UserColours;
26
27 /**
28  * Class UserColoursDescriptor.
29  * 
30  * @version $Revision$ $Date$
31  */
32 public class UserColoursDescriptor extends
33         org.exolab.castor.xml.util.XMLClassDescriptorImpl
34 {
35
36   // --------------------------/
37   // - Class/Member Variables -/
38   // --------------------------/
39
40   /**
41    * Field _elementDefinition.
42    */
43   private boolean _elementDefinition;
44
45   /**
46    * Field _nsPrefix.
47    */
48   private java.lang.String _nsPrefix;
49
50   /**
51    * Field _nsURI.
52    */
53   private java.lang.String _nsURI;
54
55   /**
56    * Field _xmlName.
57    */
58   private java.lang.String _xmlName;
59
60   // ----------------/
61   // - Constructors -/
62   // ----------------/
63
64   public UserColoursDescriptor()
65   {
66     super();
67     _nsURI = "www.jalview.org";
68     _xmlName = "UserColours";
69     _elementDefinition = true;
70
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
77
78     // -- _id
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()
84     {
85       public java.lang.Object getValue(java.lang.Object object)
86               throws IllegalStateException
87       {
88         UserColours target = (UserColours) object;
89         return target.getId();
90       }
91
92       public void setValue(java.lang.Object object, java.lang.Object value)
93               throws IllegalStateException, IllegalArgumentException
94       {
95         try
96         {
97           UserColours target = (UserColours) object;
98           target.setId((java.lang.String) value);
99         } catch (java.lang.Exception ex)
100         {
101           throw new IllegalStateException(ex.toString());
102         }
103       }
104
105       public java.lang.Object newInstance(java.lang.Object parent)
106       {
107         return null;
108       }
109     };
110     desc.setHandler(handler);
111     desc.setMultivalued(false);
112     addFieldDescriptor(desc);
113
114     // -- validation code for: _id
115     fieldValidator = new org.exolab.castor.xml.FieldValidator();
116     { // -- local scope
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");
121     }
122     desc.setValidator(fieldValidator);
123     // -- initialize element descriptors
124
125     // -- _userColourScheme
126     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
127             jalview.schemabinding.version2.UserColourScheme.class,
128             "_userColourScheme", "UserColourScheme",
129             org.exolab.castor.xml.NodeType.Element);
130     handler = new org.exolab.castor.xml.XMLFieldHandler()
131     {
132       public java.lang.Object getValue(java.lang.Object object)
133               throws IllegalStateException
134       {
135         UserColours target = (UserColours) object;
136         return target.getUserColourScheme();
137       }
138
139       public void setValue(java.lang.Object object, java.lang.Object value)
140               throws IllegalStateException, IllegalArgumentException
141       {
142         try
143         {
144           UserColours target = (UserColours) object;
145           target.setUserColourScheme((jalview.schemabinding.version2.UserColourScheme) value);
146         } catch (java.lang.Exception ex)
147         {
148           throw new IllegalStateException(ex.toString());
149         }
150       }
151
152       public java.lang.Object newInstance(java.lang.Object parent)
153       {
154         return new jalview.schemabinding.version2.UserColourScheme();
155       }
156     };
157     desc.setHandler(handler);
158     desc.setNameSpaceURI("www.jalview.org");
159     desc.setRequired(true);
160     desc.setMultivalued(false);
161     addFieldDescriptor(desc);
162
163     // -- validation code for: _userColourScheme
164     fieldValidator = new org.exolab.castor.xml.FieldValidator();
165     fieldValidator.setMinOccurs(1);
166     { // -- local scope
167     }
168     desc.setValidator(fieldValidator);
169   }
170
171   // -----------/
172   // - Methods -/
173   // -----------/
174
175   /**
176    * Method getAccessMode.
177    * 
178    * @return the access mode specified for this class.
179    */
180   public org.exolab.castor.mapping.AccessMode getAccessMode()
181   {
182     return null;
183   }
184
185   /**
186    * Method getIdentity.
187    * 
188    * @return the identity field, null if this class has no identity.
189    */
190   public org.exolab.castor.mapping.FieldDescriptor getIdentity()
191   {
192     return super.getIdentity();
193   }
194
195   /**
196    * Method getJavaClass.
197    * 
198    * @return the Java class represented by this descriptor.
199    */
200   public java.lang.Class getJavaClass()
201   {
202     return jalview.schemabinding.version2.UserColours.class;
203   }
204
205   /**
206    * Method getNameSpacePrefix.
207    * 
208    * @return the namespace prefix to use when marshaling as XML.
209    */
210   public java.lang.String getNameSpacePrefix()
211   {
212     return _nsPrefix;
213   }
214
215   /**
216    * Method getNameSpaceURI.
217    * 
218    * @return the namespace URI used when marshaling and unmarshaling as XML.
219    */
220   public java.lang.String getNameSpaceURI()
221   {
222     return _nsURI;
223   }
224
225   /**
226    * Method getValidator.
227    * 
228    * @return a specific validator for the class described by this
229    *         ClassDescriptor.
230    */
231   public org.exolab.castor.xml.TypeValidator getValidator()
232   {
233     return this;
234   }
235
236   /**
237    * Method getXMLName.
238    * 
239    * @return the XML Name for the Class being described.
240    */
241   public java.lang.String getXMLName()
242   {
243     return _xmlName;
244   }
245
246   /**
247    * Method isElementDefinition.
248    * 
249    * @return true if XML schema definition of this Class is that of a global
250    *         element or element with anonymous type definition.
251    */
252   public boolean isElementDefinition()
253   {
254     return _elementDefinition;
255   }
256
257 }