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