2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
21 package jalview.schemabinding.version2;
23 //---------------------------------/
24 //- Imported classes and packages -/
25 //---------------------------------/
27 import org.exolab.castor.xml.Marshaller;
28 import org.exolab.castor.xml.Unmarshaller;
33 * @version $Revision$ $Date$
35 public class AlcodMap implements java.io.Serializable
38 // --------------------------/
39 // - Class/Member Variables -/
40 // --------------------------/
43 * internal jalview id for the dnasq for this mapping.
46 private java.lang.String _dnasq;
49 * a Mapping entry and an associated protein sequence
52 private jalview.schemabinding.version2.Mapping _mapping;
68 * Returns the value of field 'dnasq'. The field 'dnasq' has the following
69 * description: internal jalview id for the dnasq for this mapping.
72 * @return the value of field 'Dnasq'.
74 public java.lang.String getDnasq()
80 * Returns the value of field 'mapping'. The field 'mapping' has the following
81 * description: a Mapping entry and an associated protein sequence
84 * @return the value of field 'Mapping'.
86 public jalview.schemabinding.version2.Mapping getMapping()
94 * @return true if this object is valid according to the schema
96 public boolean isValid()
101 } catch (org.exolab.castor.xml.ValidationException vex)
112 * @throws org.exolab.castor.xml.MarshalException
113 * if object is null or if any SAXException is thrown during
115 * @throws org.exolab.castor.xml.ValidationException
116 * if this object is an invalid instance according to the schema
118 public void marshal(final java.io.Writer out)
119 throws org.exolab.castor.xml.MarshalException,
120 org.exolab.castor.xml.ValidationException
122 Marshaller.marshal(this, out);
129 * @throws java.io.IOException
130 * if an IOException occurs during marshaling
131 * @throws org.exolab.castor.xml.ValidationException
132 * if this object is an invalid instance according to the schema
133 * @throws org.exolab.castor.xml.MarshalException
134 * if object is null or if any SAXException is thrown during
137 public void marshal(final org.xml.sax.ContentHandler handler)
138 throws java.io.IOException,
139 org.exolab.castor.xml.MarshalException,
140 org.exolab.castor.xml.ValidationException
142 Marshaller.marshal(this, handler);
146 * Sets the value of field 'dnasq'. The field 'dnasq' has the following
147 * description: internal jalview id for the dnasq for this mapping.
151 * the value of field 'dnasq'.
153 public void setDnasq(final java.lang.String dnasq)
159 * Sets the value of field 'mapping'. The field 'mapping' has the following
160 * description: a Mapping entry and an associated protein sequence
164 * the value of field 'mapping'.
166 public void setMapping(
167 final jalview.schemabinding.version2.Mapping mapping)
169 this._mapping = mapping;
176 * @throws org.exolab.castor.xml.MarshalException
177 * if object is null or if any SAXException is thrown during
179 * @throws org.exolab.castor.xml.ValidationException
180 * if this object is an invalid instance according to the schema
181 * @return the unmarshaled jalview.schemabinding.version2.AlcodMap
183 public static jalview.schemabinding.version2.AlcodMap unmarshal(
184 final java.io.Reader reader)
185 throws org.exolab.castor.xml.MarshalException,
186 org.exolab.castor.xml.ValidationException
188 return (jalview.schemabinding.version2.AlcodMap) Unmarshaller
189 .unmarshal(jalview.schemabinding.version2.AlcodMap.class,
196 * @throws org.exolab.castor.xml.ValidationException
197 * if this object is an invalid instance according to the schema
199 public void validate() throws org.exolab.castor.xml.ValidationException
201 org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
202 validator.validate(this);