merge from 2_4_Release branch
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / PdbentryItemDescriptor.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)\r
3  * Copyright (C) 2008 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.PdbentryItem;\r
26 \r
27 /**\r
28  * Class PdbentryItemDescriptor.\r
29  * \r
30  * @version $Revision$ $Date$\r
31  */\r
32 public class PdbentryItemDescriptor extends\r
33         org.exolab.castor.xml.util.XMLClassDescriptorImpl\r
34 {\r
35 \r
36   // --------------------------/\r
37   // - Class/Member Variables -/\r
38   // --------------------------/\r
39 \r
40   /**\r
41    * Field _elementDefinition.\r
42    */\r
43   private boolean _elementDefinition;\r
44 \r
45   /**\r
46    * Field _nsPrefix.\r
47    */\r
48   private java.lang.String _nsPrefix;\r
49 \r
50   /**\r
51    * Field _nsURI.\r
52    */\r
53   private java.lang.String _nsURI;\r
54 \r
55   /**\r
56    * Field _xmlName.\r
57    */\r
58   private java.lang.String _xmlName;\r
59 \r
60   // ----------------/\r
61   // - Constructors -/\r
62   // ----------------/\r
63 \r
64   public PdbentryItemDescriptor()\r
65   {\r
66     super();\r
67     _nsURI = "www.jalview.org";\r
68     _xmlName = "pdbentry";\r
69     _elementDefinition = false;\r
70 \r
71     // -- set grouping compositor\r
72     setCompositorAsSequence();\r
73     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;\r
74     org.exolab.castor.mapping.FieldHandler handler = null;\r
75     org.exolab.castor.xml.FieldValidator fieldValidator = null;\r
76     // -- initialize attribute descriptors\r
77 \r
78     // -- initialize element descriptors\r
79 \r
80     // -- _propertyList\r
81     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
82             jalview.schemabinding.version2.Property.class, "_propertyList",\r
83             "property", org.exolab.castor.xml.NodeType.Element);\r
84     handler = new org.exolab.castor.xml.XMLFieldHandler()\r
85     {\r
86       public java.lang.Object getValue(java.lang.Object object)\r
87               throws IllegalStateException\r
88       {\r
89         PdbentryItem target = (PdbentryItem) object;\r
90         return target.getProperty();\r
91       }\r
92 \r
93       public void setValue(java.lang.Object object, java.lang.Object value)\r
94               throws IllegalStateException, IllegalArgumentException\r
95       {\r
96         try\r
97         {\r
98           PdbentryItem target = (PdbentryItem) object;\r
99           target\r
100                   .addProperty((jalview.schemabinding.version2.Property) value);\r
101         } catch (java.lang.Exception ex)\r
102         {\r
103           throw new IllegalStateException(ex.toString());\r
104         }\r
105       }\r
106 \r
107       public void resetValue(Object object) throws IllegalStateException,\r
108               IllegalArgumentException\r
109       {\r
110         try\r
111         {\r
112           PdbentryItem target = (PdbentryItem) object;\r
113           target.removeAllProperty();\r
114         } catch (java.lang.Exception ex)\r
115         {\r
116           throw new IllegalStateException(ex.toString());\r
117         }\r
118       }\r
119 \r
120       public java.lang.Object newInstance(java.lang.Object parent)\r
121       {\r
122         return new jalview.schemabinding.version2.Property();\r
123       }\r
124     };\r
125     desc.setHandler(handler);\r
126     desc.setNameSpaceURI("www.jalview.org");\r
127     desc.setMultivalued(true);\r
128     addFieldDescriptor(desc);\r
129 \r
130     // -- validation code for: _propertyList\r
131     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
132     fieldValidator.setMinOccurs(0);\r
133     { // -- local scope\r
134     }\r
135     desc.setValidator(fieldValidator);\r
136   }\r
137 \r
138   // -----------/\r
139   // - Methods -/\r
140   // -----------/\r
141 \r
142   /**\r
143    * Method getAccessMode.\r
144    * \r
145    * @return the access mode specified for this class.\r
146    */\r
147   public org.exolab.castor.mapping.AccessMode getAccessMode()\r
148   {\r
149     return null;\r
150   }\r
151 \r
152   /**\r
153    * Method getIdentity.\r
154    * \r
155    * @return the identity field, null if this class has no identity.\r
156    */\r
157   public org.exolab.castor.mapping.FieldDescriptor getIdentity()\r
158   {\r
159     return super.getIdentity();\r
160   }\r
161 \r
162   /**\r
163    * Method getJavaClass.\r
164    * \r
165    * @return the Java class represented by this descriptor.\r
166    */\r
167   public java.lang.Class getJavaClass()\r
168   {\r
169     return jalview.schemabinding.version2.PdbentryItem.class;\r
170   }\r
171 \r
172   /**\r
173    * Method getNameSpacePrefix.\r
174    * \r
175    * @return the namespace prefix to use when marshaling as XML.\r
176    */\r
177   public java.lang.String getNameSpacePrefix()\r
178   {\r
179     return _nsPrefix;\r
180   }\r
181 \r
182   /**\r
183    * Method getNameSpaceURI.\r
184    * \r
185    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
186    */\r
187   public java.lang.String getNameSpaceURI()\r
188   {\r
189     return _nsURI;\r
190   }\r
191 \r
192   /**\r
193    * Method getValidator.\r
194    * \r
195    * @return a specific validator for the class described by this\r
196    *         ClassDescriptor.\r
197    */\r
198   public org.exolab.castor.xml.TypeValidator getValidator()\r
199   {\r
200     return this;\r
201   }\r
202 \r
203   /**\r
204    * Method getXMLName.\r
205    * \r
206    * @return the XML Name for the Class being described.\r
207    */\r
208   public java.lang.String getXMLName()\r
209   {\r
210     return _xmlName;\r
211   }\r
212 \r
213   /**\r
214    * Method isElementDefinition.\r
215    * \r
216    * @return true if XML schema definition of this Class is that of a global\r
217    *         element or element with anonymous type definition.\r
218    */\r
219   public boolean isElementDefinition()\r
220   {\r
221     return _elementDefinition;\r
222   }\r
223 \r
224 }\r