src/jalview/schemabinding/version2/Mapping.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;
  20
  21 //---------------------------------/
  22 //- Imported classes and packages -/
  23 //---------------------------------/
  24
  25 import org.exolab.castor.xml.Marshaller;
  26 import org.exolab.castor.xml.Unmarshaller;
  27
  28 /**
  29  * Class Mapping.
  30  *
  31  * @version $Revision$ $Date$
  32  */
  33 public class Mapping extends jalview.schemabinding.version2.MapListType
  34         implements java.io.Serializable
  35 {
  36
  37   // --------------------------/
  38   // - Class/Member Variables -/
  39   // --------------------------/
  40
  41   /**
  42    * Internal choice value storage
  43    */
  44   private java.lang.Object _choiceValue;
  45
  46   /**
  47    * Field _mappingChoice.
  48    */
  49   private jalview.schemabinding.version2.MappingChoice _mappingChoice;
  50
  51   // ----------------/
  52   // - Constructors -/
  53   // ----------------/
  54
  55   public Mapping()
  56   {
  57     super();
  58   }
  59
  60   // -----------/
  61   // - Methods -/
  62   // -----------/
  63
  64   /**
  65    * Returns the value of field 'choiceValue'. The field 'choiceValue' has the
  66    * following description: Internal choice value storage
  67    *
  68    * @return the value of field 'ChoiceValue'.
  69    */
  70   public java.lang.Object getChoiceValue()
  71   {
  72     return this._choiceValue;
  73   }
  74
  75   /**
  76    * Returns the value of field 'mappingChoice'.
  77    *
  78    * @return the value of field 'MappingChoice'.
  79    */
  80   public jalview.schemabinding.version2.MappingChoice getMappingChoice()
  81   {
  82     return this._mappingChoice;
  83   }
  84
  85   /**
  86    * Method isValid.
  87    *
  88    * @return true if this object is valid according to the schema
  89    */
  90   public boolean isValid()
  91   {
  92     try
  93     {
  94       validate();
  95     } catch (org.exolab.castor.xml.ValidationException vex)
  96     {
  97       return false;
  98     }
  99     return true;
 100   }
 101
 102   /**
 103    *
 104    *
 105    * @param out
 106    * @throws org.exolab.castor.xml.MarshalException
 107    *           if object is null or if any SAXException is thrown during
 108    *           marshaling
 109    * @throws org.exolab.castor.xml.ValidationException
 110    *           if this object is an invalid instance according to the schema
 111    */
 112   public void marshal(final java.io.Writer out)
 113           throws org.exolab.castor.xml.MarshalException,
 114           org.exolab.castor.xml.ValidationException
 115   {
 116     Marshaller.marshal(this, out);
 117   }
 118
 119   /**
 120    *
 121    *
 122    * @param handler
 123    * @throws java.io.IOException
 124    *           if an IOException occurs during marshaling
 125    * @throws org.exolab.castor.xml.ValidationException
 126    *           if this object is an invalid instance according to the schema
 127    * @throws org.exolab.castor.xml.MarshalException
 128    *           if object is null or if any SAXException is thrown during
 129    *           marshaling
 130    */
 131   public void marshal(final org.xml.sax.ContentHandler handler)
 132           throws java.io.IOException,
 133           org.exolab.castor.xml.MarshalException,
 134           org.exolab.castor.xml.ValidationException
 135   {
 136     Marshaller.marshal(this, handler);
 137   }
 138
 139   /**
 140    * Sets the value of field 'mappingChoice'.
 141    *
 142    * @param mappingChoice
 143    *          the value of field 'mappingChoice'.
 144    */
 145   public void setMappingChoice(
 146           final jalview.schemabinding.version2.MappingChoice mappingChoice)
 147   {
 148     this._mappingChoice = mappingChoice;
 149     this._choiceValue = mappingChoice;
 150   }
 151
 152   /**
 153    * Method unmarshal.
 154    *
 155    * @param reader
 156    * @throws org.exolab.castor.xml.MarshalException
 157    *           if object is null or if any SAXException is thrown during
 158    *           marshaling
 159    * @throws org.exolab.castor.xml.ValidationException
 160    *           if this object is an invalid instance according to the schema
 161    * @return the unmarshaled jalview.schemabinding.version2.MapListType
 162    */
 163   public static jalview.schemabinding.version2.MapListType unmarshal(
 164           final java.io.Reader reader)
 165           throws org.exolab.castor.xml.MarshalException,
 166           org.exolab.castor.xml.ValidationException
 167   {
 168     return (jalview.schemabinding.version2.MapListType) Unmarshaller
 169             .unmarshal(jalview.schemabinding.version2.Mapping.class, reader);
 170   }
 171
 172   /**
 173    *
 174    *
 175    * @throws org.exolab.castor.xml.ValidationException
 176    *           if this object is an invalid instance according to the schema
 177    */
 178   public void validate() throws org.exolab.castor.xml.ValidationException
 179   {
 180     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 181     validator.validate(this);
 182   }
 183
 184 }