Jalview 2.6 source licence
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / UserColourSchemeDescriptor.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.UserColourScheme;\r
25 \r
26 /**\r
27  * Class UserColourSchemeDescriptor.\r
28  * \r
29  * @version $Revision$ $Date$\r
30  */\r
31 public class UserColourSchemeDescriptor\r
32         extends\r
33         jalview.schemabinding.version2.descriptors.JalviewUserColoursDescriptor\r
34 {\r
35 \r
36   // --------------------------/\r
37   // - Class/Member Variables -/\r
38   // --------------------------/\r
39 \r
40   /**\r
41    * Field _elementDefinition.\r
42    */\r
43   private boolean _elementDefinition;\r
44 \r
45   /**\r
46    * Field _nsPrefix.\r
47    */\r
48   private java.lang.String _nsPrefix;\r
49 \r
50   /**\r
51    * Field _nsURI.\r
52    */\r
53   private java.lang.String _nsURI;\r
54 \r
55   /**\r
56    * Field _xmlName.\r
57    */\r
58   private java.lang.String _xmlName;\r
59 \r
60   // ----------------/\r
61   // - Constructors -/\r
62   // ----------------/\r
63 \r
64   public UserColourSchemeDescriptor()\r
65   {\r
66     super();\r
67     setExtendsWithoutFlatten(new jalview.schemabinding.version2.descriptors.JalviewUserColoursDescriptor());\r
68     _nsURI = "www.jalview.org";\r
69     _xmlName = "UserColourScheme";\r
70     _elementDefinition = true;\r
71   }\r
72 \r
73   // -----------/\r
74   // - Methods -/\r
75   // -----------/\r
76 \r
77   /**\r
78    * Method getAccessMode.\r
79    * \r
80    * @return the access mode specified for this class.\r
81    */\r
82   public org.exolab.castor.mapping.AccessMode getAccessMode()\r
83   {\r
84     return null;\r
85   }\r
86 \r
87   /**\r
88    * Method getIdentity.\r
89    * \r
90    * @return the identity field, null if this class has no identity.\r
91    */\r
92   public org.exolab.castor.mapping.FieldDescriptor getIdentity()\r
93   {\r
94     return super.getIdentity();\r
95   }\r
96 \r
97   /**\r
98    * Method getJavaClass.\r
99    * \r
100    * @return the Java class represented by this descriptor.\r
101    */\r
102   public java.lang.Class getJavaClass()\r
103   {\r
104     return jalview.schemabinding.version2.UserColourScheme.class;\r
105   }\r
106 \r
107   /**\r
108    * Method getNameSpacePrefix.\r
109    * \r
110    * @return the namespace prefix to use when marshaling as XML.\r
111    */\r
112   public java.lang.String getNameSpacePrefix()\r
113   {\r
114     return _nsPrefix;\r
115   }\r
116 \r
117   /**\r
118    * Method getNameSpaceURI.\r
119    * \r
120    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
121    */\r
122   public java.lang.String getNameSpaceURI()\r
123   {\r
124     return _nsURI;\r
125   }\r
126 \r
127   /**\r
128    * Method getValidator.\r
129    * \r
130    * @return a specific validator for the class described by this\r
131    *         ClassDescriptor.\r
132    */\r
133   public org.exolab.castor.xml.TypeValidator getValidator()\r
134   {\r
135     return this;\r
136   }\r
137 \r
138   /**\r
139    * Method getXMLName.\r
140    * \r
141    * @return the XML Name for the Class being described.\r
142    */\r
143   public java.lang.String getXMLName()\r
144   {\r
145     return _xmlName;\r
146   }\r
147 \r
148   /**\r
149    * Method isElementDefinition.\r
150    * \r
151    * @return true if XML schema definition of this Class is that of a global\r
152    *         element or element with anonymous type definition.\r
153    */\r
154   public boolean isElementDefinition()\r
155   {\r
156     return _elementDefinition;\r
157   }\r
158 \r
159 }\r