src/uk/ac/vamsas/objects/core/descriptors/ProvenanceDescriptor.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.Provenance;\r
  29 \r
  30 /**\r
  31  * Class ProvenanceDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class ProvenanceDescriptor extends\r
  36     org.exolab.castor.xml.util.XMLClassDescriptorImpl {\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 ProvenanceDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "Provenance";\r
  70     _elementDefinition = true;\r
  71 \r
  72     // -- set grouping compositor\r
  73     setCompositorAsSequence();\r
  74     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;\r
  75     org.exolab.castor.mapping.FieldHandler handler = null;\r
  76     org.exolab.castor.xml.FieldValidator fieldValidator = null;\r
  77     // -- initialize attribute descriptors\r
  78 \r
  79     // -- initialize element descriptors\r
  80 \r
  81     // -- _entryList\r
  82     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  83         uk.ac.vamsas.objects.core.Entry.class, "_entryList", "entry",\r
  84         org.exolab.castor.xml.NodeType.Element);\r
  85     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
  86       public java.lang.Object getValue(java.lang.Object object)\r
  87           throws IllegalStateException {\r
  88         Provenance target = (Provenance) object;\r
  89         return target.getEntry();\r
  90       }\r
  91 \r
  92       public void setValue(java.lang.Object object, java.lang.Object value)\r
  93           throws IllegalStateException, IllegalArgumentException {\r
  94         try {\r
  95           Provenance target = (Provenance) object;\r
  96           target.addEntry((uk.ac.vamsas.objects.core.Entry) value);\r
  97         } catch (java.lang.Exception ex) {\r
  98           throw new IllegalStateException(ex.toString());\r
  99         }\r
 100       }\r
 101 \r
 102       public void resetValue(Object object) throws IllegalStateException,\r
 103           IllegalArgumentException {\r
 104         try {\r
 105           Provenance target = (Provenance) object;\r
 106           target.removeAllEntry();\r
 107         } catch (java.lang.Exception ex) {\r
 108           throw new IllegalStateException(ex.toString());\r
 109         }\r
 110       }\r
 111 \r
 112       public java.lang.Object newInstance(java.lang.Object parent) {\r
 113         return new uk.ac.vamsas.objects.core.Entry();\r
 114       }\r
 115     };\r
 116     desc.setHandler(handler);\r
 117     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 118     desc.setRequired(true);\r
 119     desc.setMultivalued(true);\r
 120     addFieldDescriptor(desc);\r
 121 \r
 122     // -- validation code for: _entryList\r
 123     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 124     fieldValidator.setMinOccurs(1);\r
 125     { // -- local scope\r
 126     }\r
 127     desc.setValidator(fieldValidator);\r
 128   }\r
 129 \r
 130   // -----------/\r
 131   // - Methods -/\r
 132   // -----------/\r
 133 \r
 134   /**\r
 135    * Method getAccessMode.\r
 136    * \r
 137    * @return the access mode specified for this class.\r
 138    */\r
 139   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 140     return null;\r
 141   }\r
 142 \r
 143   /**\r
 144    * Method getIdentity.\r
 145    * \r
 146    * @return the identity field, null if this class has no identity.\r
 147    */\r
 148   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 149     return super.getIdentity();\r
 150   }\r
 151 \r
 152   /**\r
 153    * Method getJavaClass.\r
 154    * \r
 155    * @return the Java class represented by this descriptor.\r
 156    */\r
 157   public java.lang.Class getJavaClass() {\r
 158     return uk.ac.vamsas.objects.core.Provenance.class;\r
 159   }\r
 160 \r
 161   /**\r
 162    * Method getNameSpacePrefix.\r
 163    * \r
 164    * @return the namespace prefix to use when marshaling as XML.\r
 165    */\r
 166   public java.lang.String getNameSpacePrefix() {\r
 167     return _nsPrefix;\r
 168   }\r
 169 \r
 170   /**\r
 171    * Method getNameSpaceURI.\r
 172    * \r
 173    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 174    */\r
 175   public java.lang.String getNameSpaceURI() {\r
 176     return _nsURI;\r
 177   }\r
 178 \r
 179   /**\r
 180    * Method getValidator.\r
 181    * \r
 182    * @return a specific validator for the class described by this\r
 183    *         ClassDescriptor.\r
 184    */\r
 185   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 186     return this;\r
 187   }\r
 188 \r
 189   /**\r
 190    * Method getXMLName.\r
 191    * \r
 192    * @return the XML Name for the Class being described.\r
 193    */\r
 194   public java.lang.String getXMLName() {\r
 195     return _xmlName;\r
 196   }\r
 197 \r
 198   /**\r
 199    * Method isElementDefinition.\r
 200    * \r
 201    * @return true if XML schema definition of this Class is that of a global\r
 202    *         element or element with anonymous type definition.\r
 203    */\r
 204   public boolean isElementDefinition() {\r
 205     return _elementDefinition;\r
 206   }\r
 207 \r
 208 }\r