2 * This file is part of the Vamsas Client version 0.1.
\r
3 * Copyright 2009 by Jim Procter, Iain Milne, Pierre Marguerite,
\r
4 * Andrew Waterhouse and Dominik Lindner.
\r
6 * Earlier versions have also been incorporated into Jalview version 2.4
\r
7 * since 2008, and TOPALi version 2 since 2007.
\r
9 * The Vamsas Client is free software: you can redistribute it and/or modify
\r
10 * it under the terms of the GNU Lesser General Public License as published by
\r
11 * the Free Software Foundation, either version 3 of the License, or
\r
12 * (at your option) any later version.
\r
14 * The Vamsas Client is distributed in the hope that it will be useful,
\r
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
17 * GNU Lesser General Public License for more details.
\r
19 * You should have received a copy of the GNU Lesser General Public License
\r
20 * along with the Vamsas Client. If not, see <http://www.gnu.org/licenses/>.
\r
22 package uk.ac.vamsas.objects.core.descriptors;
\r
24 //---------------------------------/
\r
25 //- Imported classes and packages -/
\r
26 //---------------------------------/
\r
28 import uk.ac.vamsas.objects.core.Property;
\r
31 * Class PropertyDescriptor.
\r
33 * @version $Revision$ $Date$
\r
35 public class PropertyDescriptor extends
\r
36 org.exolab.castor.xml.util.XMLClassDescriptorImpl {
\r
38 // --------------------------/
\r
39 // - Class/Member Variables -/
\r
40 // --------------------------/
\r
43 * Field _elementDefinition.
\r
45 private boolean _elementDefinition;
\r
50 private java.lang.String _nsPrefix;
\r
55 private java.lang.String _nsURI;
\r
60 private java.lang.String _xmlName;
\r
62 // ----------------/
\r
63 // - Constructors -/
\r
64 // ----------------/
\r
66 public PropertyDescriptor() {
\r
68 _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";
\r
69 _xmlName = "property";
\r
70 _elementDefinition = true;
\r
71 org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
\r
72 org.exolab.castor.mapping.FieldHandler handler = null;
\r
73 org.exolab.castor.xml.FieldValidator fieldValidator = null;
\r
75 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
\r
76 java.lang.String.class, "_content", "PCDATA",
\r
77 org.exolab.castor.xml.NodeType.Text);
\r
78 desc.setImmutable(true);
\r
79 handler = new org.exolab.castor.xml.XMLFieldHandler() {
\r
80 public java.lang.Object getValue(java.lang.Object object)
\r
81 throws IllegalStateException {
\r
82 Property target = (Property) object;
\r
83 return target.getContent();
\r
86 public void setValue(java.lang.Object object, java.lang.Object value)
\r
87 throws IllegalStateException, IllegalArgumentException {
\r
89 Property target = (Property) object;
\r
90 target.setContent((java.lang.String) value);
\r
91 } catch (java.lang.Exception ex) {
\r
92 throw new IllegalStateException(ex.toString());
\r
96 public java.lang.Object newInstance(java.lang.Object parent) {
\r
100 desc.setHandler(handler);
\r
101 addFieldDescriptor(desc);
\r
103 // -- validation code for: _content
\r
104 fieldValidator = new org.exolab.castor.xml.FieldValidator();
\r
105 { // -- local scope
\r
106 org.exolab.castor.xml.validators.StringValidator typeValidator;
\r
107 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
\r
108 fieldValidator.setValidator(typeValidator);
\r
109 typeValidator.setWhiteSpace("preserve");
\r
111 desc.setValidator(fieldValidator);
\r
112 // -- initialize attribute descriptors
\r
115 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
\r
116 java.lang.String.class, "_name", "name",
\r
117 org.exolab.castor.xml.NodeType.Attribute);
\r
118 desc.setImmutable(true);
\r
119 handler = new org.exolab.castor.xml.XMLFieldHandler() {
\r
120 public java.lang.Object getValue(java.lang.Object object)
\r
121 throws IllegalStateException {
\r
122 Property target = (Property) object;
\r
123 return target.getName();
\r
126 public void setValue(java.lang.Object object, java.lang.Object value)
\r
127 throws IllegalStateException, IllegalArgumentException {
\r
129 Property target = (Property) object;
\r
130 target.setName((java.lang.String) value);
\r
131 } catch (java.lang.Exception ex) {
\r
132 throw new IllegalStateException(ex.toString());
\r
136 public java.lang.Object newInstance(java.lang.Object parent) {
\r
140 desc.setHandler(handler);
\r
141 desc.setRequired(true);
\r
142 desc.setMultivalued(false);
\r
143 addFieldDescriptor(desc);
\r
145 // -- validation code for: _name
\r
146 fieldValidator = new org.exolab.castor.xml.FieldValidator();
\r
147 fieldValidator.setMinOccurs(1);
\r
148 { // -- local scope
\r
149 org.exolab.castor.xml.validators.StringValidator typeValidator;
\r
150 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
\r
151 fieldValidator.setValidator(typeValidator);
\r
152 typeValidator.setWhiteSpace("preserve");
\r
154 desc.setValidator(fieldValidator);
\r
156 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
\r
157 java.lang.String.class, "_type", "type",
\r
158 org.exolab.castor.xml.NodeType.Attribute);
\r
159 desc.setImmutable(true);
\r
160 handler = new org.exolab.castor.xml.XMLFieldHandler() {
\r
161 public java.lang.Object getValue(java.lang.Object object)
\r
162 throws IllegalStateException {
\r
163 Property target = (Property) object;
\r
164 return target.getType();
\r
167 public void setValue(java.lang.Object object, java.lang.Object value)
\r
168 throws IllegalStateException, IllegalArgumentException {
\r
170 Property target = (Property) object;
\r
171 target.setType((java.lang.String) value);
\r
172 } catch (java.lang.Exception ex) {
\r
173 throw new IllegalStateException(ex.toString());
\r
177 public java.lang.Object newInstance(java.lang.Object parent) {
\r
181 desc.setHandler(handler);
\r
182 desc.setRequired(true);
\r
183 desc.setMultivalued(false);
\r
184 addFieldDescriptor(desc);
\r
186 // -- validation code for: _type
\r
187 fieldValidator = new org.exolab.castor.xml.FieldValidator();
\r
188 fieldValidator.setMinOccurs(1);
\r
189 { // -- local scope
\r
190 org.exolab.castor.xml.validators.StringValidator typeValidator;
\r
191 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
\r
192 fieldValidator.setValidator(typeValidator);
\r
193 typeValidator.setWhiteSpace("preserve");
\r
195 desc.setValidator(fieldValidator);
\r
196 // -- initialize element descriptors
\r
205 * Method getAccessMode.
\r
207 * @return the access mode specified for this class.
\r
209 public org.exolab.castor.mapping.AccessMode getAccessMode() {
\r
214 * Method getIdentity.
\r
216 * @return the identity field, null if this class has no identity.
\r
218 public org.exolab.castor.mapping.FieldDescriptor getIdentity() {
\r
219 return super.getIdentity();
\r
223 * Method getJavaClass.
\r
225 * @return the Java class represented by this descriptor.
\r
227 public java.lang.Class getJavaClass() {
\r
228 return uk.ac.vamsas.objects.core.Property.class;
\r
232 * Method getNameSpacePrefix.
\r
234 * @return the namespace prefix to use when marshaling as XML.
\r
236 public java.lang.String getNameSpacePrefix() {
\r
241 * Method getNameSpaceURI.
\r
243 * @return the namespace URI used when marshaling and unmarshaling as XML.
\r
245 public java.lang.String getNameSpaceURI() {
\r
250 * Method getValidator.
\r
252 * @return a specific validator for the class described by this
\r
255 public org.exolab.castor.xml.TypeValidator getValidator() {
\r
260 * Method getXMLName.
\r
262 * @return the XML Name for the Class being described.
\r
264 public java.lang.String getXMLName() {
\r
269 * Method isElementDefinition.
\r
271 * @return true if XML schema definition of this Class is that of a global
\r
272 * element or element with anonymous type definition.
\r
274 public boolean isElementDefinition() {
\r
275 return _elementDefinition;
\r