src/jalview/schemabinding/version2/DBRef.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
   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  */
  18 package jalview.schemabinding.version2;
  19
  20 //---------------------------------/
  21 //- Imported classes and packages -/
  22 //---------------------------------/
  23
  24 import org.exolab.castor.xml.Marshaller;
  25 import org.exolab.castor.xml.Unmarshaller;
  26
  27 /**
  28  * Class DBRef.
  29  *
  30  * @version $Revision$ $Date$
  31  */
  32 public class DBRef implements java.io.Serializable
  33 {
  34
  35   // --------------------------/
  36   // - Class/Member Variables -/
  37   // --------------------------/
  38
  39   /**
  40    * Field _source.
  41    */
  42   private java.lang.String _source;
  43
  44   /**
  45    * Field _version.
  46    */
  47   private java.lang.String _version;
  48
  49   /**
  50    * Field _accessionId.
  51    */
  52   private java.lang.String _accessionId;
  53
  54   /**
  55    * Field _mapping.
  56    */
  57   private jalview.schemabinding.version2.Mapping _mapping;
  58
  59   // ----------------/
  60   // - Constructors -/
  61   // ----------------/
  62
  63   public DBRef()
  64   {
  65     super();
  66   }
  67
  68   // -----------/
  69   // - Methods -/
  70   // -----------/
  71
  72   /**
  73    * Returns the value of field 'accessionId'.
  74    *
  75    * @return the value of field 'AccessionId'.
  76    */
  77   public java.lang.String getAccessionId()
  78   {
  79     return this._accessionId;
  80   }
  81
  82   /**
  83    * Returns the value of field 'mapping'.
  84    *
  85    * @return the value of field 'Mapping'.
  86    */
  87   public jalview.schemabinding.version2.Mapping getMapping()
  88   {
  89     return this._mapping;
  90   }
  91
  92   /**
  93    * Returns the value of field 'source'.
  94    *
  95    * @return the value of field 'Source'.
  96    */
  97   public java.lang.String getSource()
  98   {
  99     return this._source;
 100   }
 101
 102   /**
 103    * Returns the value of field 'version'.
 104    *
 105    * @return the value of field 'Version'.
 106    */
 107   public java.lang.String getVersion()
 108   {
 109     return this._version;
 110   }
 111
 112   /**
 113    * Method isValid.
 114    *
 115    * @return true if this object is valid according to the schema
 116    */
 117   public boolean isValid()
 118   {
 119     try
 120     {
 121       validate();
 122     } catch (org.exolab.castor.xml.ValidationException vex)
 123     {
 124       return false;
 125     }
 126     return true;
 127   }
 128
 129   /**
 130    *
 131    *
 132    * @param out
 133    * @throws org.exolab.castor.xml.MarshalException
 134    *           if object is null or if any SAXException is thrown during
 135    *           marshaling
 136    * @throws org.exolab.castor.xml.ValidationException
 137    *           if this object is an invalid instance according to the schema
 138    */
 139   public void marshal(final java.io.Writer out)
 140           throws org.exolab.castor.xml.MarshalException,
 141           org.exolab.castor.xml.ValidationException
 142   {
 143     Marshaller.marshal(this, out);
 144   }
 145
 146   /**
 147    *
 148    *
 149    * @param handler
 150    * @throws java.io.IOException
 151    *           if an IOException occurs during marshaling
 152    * @throws org.exolab.castor.xml.ValidationException
 153    *           if this object is an invalid instance according to the schema
 154    * @throws org.exolab.castor.xml.MarshalException
 155    *           if object is null or if any SAXException is thrown during
 156    *           marshaling
 157    */
 158   public void marshal(final org.xml.sax.ContentHandler handler)
 159           throws java.io.IOException,
 160           org.exolab.castor.xml.MarshalException,
 161           org.exolab.castor.xml.ValidationException
 162   {
 163     Marshaller.marshal(this, handler);
 164   }
 165
 166   /**
 167    * Sets the value of field 'accessionId'.
 168    *
 169    * @param accessionId
 170    *          the value of field 'accessionId'.
 171    */
 172   public void setAccessionId(final java.lang.String accessionId)
 173   {
 174     this._accessionId = accessionId;
 175   }
 176
 177   /**
 178    * Sets the value of field 'mapping'.
 179    *
 180    * @param mapping
 181    *          the value of field 'mapping'.
 182    */
 183   public void setMapping(
 184           final jalview.schemabinding.version2.Mapping mapping)
 185   {
 186     this._mapping = mapping;
 187   }
 188
 189   /**
 190    * Sets the value of field 'source'.
 191    *
 192    * @param source
 193    *          the value of field 'source'.
 194    */
 195   public void setSource(final java.lang.String source)
 196   {
 197     this._source = source;
 198   }
 199
 200   /**
 201    * Sets the value of field 'version'.
 202    *
 203    * @param version
 204    *          the value of field 'version'.
 205    */
 206   public void setVersion(final java.lang.String version)
 207   {
 208     this._version = version;
 209   }
 210
 211   /**
 212    * Method unmarshal.
 213    *
 214    * @param reader
 215    * @throws org.exolab.castor.xml.MarshalException
 216    *           if object is null or if any SAXException is thrown during
 217    *           marshaling
 218    * @throws org.exolab.castor.xml.ValidationException
 219    *           if this object is an invalid instance according to the schema
 220    * @return the unmarshaled jalview.schemabinding.version2.DBRef
 221    */
 222   public static jalview.schemabinding.version2.DBRef unmarshal(
 223           final java.io.Reader reader)
 224           throws org.exolab.castor.xml.MarshalException,
 225           org.exolab.castor.xml.ValidationException
 226   {
 227     return (jalview.schemabinding.version2.DBRef) Unmarshaller.unmarshal(
 228             jalview.schemabinding.version2.DBRef.class, reader);
 229   }
 230
 231   /**
 232    *
 233    *
 234    * @throws org.exolab.castor.xml.ValidationException
 235    *           if this object is an invalid instance according to the schema
 236    */
 237   public void validate() throws org.exolab.castor.xml.ValidationException
 238   {
 239     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 240     validator.validate(this);
 241   }
 242
 243 }