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