extended Colour element with additional optional attributes for graduated colour
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / MappingDescriptor.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4.1)\r
3  * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
4  * \r
5  * This program is free software; you can redistribute it and/or\r
6  * modify it under the terms of the GNU General Public License\r
7  * as published by the Free Software Foundation; either version 2\r
8  * of the License, or (at your option) any later version.\r
9  * \r
10  * This program is distributed in the hope that it will be useful,\r
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
13  * GNU General Public License for more details.\r
14  * \r
15  * You should have received a copy of the GNU General Public License\r
16  * along with this program; if not, write to the Free Software\r
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
18  */\r
19 package jalview.schemabinding.version2.descriptors;\r
20 \r
21   //---------------------------------/\r
22  //- Imported classes and packages -/\r
23 //---------------------------------/\r
24 \r
25 import jalview.schemabinding.version2.Mapping;\r
26 \r
27 /**\r
28  * Class MappingDescriptor.\r
29  * \r
30  * @version $Revision$ $Date$\r
31  */\r
32 public class MappingDescriptor extends 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       //----------------/\r
61      //- Constructors -/\r
62     //----------------/\r
63 \r
64     public MappingDescriptor() {\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(jalview.schemabinding.version2.MappingChoice.class, "_mappingChoice", "-error-if-this-is-used-", org.exolab.castor.xml.NodeType.Element);\r
82         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
83             public java.lang.Object getValue( java.lang.Object object ) \r
84                 throws IllegalStateException\r
85             {\r
86                 Mapping target = (Mapping) object;\r
87                 return target.getMappingChoice();\r
88             }\r
89             public void setValue( java.lang.Object object, java.lang.Object value) \r
90                 throws IllegalStateException, IllegalArgumentException\r
91             {\r
92                 try {\r
93                     Mapping target = (Mapping) object;\r
94                     target.setMappingChoice( (jalview.schemabinding.version2.MappingChoice) value);\r
95                 } catch (java.lang.Exception ex) {\r
96                     throw new IllegalStateException(ex.toString());\r
97                 }\r
98             }\r
99             public java.lang.Object newInstance(java.lang.Object parent) {\r
100                 return new jalview.schemabinding.version2.MappingChoice();\r
101             }\r
102         };\r
103         desc.setHandler(handler);\r
104         desc.setContainer(true);\r
105         desc.setClassDescriptor(new jalview.schemabinding.version2.descriptors.MappingChoiceDescriptor());\r
106         desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");\r
107         desc.setMultivalued(false);\r
108         addFieldDescriptor(desc);\r
109         \r
110         //-- validation code for: _mappingChoice\r
111         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
112         { //-- local scope\r
113         }\r
114         desc.setValidator(fieldValidator);\r
115     }\r
116 \r
117 \r
118       //-----------/\r
119      //- Methods -/\r
120     //-----------/\r
121 \r
122     /**\r
123      * Method getAccessMode.\r
124      * \r
125      * @return the access mode specified for this class.\r
126      */\r
127     public org.exolab.castor.mapping.AccessMode getAccessMode(\r
128     ) {\r
129         return null;\r
130     }\r
131 \r
132     /**\r
133      * Method getIdentity.\r
134      * \r
135      * @return the identity field, null if this class has no\r
136      * identity.\r
137      */\r
138     public org.exolab.castor.mapping.FieldDescriptor getIdentity(\r
139     ) {\r
140         return super.getIdentity();\r
141     }\r
142 \r
143     /**\r
144      * Method getJavaClass.\r
145      * \r
146      * @return the Java class represented by this descriptor.\r
147      */\r
148     public java.lang.Class getJavaClass(\r
149     ) {\r
150         return jalview.schemabinding.version2.Mapping.class;\r
151     }\r
152 \r
153     /**\r
154      * Method getNameSpacePrefix.\r
155      * \r
156      * @return the namespace prefix to use when marshaling as XML.\r
157      */\r
158     public java.lang.String getNameSpacePrefix(\r
159     ) {\r
160         return _nsPrefix;\r
161     }\r
162 \r
163     /**\r
164      * Method getNameSpaceURI.\r
165      * \r
166      * @return the namespace URI used when marshaling and\r
167      * unmarshaling as XML.\r
168      */\r
169     public java.lang.String getNameSpaceURI(\r
170     ) {\r
171         return _nsURI;\r
172     }\r
173 \r
174     /**\r
175      * Method getValidator.\r
176      * \r
177      * @return a specific validator for the class described by this\r
178      * ClassDescriptor.\r
179      */\r
180     public org.exolab.castor.xml.TypeValidator getValidator(\r
181     ) {\r
182         return this;\r
183     }\r
184 \r
185     /**\r
186      * Method getXMLName.\r
187      * \r
188      * @return the XML Name for the Class being described.\r
189      */\r
190     public java.lang.String getXMLName(\r
191     ) {\r
192         return _xmlName;\r
193     }\r
194 \r
195     /**\r
196      * Method isElementDefinition.\r
197      * \r
198      * @return true if XML schema definition of this Class is that\r
199      * of a global\r
200      * element or element with anonymous type definition.\r
201      */\r
202     public boolean isElementDefinition(\r
203     ) {\r
204         return _elementDefinition;\r
205     }\r
206 \r
207 }\r