JAL-1620 version bump and release notes
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / PdbidsDescriptor.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
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
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.schemabinding.version2.descriptors;
22
23 //---------------------------------/
24 //- Imported classes and packages -/
25 //---------------------------------/
26
27 import jalview.schemabinding.version2.Pdbids;
28
29 /**
30  * Class PdbidsDescriptor.
31  * 
32  * @version $Revision$ $Date$
33  */
34 public class PdbidsDescriptor extends
35         jalview.schemabinding.version2.descriptors.PdbentryDescriptor
36 {
37
38   // --------------------------/
39   // - Class/Member Variables -/
40   // --------------------------/
41
42   /**
43    * Field _elementDefinition.
44    */
45   private boolean _elementDefinition;
46
47   /**
48    * Field _nsPrefix.
49    */
50   private java.lang.String _nsPrefix;
51
52   /**
53    * Field _nsURI.
54    */
55   private java.lang.String _nsURI;
56
57   /**
58    * Field _xmlName.
59    */
60   private java.lang.String _xmlName;
61
62   // ----------------/
63   // - Constructors -/
64   // ----------------/
65
66   public PdbidsDescriptor()
67   {
68     super();
69     setExtendsWithoutFlatten(new jalview.schemabinding.version2.descriptors.PdbentryDescriptor());
70     _nsURI = "www.jalview.org";
71     _xmlName = "pdbids";
72     _elementDefinition = true;
73
74     // -- set grouping compositor
75     setCompositorAsSequence();
76     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
77     org.exolab.castor.mapping.FieldHandler handler = null;
78     org.exolab.castor.xml.FieldValidator fieldValidator = null;
79     // -- initialize attribute descriptors
80
81     // -- initialize element descriptors
82
83     // -- _structureStateList
84     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
85             jalview.schemabinding.version2.StructureState.class,
86             "_structureStateList", "structureState",
87             org.exolab.castor.xml.NodeType.Element);
88     handler = new org.exolab.castor.xml.XMLFieldHandler()
89     {
90       public java.lang.Object getValue(java.lang.Object object)
91               throws IllegalStateException
92       {
93         Pdbids target = (Pdbids) object;
94         return target.getStructureState();
95       }
96
97       public void setValue(java.lang.Object object, java.lang.Object value)
98               throws IllegalStateException, IllegalArgumentException
99       {
100         try
101         {
102           Pdbids target = (Pdbids) object;
103           target.addStructureState((jalview.schemabinding.version2.StructureState) value);
104         } catch (java.lang.Exception ex)
105         {
106           throw new IllegalStateException(ex.toString());
107         }
108       }
109
110       public void resetValue(Object object) throws IllegalStateException,
111               IllegalArgumentException
112       {
113         try
114         {
115           Pdbids target = (Pdbids) object;
116           target.removeAllStructureState();
117         } catch (java.lang.Exception ex)
118         {
119           throw new IllegalStateException(ex.toString());
120         }
121       }
122
123       public java.lang.Object newInstance(java.lang.Object parent)
124       {
125         return new jalview.schemabinding.version2.StructureState();
126       }
127     };
128     desc.setHandler(handler);
129     desc.setNameSpaceURI("www.jalview.org");
130     desc.setMultivalued(true);
131     addFieldDescriptor(desc);
132
133     // -- validation code for: _structureStateList
134     fieldValidator = new org.exolab.castor.xml.FieldValidator();
135     fieldValidator.setMinOccurs(0);
136     { // -- local scope
137     }
138     desc.setValidator(fieldValidator);
139   }
140
141   // -----------/
142   // - Methods -/
143   // -----------/
144
145   /**
146    * Method getAccessMode.
147    * 
148    * @return the access mode specified for this class.
149    */
150   public org.exolab.castor.mapping.AccessMode getAccessMode()
151   {
152     return null;
153   }
154
155   /**
156    * Method getIdentity.
157    * 
158    * @return the identity field, null if this class has no identity.
159    */
160   public org.exolab.castor.mapping.FieldDescriptor getIdentity()
161   {
162     return super.getIdentity();
163   }
164
165   /**
166    * Method getJavaClass.
167    * 
168    * @return the Java class represented by this descriptor.
169    */
170   public java.lang.Class getJavaClass()
171   {
172     return jalview.schemabinding.version2.Pdbids.class;
173   }
174
175   /**
176    * Method getNameSpacePrefix.
177    * 
178    * @return the namespace prefix to use when marshaling as XML.
179    */
180   public java.lang.String getNameSpacePrefix()
181   {
182     return _nsPrefix;
183   }
184
185   /**
186    * Method getNameSpaceURI.
187    * 
188    * @return the namespace URI used when marshaling and unmarshaling as XML.
189    */
190   public java.lang.String getNameSpaceURI()
191   {
192     return _nsURI;
193   }
194
195   /**
196    * Method getValidator.
197    * 
198    * @return a specific validator for the class described by this
199    *         ClassDescriptor.
200    */
201   public org.exolab.castor.xml.TypeValidator getValidator()
202   {
203     return this;
204   }
205
206   /**
207    * Method getXMLName.
208    * 
209    * @return the XML Name for the Class being described.
210    */
211   public java.lang.String getXMLName()
212   {
213     return _xmlName;
214   }
215
216   /**
217    * Method isElementDefinition.
218    * 
219    * @return true if XML schema definition of this Class is that of a global
220    *         element or element with anonymous type definition.
221    */
222   public boolean isElementDefinition()
223   {
224     return _elementDefinition;
225   }
226
227 }