apply gpl development license
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / SequenceSetPropertiesDescriptor.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)\r
3  * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
4  * \r
5  * This program is free software; you can redistribute it and/or\r
6  * modify it under the terms of the GNU General Public License\r
7  * as published by the Free Software Foundation; either version 2\r
8  * of the License, or (at your option) any later version.\r
9  * \r
10  * This program is distributed in the hope that it will be useful,\r
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
13  * GNU General Public License for more details.\r
14  * \r
15  * You should have received a copy of the GNU General Public License\r
16  * along with this program; if not, write to the Free Software\r
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
18  */\r
19 package jalview.schemabinding.version2.descriptors;\r
20 \r
21   //---------------------------------/\r
22  //- Imported classes and packages -/\r
23 //---------------------------------/\r
24 \r
25 import jalview.schemabinding.version2.SequenceSetProperties;\r
26 \r
27 /**\r
28  * Class SequenceSetPropertiesDescriptor.\r
29  * \r
30  * @version $Revision$ $Date$\r
31  */\r
32 public class SequenceSetPropertiesDescriptor extends org.exolab.castor.xml.util.XMLClassDescriptorImpl {\r
33 \r
34 \r
35       //--------------------------/\r
36      //- Class/Member Variables -/\r
37     //--------------------------/\r
38 \r
39     /**\r
40      * Field _elementDefinition.\r
41      */\r
42     private boolean _elementDefinition;\r
43 \r
44     /**\r
45      * Field _nsPrefix.\r
46      */\r
47     private java.lang.String _nsPrefix;\r
48 \r
49     /**\r
50      * Field _nsURI.\r
51      */\r
52     private java.lang.String _nsURI;\r
53 \r
54     /**\r
55      * Field _xmlName.\r
56      */\r
57     private java.lang.String _xmlName;\r
58 \r
59 \r
60       //----------------/\r
61      //- Constructors -/\r
62     //----------------/\r
63 \r
64     public SequenceSetPropertiesDescriptor() {\r
65         super();\r
66         _nsURI = "www.vamsas.ac.uk/jalview/version2";\r
67         _xmlName = "sequenceSetProperties";\r
68         _elementDefinition = true;\r
69         org.exolab.castor.xml.util.XMLFieldDescriptorImpl  desc           = null;\r
70         org.exolab.castor.mapping.FieldHandler             handler        = null;\r
71         org.exolab.castor.xml.FieldValidator               fieldValidator = null;\r
72         //-- initialize attribute descriptors\r
73         \r
74         //-- _key\r
75         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.String.class, "_key", "key", org.exolab.castor.xml.NodeType.Attribute);\r
76         desc.setImmutable(true);\r
77         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
78             public java.lang.Object getValue( java.lang.Object object ) \r
79                 throws IllegalStateException\r
80             {\r
81                 SequenceSetProperties target = (SequenceSetProperties) object;\r
82                 return target.getKey();\r
83             }\r
84             public void setValue( java.lang.Object object, java.lang.Object value) \r
85                 throws IllegalStateException, IllegalArgumentException\r
86             {\r
87                 try {\r
88                     SequenceSetProperties target = (SequenceSetProperties) object;\r
89                     target.setKey( (java.lang.String) value);\r
90                 } catch (java.lang.Exception ex) {\r
91                     throw new IllegalStateException(ex.toString());\r
92                 }\r
93             }\r
94             public java.lang.Object newInstance(java.lang.Object parent) {\r
95                 return null;\r
96             }\r
97         };\r
98         desc.setHandler(handler);\r
99         desc.setMultivalued(false);\r
100         addFieldDescriptor(desc);\r
101         \r
102         //-- validation code for: _key\r
103         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
104         { //-- local scope\r
105             org.exolab.castor.xml.validators.StringValidator typeValidator;\r
106             typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
107             fieldValidator.setValidator(typeValidator);\r
108             typeValidator.setWhiteSpace("preserve");\r
109         }\r
110         desc.setValidator(fieldValidator);\r
111         //-- _value\r
112         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.String.class, "_value", "value", org.exolab.castor.xml.NodeType.Attribute);\r
113         desc.setImmutable(true);\r
114         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
115             public java.lang.Object getValue( java.lang.Object object ) \r
116                 throws IllegalStateException\r
117             {\r
118                 SequenceSetProperties target = (SequenceSetProperties) object;\r
119                 return target.getValue();\r
120             }\r
121             public void setValue( java.lang.Object object, java.lang.Object value) \r
122                 throws IllegalStateException, IllegalArgumentException\r
123             {\r
124                 try {\r
125                     SequenceSetProperties target = (SequenceSetProperties) object;\r
126                     target.setValue( (java.lang.String) value);\r
127                 } catch (java.lang.Exception ex) {\r
128                     throw new IllegalStateException(ex.toString());\r
129                 }\r
130             }\r
131             public java.lang.Object newInstance(java.lang.Object parent) {\r
132                 return null;\r
133             }\r
134         };\r
135         desc.setHandler(handler);\r
136         desc.setMultivalued(false);\r
137         addFieldDescriptor(desc);\r
138         \r
139         //-- validation code for: _value\r
140         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
141         { //-- local scope\r
142             org.exolab.castor.xml.validators.StringValidator typeValidator;\r
143             typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
144             fieldValidator.setValidator(typeValidator);\r
145             typeValidator.setWhiteSpace("preserve");\r
146         }\r
147         desc.setValidator(fieldValidator);\r
148         //-- initialize element descriptors\r
149         \r
150     }\r
151 \r
152 \r
153       //-----------/\r
154      //- Methods -/\r
155     //-----------/\r
156 \r
157     /**\r
158      * Method getAccessMode.\r
159      * \r
160      * @return the access mode specified for this class.\r
161      */\r
162     public org.exolab.castor.mapping.AccessMode getAccessMode(\r
163     ) {\r
164         return null;\r
165     }\r
166 \r
167     /**\r
168      * Method getIdentity.\r
169      * \r
170      * @return the identity field, null if this class has no\r
171      * identity.\r
172      */\r
173     public org.exolab.castor.mapping.FieldDescriptor getIdentity(\r
174     ) {\r
175         return super.getIdentity();\r
176     }\r
177 \r
178     /**\r
179      * Method getJavaClass.\r
180      * \r
181      * @return the Java class represented by this descriptor.\r
182      */\r
183     public java.lang.Class getJavaClass(\r
184     ) {\r
185         return jalview.schemabinding.version2.SequenceSetProperties.class;\r
186     }\r
187 \r
188     /**\r
189      * Method getNameSpacePrefix.\r
190      * \r
191      * @return the namespace prefix to use when marshaling as XML.\r
192      */\r
193     public java.lang.String getNameSpacePrefix(\r
194     ) {\r
195         return _nsPrefix;\r
196     }\r
197 \r
198     /**\r
199      * Method getNameSpaceURI.\r
200      * \r
201      * @return the namespace URI used when marshaling and\r
202      * unmarshaling as XML.\r
203      */\r
204     public java.lang.String getNameSpaceURI(\r
205     ) {\r
206         return _nsURI;\r
207     }\r
208 \r
209     /**\r
210      * Method getValidator.\r
211      * \r
212      * @return a specific validator for the class described by this\r
213      * ClassDescriptor.\r
214      */\r
215     public org.exolab.castor.xml.TypeValidator getValidator(\r
216     ) {\r
217         return this;\r
218     }\r
219 \r
220     /**\r
221      * Method getXMLName.\r
222      * \r
223      * @return the XML Name for the Class being described.\r
224      */\r
225     public java.lang.String getXMLName(\r
226     ) {\r
227         return _xmlName;\r
228     }\r
229 \r
230     /**\r
231      * Method isElementDefinition.\r
232      * \r
233      * @return true if XML schema definition of this Class is that\r
234      * of a global\r
235      * element or element with anonymous type definition.\r
236      */\r
237     public boolean isElementDefinition(\r
238     ) {\r
239         return _elementDefinition;\r
240     }\r
241 \r
242 }\r