Jalview 2.6 source licence
[jalview.git] / src / jalview / schemabinding / version2 / DBRef.java
index 7c98b4e..155d162 100644 (file)
 /*\r
- * This class was automatically generated with\r
- * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
- * Schema.\r
- * $Id$\r
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)\r
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
+ * \r
+ * This file is part of Jalview.\r
+ * \r
+ * Jalview is free software: you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License \r
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
+ * \r
+ * Jalview is distributed in the hope that it will be useful, but \r
+ * WITHOUT ANY WARRANTY; without even the implied warranty \r
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
+ * PURPOSE.  See the GNU General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  */\r
-\r
 package jalview.schemabinding.version2;\r
 \r
 //---------------------------------/\r
 //- Imported classes and packages -/\r
 //---------------------------------/\r
 \r
-import org.exolab.castor.xml.*;\r
+import org.exolab.castor.xml.Marshaller;\r
+import org.exolab.castor.xml.Unmarshaller;\r
 \r
 /**\r
  * Class DBRef.\r
- *\r
+ * \r
  * @version $Revision$ $Date$\r
  */\r
-public class DBRef\r
-    implements java.io.Serializable\r
+public class DBRef implements java.io.Serializable\r
 {\r
 \r
-  //--------------------------/\r
-  //- Class/Member Variables -/\r
-  //--------------------------/\r
+  // --------------------------/\r
+  // - Class/Member Variables -/\r
+  // --------------------------/\r
 \r
   /**\r
-   * Field _source\r
+   * Field _source.\r
    */\r
   private java.lang.String _source;\r
 \r
   /**\r
-   * Field _version\r
+   * Field _version.\r
    */\r
   private java.lang.String _version;\r
 \r
   /**\r
-   * Field _accessionId\r
+   * Field _accessionId.\r
    */\r
   private java.lang.String _accessionId;\r
 \r
-  //----------------/\r
-  //- Constructors -/\r
-  //----------------/\r
+  /**\r
+   * Field _mapping.\r
+   */\r
+  private jalview.schemabinding.version2.Mapping _mapping;\r
+\r
+  // ----------------/\r
+  // - Constructors -/\r
+  // ----------------/\r
 \r
   public DBRef()\r
   {\r
     super();\r
-  } //-- jalview.schemabinding.version2.DBRef()\r
+  }\r
 \r
-  //-----------/\r
-  //- Methods -/\r
-  //-----------/\r
+  // -----------/\r
+  // - Methods -/\r
+  // -----------/\r
 \r
   /**\r
    * Returns the value of field 'accessionId'.\r
-   *\r
-   * @return String\r
-   * @return the value of field 'accessionId'.\r
+   * \r
+   * @return the value of field 'AccessionId'.\r
    */\r
   public java.lang.String getAccessionId()\r
   {\r
     return this._accessionId;\r
-  } //-- java.lang.String getAccessionId()\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'mapping'.\r
+   * \r
+   * @return the value of field 'Mapping'.\r
+   */\r
+  public jalview.schemabinding.version2.Mapping getMapping()\r
+  {\r
+    return this._mapping;\r
+  }\r
 \r
   /**\r
    * Returns the value of field 'source'.\r
-   *\r
-   * @return String\r
-   * @return the value of field 'source'.\r
+   * \r
+   * @return the value of field 'Source'.\r
    */\r
   public java.lang.String getSource()\r
   {\r
     return this._source;\r
-  } //-- java.lang.String getSource()\r
+  }\r
 \r
   /**\r
    * Returns the value of field 'version'.\r
-   *\r
-   * @return String\r
-   * @return the value of field 'version'.\r
+   * \r
+   * @return the value of field 'Version'.\r
    */\r
   public java.lang.String getVersion()\r
   {\r
     return this._version;\r
-  } //-- java.lang.String getVersion()\r
+  }\r
 \r
   /**\r
-   * Method isValid\r
-   *\r
-   *\r
-   *\r
-   * @return boolean\r
+   * Method isValid.\r
+   * \r
+   * @return true if this object is valid according to the schema\r
    */\r
   public boolean isValid()\r
   {\r
     try\r
     {\r
       validate();\r
-    }\r
-    catch (org.exolab.castor.xml.ValidationException vex)\r
+    } catch (org.exolab.castor.xml.ValidationException vex)\r
     {\r
       return false;\r
     }\r
     return true;\r
-  } //-- boolean isValid()\r
+  }\r
 \r
   /**\r
-   * Method marshal\r
-   *\r
-   *\r
-   *\r
+   * \r
+   * \r
    * @param out\r
+   * @throws org.exolab.castor.xml.MarshalException\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
+   * @throws org.exolab.castor.xml.ValidationException\r
+   *           if this object is an invalid instance according to the schema\r
    */\r
