Jalview 2.6 source licence
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / PdbentryItemDescriptor.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)\r
3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
4  * \r
5  * This file is part of Jalview.\r
6  * \r
7  * Jalview is free software: you can redistribute it and/or\r
8  * modify it under the terms of the GNU General Public License \r
9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
10  * \r
11  * Jalview is distributed in the hope that it will be useful, but \r
12  * WITHOUT ANY WARRANTY; without even the implied warranty \r
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
14  * PURPOSE.  See the GNU General Public License for more details.\r
15  * \r
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
17  */\r
18 package jalview.schemabinding.version2.descriptors;\r
19 \r
20 //---------------------------------/\r
21 //- Imported classes and packages -/\r
22 //---------------------------------/\r
23 \r
24 import jalview.schemabinding.version2.PdbentryItem;\r
25 \r
26 /**\r
27  * Class PdbentryItemDescriptor.\r
28  * \r
29  * @version $Revision$ $Date$\r
30  */\r
31 public class PdbentryItemDescriptor extends\r
32         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   // - Constructors -/\r
61   // ----------------/\r
62 \r
63   public PdbentryItemDescriptor()\r
64   {\r
65     super();\r
66     _nsURI = "www.jalview.org";\r
67     _xmlName = "pdbentry";\r
68     _elementDefinition = false;\r
69 \r
70     // -- set grouping compositor\r
71     setCompositorAsSequence();\r
72     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;\r
73     org.exolab.castor.mapping.FieldHandler handler = null;\r
74     org.exolab.castor.xml.FieldValidator fieldValidator = null;\r
75     // -- initialize attribute descriptors\r
76 \r
77     // -- initialize element descriptors\r
78 \r
79     // -- _propertyList\r
80     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
81             jalview.schemabinding.version2.Property.class, "_propertyList",\r
82             "property", org.exolab.castor.xml.NodeType.Element);\r
83     handler = new org.exolab.castor.xml.XMLFieldHandler()\r
84     {\r
85       public java.lang.Object getValue(java.lang.Object object)\r
86               throws IllegalStateException\r
87       {\r
88         PdbentryItem target = (PdbentryItem) object;\r
89         return target.getProperty();\r
90       }\r
91 \r
92       public void setValue(java.lang.Object object, java.lang.Object value)\r
93               throws IllegalStateException, IllegalArgumentException\r
94       {\r
95         try\r
96         {\r
97           PdbentryItem target = (PdbentryItem) object;\r
98           target\r
99                   .addProperty((jalview.schemabinding.version2.Property) value);\r
100         } catch (java.lang.Exception ex)\r
101         {\r
102           throw new IllegalStateException(ex.toString());\r
103         }\r
104       }\r
105 \r
106       public void resetValue(Object object) throws IllegalStateException,\r
107               IllegalArgumentException\r
108       {\r
109         try\r
110         {\r
111           PdbentryItem target = (PdbentryItem) object;\r
112           target.removeAllProperty();\r
113         } catch (java.lang.Exception ex)\r
114         {\r
115           throw new IllegalStateException(ex.toString());\r
116         }\r
117       }\r
118 \r
119       public java.lang.Object newInstance(java.lang.Object parent)\r
120       {\r
121         return new jalview.schemabinding.version2.Property();\r
122       }\r
123     };\r
124     desc.setHandler(handler);\r
125     desc.setNameSpaceURI("www.jalview.org");\r
126     desc.setMultivalued(true);\r
127     addFieldDescriptor(desc);\r
128 \r
129     // -- validation code for: _propertyList\r
130     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
131     fieldValidator.setMinOccurs(0);\r
132     { // -- local scope\r
133     }\r
134     desc.setValidator(fieldValidator);\r
135   }\r
136 \r
137   // -----------/\r
138   // - Methods -/\r
139   // -----------/\r
140 \r
141   /**\r
142    * Method getAccessMode.\r
143    * \r
144    * @return the access mode specified for this class.\r
145    */\r
146   public org.exolab.castor.mapping.AccessMode getAccessMode()\r
147   {\r
148     return null;\r
149   }\r
150 \r
151   /**\r
152    * Method getIdentity.\r
153    * \r
154    * @return the identity field, null if this class has no identity.\r
155    */\r
156   public org.exolab.castor.mapping.FieldDescriptor getIdentity()\r
157   {\r
158     return super.getIdentity();\r
159   }\r
160 \r
161   /**\r
162    * Method getJavaClass.\r
163    * \r
164    * @return the Java class represented by this descriptor.\r
165    */\r
166   public java.lang.Class getJavaClass()\r
167   {\r
168     return jalview.schemabinding.version2.PdbentryItem.class;\r
169   }\r
170 \r
171   /**\r
172    * Method getNameSpacePrefix.\r
173    * \r
174    * @return the namespace prefix to use when marshaling as XML.\r
175    */\r
176   public java.lang.String getNameSpacePrefix()\r
177   {\r
178     return _nsPrefix;\r
179   }\r
180 \r
181   /**\r
182    * Method getNameSpaceURI.\r
183    * \r
184    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
185    */\r
186   public java.lang.String getNameSpaceURI()\r
187   {\r
188     return _nsURI;\r
189   }\r
190 \r
191   /**\r
192    * Method getValidator.\r
193    * \r
194    * @return a specific validator for the class described by this\r
195    *         ClassDescriptor.\r
196    */\r
197   public org.exolab.castor.xml.TypeValidator getValidator()\r
198   {\r
199     return this;\r
200   }\r
201 \r
202   /**\r
203    * Method getXMLName.\r
204    * \r
205    * @return the XML Name for the Class being described.\r
206    */\r
207   public java.lang.String getXMLName()\r
208   {\r
209     return _xmlName;\r
210   }\r
211 \r
212   /**\r
213    * Method isElementDefinition.\r
214    * \r
215    * @return true if XML schema definition of this Class is that of a global\r
216    *         element or element with anonymous type definition.\r
217    */\r
218   public boolean isElementDefinition()\r
219   {\r
220     return _elementDefinition;\r
221   }\r
222 \r
223 }\r