JAL-1432 updated copyright notices
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / SequenceSetPropertiesDescriptor.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.SequenceSetProperties;
26
27 /**
28  * Class SequenceSetPropertiesDescriptor.
29  * 
30  * @version $Revision$ $Date$
31  */
32 public class SequenceSetPropertiesDescriptor 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 SequenceSetPropertiesDescriptor()
65   {
66     super();
67     _nsURI = "www.vamsas.ac.uk/jalview/version2";
68     _xmlName = "sequenceSetProperties";
69     _elementDefinition = true;
70     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
71     org.exolab.castor.mapping.FieldHandler handler = null;
72     org.exolab.castor.xml.FieldValidator fieldValidator = null;
73     // -- initialize attribute descriptors
74
75     // -- _key
76     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
77             java.lang.String.class, "_key", "key",
78             org.exolab.castor.xml.NodeType.Attribute);
79     desc.setImmutable(true);
80     handler = new org.exolab.castor.xml.XMLFieldHandler()
81     {
82       public java.lang.Object getValue(java.lang.Object object)
83               throws IllegalStateException
84       {
85         SequenceSetProperties target = (SequenceSetProperties) object;
86         return target.getKey();
87       }
88
89       public void setValue(java.lang.Object object, java.lang.Object value)
90               throws IllegalStateException, IllegalArgumentException
91       {
92         try
93         {
94           SequenceSetProperties target = (SequenceSetProperties) object;
95           target.setKey((java.lang.String) value);
96         } catch (java.lang.Exception ex)
97         {
98           throw new IllegalStateException(ex.toString());
99         }
100       }
101
102       public java.lang.Object newInstance(java.lang.Object parent)
103       {
104         return null;
105       }
106     };
107     desc.setHandler(handler);
108     desc.setMultivalued(false);
109     addFieldDescriptor(desc);
110
111     // -- validation code for: _key
112     fieldValidator = new org.exolab.castor.xml.FieldValidator();
113     { // -- local scope
114       org.exolab.castor.xml.validators.StringValidator typeValidator;
115       typeValidator = new org.exolab.castor.xml.validators.StringValidator();
116       fieldValidator.setValidator(typeValidator);
117       typeValidator.setWhiteSpace("preserve");
118     }
119     desc.setValidator(fieldValidator);
120     // -- _value
121     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
122             java.lang.String.class, "_value", "value",
123             org.exolab.castor.xml.NodeType.Attribute);
124     desc.setImmutable(true);
125     handler = new org.exolab.castor.xml.XMLFieldHandler()
126     {
127       public java.lang.Object getValue(java.lang.Object object)
128               throws IllegalStateException
129       {
130         SequenceSetProperties target = (SequenceSetProperties) object;
131         return target.getValue();
132       }
133
134       public void setValue(java.lang.Object object, java.lang.Object value)
135               throws IllegalStateException, IllegalArgumentException
136       {
137         try
138         {
139           SequenceSetProperties target = (SequenceSetProperties) object;
140           target.setValue((java.lang.String) value);
141         } catch (java.lang.Exception ex)
142         {
143           throw new IllegalStateException(ex.toString());
144         }
145       }
146
147       public java.lang.Object newInstance(java.lang.Object parent)
148       {
149         return null;
150       }
151     };
152     desc.setHandler(handler);
153     desc.setMultivalued(false);
154     addFieldDescriptor(desc);
155
156     // -- validation code for: _value
157     fieldValidator = new org.exolab.castor.xml.FieldValidator();
158     { // -- local scope
159       org.exolab.castor.xml.validators.StringValidator typeValidator;
160       typeValidator = new org.exolab.castor.xml.validators.StringValidator();
161       fieldValidator.setValidator(typeValidator);
162       typeValidator.setWhiteSpace("preserve");
163     }
164     desc.setValidator(fieldValidator);
165     // -- initialize element descriptors
166
167   }
168
169   // -----------/
170   // - Methods -/
171   // -----------/
172
173   /**
174    * Method getAccessMode.
175    * 
176    * @return the access mode specified for this class.
177    */
178   public org.exolab.castor.mapping.AccessMode getAccessMode()
179   {
180     return null;
181   }
182
183   /**
184    * Method getIdentity.
185    * 
186    * @return the identity field, null if this class has no identity.
187    */
188   public org.exolab.castor.mapping.FieldDescriptor getIdentity()
189   {
190     return super.getIdentity();
191   }
192
193   /**
194    * Method getJavaClass.
195    * 
196    * @return the Java class represented by this descriptor.
197    */
198   public java.lang.Class getJavaClass()
199   {
200     return jalview.schemabinding.version2.SequenceSetProperties.class;
201   }
202
203   /**
204    * Method getNameSpacePrefix.
205    * 
206    * @return the namespace prefix to use when marshaling as XML.
207    */
208   public java.lang.String getNameSpacePrefix()
209   {
210     return _nsPrefix;
211   }
212
213   /**
214    * Method getNameSpaceURI.
215    * 
216    * @return the namespace URI used when marshaling and unmarshaling as XML.
217    */
218   public java.lang.String getNameSpaceURI()
219   {
220     return _nsURI;
221   }
222
223   /**
224    * Method getValidator.
225    * 
226    * @return a specific validator for the class described by this
227    *         ClassDescriptor.
228    */
229   public org.exolab.castor.xml.TypeValidator getValidator()
230   {
231     return this;
232   }
233
234   /**
235    * Method getXMLName.
236    * 
237    * @return the XML Name for the Class being described.
238    */
239   public java.lang.String getXMLName()
240   {
241     return _xmlName;
242   }
243
244   /**
245    * Method isElementDefinition.
246    * 
247    * @return true if XML schema definition of this Class is that of a global
248    *         element or element with anonymous type definition.
249    */
250   public boolean isElementDefinition()
251   {
252     return _elementDefinition;
253   }
254
255 }