-  public void marshal(java.io.Writer out)\r
-      throws org.exolab.castor.xml.MarshalException,\r
-      org.exolab.castor.xml.ValidationException\r
+  public void marshal(final java.io.Writer out)\r
+          throws org.exolab.castor.xml.MarshalException,\r
+          org.exolab.castor.xml.ValidationException\r
   {\r
-\r
     Marshaller.marshal(this, out);\r
-  } //-- void marshal(java.io.Writer)\r
+  }\r
 \r
   /**\r
-   * Method marshal\r
-   *\r
-   *\r
-   *\r
+   * \r
+   * \r
    * @param handler\r
+   * @throws java.io.IOException\r
+   *           if an IOException occurs during marshaling\r
+   * @throws org.exolab.castor.xml.ValidationException\r
+   *           if this object is an invalid instance according to the schema\r
+   * @throws org.exolab.castor.xml.MarshalException\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
    */\r
-  public void marshal(org.xml.sax.ContentHandler handler)\r
-      throws java.io.IOException, org.exolab.castor.xml.MarshalException,\r
-      org.exolab.castor.xml.ValidationException\r
+  public void marshal(final org.xml.sax.ContentHandler handler)\r
+          throws java.io.IOException,\r
+          org.exolab.castor.xml.MarshalException,\r
+          org.exolab.castor.xml.ValidationException\r
   {\r
-\r
     Marshaller.marshal(this, handler);\r
-  } //-- void marshal(org.xml.sax.ContentHandler)\r
+  }\r
 \r
   /**\r
    * Sets the value of field 'accessionId'.\r
-   *\r
-   * @param accessionId the value of field 'accessionId'.\r
+   * \r
+   * @param accessionId\r
+   *          the value of field 'accessionId'.\r
    */\r
-  public void setAccessionId(java.lang.String accessionId)\r
+  public void setAccessionId(final java.lang.String accessionId)\r
   {\r
     this._accessionId = accessionId;\r
-  } //-- void setAccessionId(java.lang.String)\r
+  }\r
+\r
+  /**\r
+   * Sets the value of field 'mapping'.\r
+   * \r
+   * @param mapping\r
+   *          the value of field 'mapping'.\r
+   */\r
+  public void setMapping(\r
+          final jalview.schemabinding.version2.Mapping mapping)\r
+  {\r
+    this._mapping = mapping;\r
+  }\r
 \r
   /**\r
    * Sets the value of field 'source'.\r
-   *\r
-   * @param source the value of field 'source'.\r
+   * \r
+   * @param source\r
+   *          the value of field 'source'.\r
    */\r
-  public void setSource(java.lang.String source)\r
+  public void setSource(final java.lang.String source)\r
   {\r
     this._source = source;\r
-  } //-- void setSource(java.lang.String)\r
+  }\r
 \r
   /**\r
    * Sets the value of field 'version'.\r
-   *\r
-   * @param version the value of field 'version'.\r
+   * \r
+   * @param version\r
+   *          the value of field 'version'.\r
    */\r
-  public void setVersion(java.lang.String version)\r
+  public void setVersion(final java.lang.String version)\r
   {\r
     this._version = version;\r
-  } //-- void setVersion(java.lang.String)\r
+  }\r
 \r
   /**\r
-   * Method unmarshal\r
-   *\r
-   *\r
-   *\r
+   * Method unmarshal.\r
+   * \r
    * @param reader\r
-   * @return Object\r
+   * @throws org.exolab.castor.xml.MarshalException\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
+   * @throws org.exolab.castor.xml.ValidationException\r
+   *           if this object is an invalid instance according to the schema\r
+   * @return the unmarshaled jalview.schemabinding.version2.DBRef\r
    */\r
-  public static java.lang.Object unmarshal(java.io.Reader reader)\r
-      throws org.exolab.castor.xml.MarshalException,\r
-      org.exolab.castor.xml.ValidationException\r
+  public static jalview.schemabinding.version2.DBRef unmarshal(\r
+          final java.io.Reader reader)\r
+          throws org.exolab.castor.xml.MarshalException,\r
+          org.exolab.castor.xml.ValidationException\r
   {\r
     return (jalview.schemabinding.version2.DBRef) Unmarshaller.unmarshal(\r
-        jalview.schemabinding.version2.DBRef.class, reader);\r
-  } //-- java.lang.Object unmarshal(java.io.Reader)\r
+            jalview.schemabinding.version2.DBRef.class, reader);\r
+  }\r
 \r
   /**\r
-   * Method validate\r
-   *\r
+   * \r
+   * \r
+   * @throws org.exolab.castor.xml.ValidationException\r
+   *           if this object is an invalid instance according to the schema\r
    */\r
-  public void validate()\r
-      throws org.exolab.castor.xml.ValidationException\r
+  public void validate() throws org.exolab.castor.xml.ValidationException\r
   {\r
-    org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.\r
-        Validator();\r
+    org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
     validator.validate(this);\r
-  } //-- void validate()\r
+  }\r
 \r
 }\r