src/uk/ac/vamsas/objects/core/descriptors/VxrefDescriptor.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.Vxref;\r
  29 \r
  30 /**\r
  31  * Class VxrefDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class VxrefDescriptor extends\r
  36     uk.ac.vamsas.objects.core.descriptors.ReferenceTypeDescriptor {\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 VxrefDescriptor() {\r
  67     super();\r
  68     setExtendsWithoutFlatten(new uk.ac.vamsas.objects.core.descriptors.ReferenceTypeDescriptor());\r
  69     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  70     _xmlName = "vxref";\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     return null;\r
  85   }\r
  86 \r
  87   /**\r
  88    * Method getIdentity.\r
  89    * \r
  90    * @return the identity field, null if this class has no identity.\r
  91    */\r
  92   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
  93     return super.getIdentity();\r
  94   }\r
  95 \r
  96   /**\r
  97    * Method getJavaClass.\r
  98    * \r
  99    * @return the Java class represented by this descriptor.\r
 100    */\r
 101   public java.lang.Class getJavaClass() {\r
 102     return uk.ac.vamsas.objects.core.Vxref.class;\r
 103   }\r
 104 \r
 105   /**\r
 106    * Method getNameSpacePrefix.\r
 107    * \r
 108    * @return the namespace prefix to use when marshaling as XML.\r
 109    */\r
 110   public java.lang.String getNameSpacePrefix() {\r
 111     return _nsPrefix;\r
 112   }\r
 113 \r
 114   /**\r
 115    * Method getNameSpaceURI.\r
 116    * \r
 117    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 118    */\r
 119   public java.lang.String getNameSpaceURI() {\r
 120     return _nsURI;\r
 121   }\r
 122 \r
 123   /**\r
 124    * Method getValidator.\r
 125    * \r
 126    * @return a specific validator for the class described by this\r
 127    *         ClassDescriptor.\r
 128    */\r
 129   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 130     return this;\r
 131   }\r
 132 \r
 133   /**\r
 134    * Method getXMLName.\r
 135    * \r
 136    * @return the XML Name for the Class being described.\r
 137    */\r
 138   public java.lang.String getXMLName() {\r
 139     return _xmlName;\r
 140   }\r
 141 \r
 142   /**\r
 143    * Method isElementDefinition.\r
 144    * \r
 145    * @return true if XML schema definition of this Class is that of a global\r
 146    *         element or element with anonymous type definition.\r
 147    */\r
 148   public boolean isElementDefinition() {\r
 149     return _elementDefinition;\r
 150   }\r
 151 \r
 152 }\r