src/jalview/schemabinding/version2/descriptors/MappingDescriptor.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.schemabinding.version2.descriptors;
  20
  21 //---------------------------------/
  22 //- Imported classes and packages -/
  23 //---------------------------------/
  24
  25 import jalview.schemabinding.version2.Mapping;
  26
  27 /**
  28  * Class MappingDescriptor.
  29  *
  30  * @version $Revision$ $Date$
  31  */
  32 public class MappingDescriptor extends
  33         jalview.schemabinding.version2.descriptors.MapListTypeDescriptor
  34 {
  35
  36   // --------------------------/
  37   // - Class/Member Variables -/
  38   // --------------------------/
  39
  40   /**
  41    * Field _elementDefinition.
  42    */
  43   private boolean _elementDefinition;
  44
  45   /**
  46    * Field _nsPrefix.
  47    */
  48   private java.lang.String _nsPrefix;
  49
  50   /**
  51    * Field _nsURI.
  52    */
  53   private java.lang.String _nsURI;
  54
  55   /**
  56    * Field _xmlName.
  57    */
  58   private java.lang.String _xmlName;
  59
  60   // ----------------/
  61   // - Constructors -/
  62   // ----------------/
  63
  64   public MappingDescriptor()
  65   {
  66     super();
  67     setExtendsWithoutFlatten(new jalview.schemabinding.version2.descriptors.MapListTypeDescriptor());
  68     _nsURI = "www.vamsas.ac.uk/jalview/version2";
  69     _xmlName = "Mapping";
  70     _elementDefinition = true;
  71
  72     // -- set grouping compositor
  73     setCompositorAsChoice();
  74     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
  75     org.exolab.castor.mapping.FieldHandler handler = null;
  76     org.exolab.castor.xml.FieldValidator fieldValidator = null;
  77     // -- initialize attribute descriptors
  78
  79     // -- initialize element descriptors
  80
  81     // -- _mappingChoice
  82     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
  83             jalview.schemabinding.version2.MappingChoice.class,
  84             "_mappingChoice", "-error-if-this-is-used-",
  85             org.exolab.castor.xml.NodeType.Element);
  86     handler = new org.exolab.castor.xml.XMLFieldHandler()
  87     {
  88       public java.lang.Object getValue(java.lang.Object object)
  89               throws IllegalStateException
  90       {
  91         Mapping target = (Mapping) object;
  92         return target.getMappingChoice();
  93       }
  94
  95       public void setValue(java.lang.Object object, java.lang.Object value)
  96               throws IllegalStateException, IllegalArgumentException
  97       {
  98         try
  99         {
 100           Mapping target = (Mapping) object;
 101           target.setMappingChoice((jalview.schemabinding.version2.MappingChoice) value);
 102         } catch (java.lang.Exception ex)
 103         {
 104           throw new IllegalStateException(ex.toString());
 105         }
 106       }
 107
 108       public java.lang.Object newInstance(java.lang.Object parent)
 109       {
 110         return new jalview.schemabinding.version2.MappingChoice();
 111       }
 112     };
 113     desc.setHandler(handler);
 114     desc.setContainer(true);
 115     desc.setClassDescriptor(new jalview.schemabinding.version2.descriptors.MappingChoiceDescriptor());
 116     desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");
 117     desc.setMultivalued(false);
 118     addFieldDescriptor(desc);
 119
 120     // -- validation code for: _mappingChoice
 121     fieldValidator = new org.exolab.castor.xml.FieldValidator();
 122     { // -- local scope
 123     }
 124     desc.setValidator(fieldValidator);
 125   }
 126
 127   // -----------/
 128   // - Methods -/
 129   // -----------/
 130
 131   /**
 132    * Method getAccessMode.
 133    *
 134    * @return the access mode specified for this class.
 135    */
 136   public org.exolab.castor.mapping.AccessMode getAccessMode()
 137   {
 138     return null;
 139   }
 140
 141   /**
 142    * Method getIdentity.
 143    *
 144    * @return the identity field, null if this class has no identity.
 145    */
 146   public org.exolab.castor.mapping.FieldDescriptor getIdentity()
 147   {
 148     return super.getIdentity();
 149   }
 150
 151   /**
 152    * Method getJavaClass.
 153    *
 154    * @return the Java class represented by this descriptor.
 155    */
 156   public java.lang.Class getJavaClass()
 157   {
 158     return jalview.schemabinding.version2.Mapping.class;
 159   }
 160
 161   /**
 162    * Method getNameSpacePrefix.
 163    *
 164    * @return the namespace prefix to use when marshaling as XML.
 165    */
 166   public java.lang.String getNameSpacePrefix()
 167   {
 168     return _nsPrefix;
 169   }
 170
 171   /**
 172    * Method getNameSpaceURI.
 173    *
 174    * @return the namespace URI used when marshaling and unmarshaling as XML.
 175    */
 176   public java.lang.String getNameSpaceURI()
 177   {
 178     return _nsURI;
 179   }
 180
 181   /**
 182    * Method getValidator.
 183    *
 184    * @return a specific validator for the class described by this
 185    *         ClassDescriptor.
 186    */
 187   public org.exolab.castor.xml.TypeValidator getValidator()
 188   {
 189     return this;
 190   }
 191
 192   /**
 193    * Method getXMLName.
 194    *
 195    * @return the XML Name for the Class being described.
 196    */
 197   public java.lang.String getXMLName()
 198   {
 199     return _xmlName;
 200   }
 201
 202   /**
 203    * Method isElementDefinition.
 204    *
 205    * @return true if XML schema definition of this Class is that of a global
 206    *         element or element with anonymous type definition.
 207    */
 208   public boolean isElementDefinition()
 209   {
 210     return _elementDefinition;
 211   }
 212
 213 }