src/uk/ac/vamsas/objects/core/descriptors/InstanceDescriptor.java

   1 /*\r
   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
   5  * \r
   6  * Earlier versions have also been incorporated into Jalview version 2.4 \r
   7  * since 2008, and TOPALi version 2 since 2007.\r
   8  * \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
  13  *  \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
  18  * \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
  21  */\r
  22 package uk.ac.vamsas.objects.core.descriptors;\r
  23 \r
  24 //---------------------------------/\r
  25 //- Imported classes and packages -/\r
  26 //---------------------------------/\r
  27 \r
  28 import uk.ac.vamsas.objects.core.Instance;\r
  29 \r
  30 /**\r
  31  * Class InstanceDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class InstanceDescriptor extends\r
  36     uk.ac.vamsas.objects.core.descriptors.AppDataDescriptor {\r
  37 \r
  38   // --------------------------/\r
  39   // - Class/Member Variables -/\r
  40   // --------------------------/\r
  41 \r
  42   /**\r
  43    * Field _elementDefinition.\r
  44    */\r
  45   private boolean _elementDefinition;\r
  46 \r
  47   /**\r
  48    * Field _nsPrefix.\r
  49    */\r
  50   private java.lang.String _nsPrefix;\r
  51 \r
  52   /**\r
  53    * Field _nsURI.\r
  54    */\r
  55   private java.lang.String _nsURI;\r
  56 \r
  57   /**\r
  58    * Field _xmlName.\r
  59    */\r
  60   private java.lang.String _xmlName;\r
  61 \r
  62   // ----------------/\r
  63   // - Constructors -/\r
  64   // ----------------/\r
  65 \r
  66   public InstanceDescriptor() {\r
  67     super();\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
  76 \r
  77     // -- _urn\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
  87       }\r
  88 \r
  89       public void setValue(java.lang.Object object, java.lang.Object value)\r
  90           throws IllegalStateException, IllegalArgumentException {\r
  91         try {\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
  96         }\r
  97       }\r
  98 \r
  99       public java.lang.Object newInstance(java.lang.Object parent) {\r
 100         return null;\r
 101       }\r
 102     };\r
 103     desc.setHandler(handler);\r
 104     desc.setRequired(true);\r
 105     desc.setMultivalued(false);\r
 106     addFieldDescriptor(desc);\r
 107 \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
 116     }\r
 117     desc.setValidator(fieldValidator);\r
 118     // -- initialize element descriptors\r
 119 \r
 120   }\r
 121 \r
 122   // -----------/\r
 123   // - Methods -/\r
 124   // -----------/\r
 125 \r
 126   /**\r
 127    * Method getAccessMode.\r
 128    * \r
 129    * @return the access mode specified for this class.\r
 130    */\r
 131   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 132     return null;\r
 133   }\r
 134 \r
 135   /**\r
 136    * Method getIdentity.\r
 137    * \r
 138    * @return the identity field, null if this class has no identity.\r
 139    */\r
 140   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 141     return super.getIdentity();\r
 142   }\r
 143 \r
 144   /**\r
 145    * Method getJavaClass.\r
 146    * \r
 147    * @return the Java class represented by this descriptor.\r
 148    */\r
 149   public java.lang.Class getJavaClass() {\r
 150     return uk.ac.vamsas.objects.core.Instance.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     return _nsPrefix;\r
 160   }\r
 161 \r
 162   /**\r
 163    * Method getNameSpaceURI.\r
 164    * \r
 165    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 166    */\r
 167   public java.lang.String getNameSpaceURI() {\r
 168     return _nsURI;\r
 169   }\r
 170 \r
 171   /**\r
 172    * Method getValidator.\r
 173    * \r
 174    * @return a specific validator for the class described by this\r
 175    *         ClassDescriptor.\r
 176    */\r
 177   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 178     return this;\r
 179   }\r
 180 \r
 181   /**\r
 182    * Method getXMLName.\r
 183    * \r
 184    * @return the XML Name for the Class being described.\r
 185    */\r
 186   public java.lang.String getXMLName() {\r
 187     return _xmlName;\r
 188   }\r
 189 \r
 190   /**\r
 191    * Method isElementDefinition.\r
 192    * \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
 195    */\r
 196   public boolean isElementDefinition() {\r
 197     return _elementDefinition;\r
 198   }\r
 199 \r
 200 }\r