apply jalview code style
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / MappingDescriptor.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.Mapping;\r
25 \r
26 /**\r
27  * Class MappingDescriptor.\r
28  * \r
29  * @version $Revision$ $Date$\r
30  */\r
31 public class MappingDescriptor extends\r
32         jalview.schemabinding.version2.descriptors.MapListTypeDescriptor\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 MappingDescriptor()\r
64   {\r
65     super();\r
66     setExtendsWithoutFlatten(new jalview.schemabinding.version2.descriptors.MapListTypeDescriptor());\r
67     _nsURI = "www.vamsas.ac.uk/jalview/version2";\r
68     _xmlName = "Mapping";\r
69     _elementDefinition = true;\r
70 \r
71     // -- set grouping compositor\r
72     setCompositorAsChoice();\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     // -- _mappingChoice\r
81     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
82             jalview.schemabinding.version2.MappingChoice.class,\r
83             "_mappingChoice", "-error-if-this-is-used-",\r
84             org.exolab.castor.xml.NodeType.Element);\r
85     handler = new org.exolab.castor.xml.XMLFieldHandler()\r
86     {\r
87       public java.lang.Object getValue(java.lang.Object object)\r
88               throws IllegalStateException\r
89       {\r
90         Mapping target = (Mapping) object;\r
91         return target.getMappingChoice();\r
92       }\r
93 \r
94       public void setValue(java.lang.Object object, java.lang.Object value)\r
95               throws IllegalStateException, IllegalArgumentException\r
96       {\r
97         try\r
98         {\r
99           Mapping target = (Mapping) object;\r
100           target.setMappingChoice((jalview.schemabinding.version2.MappingChoice) 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 java.lang.Object newInstance(java.lang.Object parent)\r
108       {\r
109         return new jalview.schemabinding.version2.MappingChoice();\r
110       }\r
111     };\r
112     desc.setHandler(handler);\r
113     desc.setContainer(true);\r
114     desc.setClassDescriptor(new jalview.schemabinding.version2.descriptors.MappingChoiceDescriptor());\r
115     desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");\r
116     desc.setMultivalued(false);\r
117     addFieldDescriptor(desc);\r
118 \r
119     // -- validation code for: _mappingChoice\r
120     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
121     { // -- local scope\r
122     }\r
123     desc.setValidator(fieldValidator);\r
124   }\r
125 \r
126   // -----------/\r
127   // - Methods -/\r
128   // -----------/\r
129 \r
130   /**\r
131    * Method getAccessMode.\r
132    * \r
133    * @return the access mode specified for this class.\r
134    */\r
135   public org.exolab.castor.mapping.AccessMode getAccessMode()\r
136   {\r
137     return null;\r
138   }\r
139 \r
140   /**\r
141    * Method getIdentity.\r
142    * \r
143    * @return the identity field, null if this class has no identity.\r
144    */\r
145   public org.exolab.castor.mapping.FieldDescriptor getIdentity()\r
146   {\r
147     return super.getIdentity();\r
148   }\r
149 \r
150   /**\r
151    * Method getJavaClass.\r
152    * \r
153    * @return the Java class represented by this descriptor.\r
154    */\r
155   public java.lang.Class getJavaClass()\r
156   {\r
157     return jalview.schemabinding.version2.Mapping.class;\r
158   }\r
159 \r
160   /**\r
161    * Method getNameSpacePrefix.\r
162    * \r
163    * @return the namespace prefix to use when marshaling as XML.\r
164    */\r
165   public java.lang.String getNameSpacePrefix()\r
166   {\r
167     return _nsPrefix;\r
168   }\r
169 \r
170   /**\r
171    * Method getNameSpaceURI.\r
172    * \r
173    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
174    */\r
175   public java.lang.String getNameSpaceURI()\r
176   {\r
177     return _nsURI;\r
178   }\r
179 \r
180   /**\r
181    * Method getValidator.\r
182    * \r
183    * @return a specific validator for the class described by this\r
184    *         ClassDescriptor.\r
185    */\r
186   public org.exolab.castor.xml.TypeValidator getValidator()\r
187   {\r
188     return this;\r
189   }\r
190 \r
191   /**\r
192    * Method getXMLName.\r
193    * \r
194    * @return the XML Name for the Class being described.\r
195    */\r
196   public java.lang.String getXMLName()\r
197   {\r
198     return _xmlName;\r
199   }\r
200 \r
201   /**\r
202    * Method isElementDefinition.\r
203    * \r
204    * @return true if XML schema definition of this Class is that of a global\r
205    *         element or element with anonymous type definition.\r
206    */\r
207   public boolean isElementDefinition()\r
208   {\r
209     return _elementDefinition;\r
210   }\r
211 \r
212 }\r