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