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