src/jalview/schemabinding/version2/AlcodMap.java

   1 /*******************************************************************************
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, 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 /*
  19  * This class was automatically generated with
  20  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
  21  * Schema.
  22  * $Id$
  23  */
  24
  25 package jalview.schemabinding.version2;
  26
  27   //---------------------------------/
  28  //- Imported classes and packages -/
  29 //---------------------------------/
  30
  31 import org.exolab.castor.xml.Marshaller;
  32 import org.exolab.castor.xml.Unmarshaller;
  33
  34 /**
  35  * Class AlcodMap.
  36  *
  37  * @version $Revision$ $Date$
  38  */
  39 public class AlcodMap implements java.io.Serializable {
  40
  41
  42       //--------------------------/
  43      //- Class/Member Variables -/
  44     //--------------------------/
  45
  46     /**
  47      * internal jalview id for the dnasq for this mapping.
  48      *
  49      */
  50     private java.lang.String _dnasq;
  51
  52     /**
  53      * a Mapping entry and an associated protein sequence
  54      *
  55      */
  56     private jalview.schemabinding.version2.Mapping _mapping;
  57
  58
  59       //----------------/
  60      //- Constructors -/
  61     //----------------/
  62
  63     public AlcodMap() {
  64         super();
  65     }
  66
  67
  68       //-----------/
  69      //- Methods -/
  70     //-----------/
  71
  72     /**
  73      * Returns the value of field 'dnasq'. The field 'dnasq' has
  74      * the following description: internal jalview id for the dnasq
  75      * for this mapping.
  76      *
  77      *
  78      * @return the value of field 'Dnasq'.
  79      */
  80     public java.lang.String getDnasq(
  81     ) {
  82         return this._dnasq;
  83     }
  84
  85     /**
  86      * Returns the value of field 'mapping'. The field 'mapping'
  87      * has the following description: a Mapping entry and an
  88      * associated protein sequence
  89      *
  90      *
  91      * @return the value of field 'Mapping'.
  92      */
  93     public jalview.schemabinding.version2.Mapping getMapping(
  94     ) {
  95         return this._mapping;
  96     }
  97
  98     /**
  99      * Method isValid.
 100      *
 101      * @return true if this object is valid according to the schema
 102      */
 103     public boolean isValid(
 104     ) {
 105         try {
 106             validate();
 107         } catch (org.exolab.castor.xml.ValidationException vex) {
 108             return false;
 109         }
 110         return true;
 111     }
 112
 113     /**
 114      *
 115      *
 116      * @param out
 117      * @throws org.exolab.castor.xml.MarshalException if object is
 118      * null or if any SAXException is thrown during marshaling
 119      * @throws org.exolab.castor.xml.ValidationException if this
 120      * object is an invalid instance according to the schema
 121      */
 122     public void marshal(
 123             final java.io.Writer out)
 124     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 125         Marshaller.marshal(this, out);
 126     }
 127
 128     /**
 129      *
 130      *
 131      * @param handler
 132      * @throws java.io.IOException if an IOException occurs during
 133      * marshaling
 134      * @throws org.exolab.castor.xml.ValidationException if this
 135      * object is an invalid instance according to the schema
 136      * @throws org.exolab.castor.xml.MarshalException if object is
 137      * null or if any SAXException is thrown during marshaling
 138      */
 139     public void marshal(
 140             final org.xml.sax.ContentHandler handler)
 141     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 142         Marshaller.marshal(this, handler);
 143     }
 144
 145     /**
 146      * Sets the value of field 'dnasq'. The field 'dnasq' has the
 147      * following description: internal jalview id for the dnasq for
 148      * this mapping.
 149      *
 150      *
 151      * @param dnasq the value of field 'dnasq'.
 152      */
 153     public void setDnasq(
 154             final java.lang.String dnasq) {
 155         this._dnasq = dnasq;
 156     }
 157
 158     /**
 159      * Sets the value of field 'mapping'. The field 'mapping' has
 160      * the following description: a Mapping entry and an associated
 161      * protein sequence
 162      *
 163      *
 164      * @param mapping the value of field 'mapping'.
 165      */
 166     public void setMapping(
 167             final jalview.schemabinding.version2.Mapping mapping) {
 168         this._mapping = mapping;
 169     }
 170
 171     /**
 172      * Method unmarshal.
 173      *
 174      * @param reader
 175      * @throws org.exolab.castor.xml.MarshalException if object is
 176      * null or if any SAXException is thrown during marshaling
 177      * @throws org.exolab.castor.xml.ValidationException if this
 178      * object is an invalid instance according to the schema
 179      * @return the unmarshaled
 180      * jalview.schemabinding.version2.AlcodMap
 181      */
 182     public static jalview.schemabinding.version2.AlcodMap unmarshal(
 183             final java.io.Reader reader)
 184     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 185         return (jalview.schemabinding.version2.AlcodMap) Unmarshaller.unmarshal(jalview.schemabinding.version2.AlcodMap.class, reader);
 186     }
 187
 188     /**
 189      *
 190      *
 191      * @throws org.exolab.castor.xml.ValidationException if this
 192      * object is an invalid instance according to the schema
 193      */
 194     public void validate(
 195     )
 196     throws org.exolab.castor.xml.ValidationException {
 197         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 198         validator.validate(this);
 199     }
 200
 201 }