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.Instance;
\r
31 * Class InstanceDescriptor.
\r
33 * @version $Revision$ $Date$
\r
35 public class InstanceDescriptor extends
\r
36 uk.ac.vamsas.objects.core.descriptors.AppDataDescriptor {
\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 InstanceDescriptor() {
\r
68 setExtendsWithoutFlatten(new uk.ac.vamsas.objects.core.descriptors.AppDataDescriptor());
\r
69 _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";
\r
70 _xmlName = "Instance";
\r
71 _elementDefinition = true;
\r
72 org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
\r
73 org.exolab.castor.mapping.FieldHandler handler = null;
\r
74 org.exolab.castor.xml.FieldValidator fieldValidator = null;
\r
75 // -- initialize attribute descriptors
\r
78 desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
\r
79 java.lang.String.class, "_urn", "urn",
\r
80 org.exolab.castor.xml.NodeType.Attribute);
\r
81 desc.setImmutable(true);
\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 Instance target = (Instance) object;
\r
86 return target.getUrn();
\r
89 public void setValue(java.lang.Object object, java.lang.Object value)
\r
90 throws IllegalStateException, IllegalArgumentException {
\r
92 Instance target = (Instance) object;
\r
93 target.setUrn((java.lang.String) value);
\r
94 } catch (java.lang.Exception ex) {
\r
95 throw new IllegalStateException(ex.toString());
\r
99 public java.lang.Object newInstance(java.lang.Object parent) {
\r
103 desc.setHandler(handler);
\r
104 desc.setRequired(true);
\r
105 desc.setMultivalued(false);
\r
106 addFieldDescriptor(desc);
\r
108 // -- validation code for: _urn
\r
109 fieldValidator = new org.exolab.castor.xml.FieldValidator();
\r
110 fieldValidator.setMinOccurs(1);
\r
111 { // -- local scope
\r
112 org.exolab.castor.xml.validators.StringValidator typeValidator;
\r
113 typeValidator = new org.exolab.castor.xml.validators.StringValidator();
\r
114 fieldValidator.setValidator(typeValidator);
\r
115 typeValidator.setWhiteSpace("preserve");
\r
117 desc.setValidator(fieldValidator);
\r
118 // -- initialize element descriptors
\r
127 * Method getAccessMode.
\r
129 * @return the access mode specified for this class.
\r
131 public org.exolab.castor.mapping.AccessMode getAccessMode() {
\r
136 * Method getIdentity.
\r
138 * @return the identity field, null if this class has no identity.
\r
140 public org.exolab.castor.mapping.FieldDescriptor getIdentity() {
\r
141 return super.getIdentity();
\r
145 * Method getJavaClass.
\r
147 * @return the Java class represented by this descriptor.
\r
149 public java.lang.Class getJavaClass() {
\r
150 return uk.ac.vamsas.objects.core.Instance.class;
\r
154 * Method getNameSpacePrefix.
\r
156 * @return the namespace prefix to use when marshaling as XML.
\r
158 public java.lang.String getNameSpacePrefix() {
\r
163 * Method getNameSpaceURI.
\r
165 * @return the namespace URI used when marshaling and unmarshaling as XML.
\r
167 public java.lang.String getNameSpaceURI() {
\r
172 * Method getValidator.
\r
174 * @return a specific validator for the class described by this
\r
177 public org.exolab.castor.xml.TypeValidator getValidator() {
\r
182 * Method getXMLName.
\r
184 * @return the XML Name for the Class being described.
\r
186 public java.lang.String getXMLName() {
\r
191 * Method isElementDefinition.
\r
193 * @return true if XML schema definition of this Class is that of a global
\r
194 * element or element with anonymous type definition.
\r
196 public boolean isElementDefinition() {
\r
197 return _elementDefinition;
\r