-/*\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
- */\r
-\r
-package jalview.binding;\r
-\r
- //---------------------------------/\r
- //- Imported classes and packages -/\r
-//---------------------------------/\r
-\r
-import java.io.IOException;\r
-import java.io.Reader;\r
-import java.io.Serializable;\r
-import java.io.Writer;\r
-import java.util.Enumeration;\r
-import java.util.Vector;\r
-import org.exolab.castor.xml.MarshalException;\r
-import org.exolab.castor.xml.Marshaller;\r
-import org.exolab.castor.xml.Unmarshaller;\r
-import org.exolab.castor.xml.ValidationException;\r
-import org.xml.sax.ContentHandler;\r
-\r
-/**\r
- * Class Annotation.\r
- * \r
- * @version $Revision$ $Date$\r
- */\r
-public class Annotation implements java.io.Serializable {\r
-\r
-\r
- //--------------------------/\r
- //- Class/Member Variables -/\r
- //--------------------------/\r
-\r
- /**\r
- * Field _graph\r
- */\r
- private boolean _graph;\r
-\r
- /**\r
- * keeps track of state for field: _graph\r
- */\r
- private boolean _has_graph;\r
-\r
- /**\r
- * Field _graphType\r
- */\r
- private int _graphType;\r
-\r
- /**\r
- * keeps track of state for field: _graphType\r
- */\r
- private boolean _has_graphType;\r
-\r
- /**\r
- * Field _annotationElementList\r
- */\r
- private java.util.Vector _annotationElementList;\r
-\r
- /**\r
- * Field _label\r
- */\r
- private java.lang.String _label;\r
-\r
- /**\r
- * Field _description\r
- */\r
- private java.lang.String _description;\r
-\r
-\r
- //----------------/\r
- //- Constructors -/\r
- //----------------/\r
-\r
- public Annotation() {\r
- super();\r
- _annotationElementList = new Vector();\r
- } //-- jalview.binding.Annotation()\r
-\r
-\r
- //-----------/\r
- //- Methods -/\r
- //-----------/\r
-\r
- /**\r
- * Method addAnnotationElement\r
- * \r
- * \r
- * \r
- * @param vAnnotationElement\r
- */\r
- public void addAnnotationElement(jalview.binding.AnnotationElement vAnnotationElement)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- _annotationElementList.addElement(vAnnotationElement);\r
- } //-- void addAnnotationElement(jalview.binding.AnnotationElement) \r
-\r
- /**\r
- * Method addAnnotationElement\r
- * \r
- * \r
- * \r
- * @param index\r
- * @param vAnnotationElement\r
- */\r
- public void addAnnotationElement(int index, jalview.binding.AnnotationElement vAnnotationElement)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- _annotationElementList.insertElementAt(vAnnotationElement, index);\r
- } //-- void addAnnotationElement(int, jalview.binding.AnnotationElement) \r
-\r
- /**\r
- * Method deleteGraph\r
- * \r
- */\r
- public void deleteGraph()\r
- {\r
- this._has_graph= false;\r
- } //-- void deleteGraph() \r
-\r
- /**\r
- * Method deleteGraphType\r
- * \r
- */\r
- public void deleteGraphType()\r
- {\r
- this._has_graphType= false;\r
- } //-- void deleteGraphType() \r
-\r
- /**\r
- * Method enumerateAnnotationElement\r
- * \r
- * \r
- * \r
- * @return Enumeration\r
- */\r
- public java.util.Enumeration enumerateAnnotationElement()\r
- {\r
- return _annotationElementList.elements();\r
- } //-- java.util.Enumeration enumerateAnnotationElement() \r
-\r
- /**\r
- * Method getAnnotationElement\r
- * \r
- * \r
- * \r
- * @param index\r
- * @return AnnotationElement\r
- */\r
- public jalview.binding.AnnotationElement getAnnotationElement(int index)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- //-- check bounds for index\r
- if ((index < 0) || (index > _annotationElementList.size())) {\r
- throw new IndexOutOfBoundsException();\r
- }\r
- \r
- return (jalview.binding.AnnotationElement) _annotationElementList.elementAt(index);\r
- } //-- jalview.binding.AnnotationElement getAnnotationElement(int) \r
-\r
- /**\r
- * Method getAnnotationElement\r
- * \r
- * \r
- * \r
- * @return AnnotationElement\r
- */\r
- public jalview.binding.AnnotationElement[] getAnnotationElement()\r
- {\r
- int size = _annotationElementList.size();\r
- jalview.binding.AnnotationElement[] mArray = new jalview.binding.AnnotationElement[size];\r
- for (int index = 0; index < size; index++) {\r
- mArray[index] = (jalview.binding.AnnotationElement) _annotationElementList.elementAt(index);\r
- }\r
- return mArray;\r
- } //-- jalview.binding.AnnotationElement[] getAnnotationElement() \r
-\r
- /**\r
- * Method getAnnotationElementCount\r
- * \r
- * \r
- * \r
- * @return int\r
- */\r
- public int getAnnotationElementCount()\r
- {\r
- return _annotationElementList.size();\r
- } //-- int getAnnotationElementCount() \r
-\r
- /**\r
- * Returns the value of field 'description'.\r
- * \r
- * @return String\r
- * @return the value of field 'description'.\r
- */\r
- public java.lang.String getDescription()\r
- {\r
- return this._description;\r
- } //-- java.lang.String getDescription() \r
-\r
- /**\r
- * Returns the value of field 'graph'.\r
- * \r
- * @return boolean\r
- * @return the value of field 'graph'.\r
- */\r
- public boolean getGraph()\r
- {\r
- return this._graph;\r
- } //-- boolean getGraph() \r
-\r
- /**\r
- * Returns the value of field 'graphType'.\r
- * \r
- * @return int\r
- * @return the value of field 'graphType'.\r
- */\r
- public int getGraphType()\r
- {\r
- return this._graphType;\r
- } //-- int getGraphType() \r
-\r
- /**\r
- * Returns the value of field 'label'.\r
- * \r
- * @return String\r
- * @return the value of field 'label'.\r
- */\r
- public java.lang.String getLabel()\r
- {\r
- return this._label;\r
- } //-- java.lang.String getLabel() \r
-\r
- /**\r
- * Method hasGraph\r
- * \r
- * \r
- * \r
- * @return boolean\r
- */\r
- public boolean hasGraph()\r
- {\r
- return this._has_graph;\r
- } //-- boolean hasGraph() \r
-\r
- /**\r
- * Method hasGraphType\r
- * \r
- * \r
- * \r
- * @return boolean\r
- */\r
- public boolean hasGraphType()\r
- {\r
- return this._has_graphType;\r
- } //-- boolean hasGraphType() \r
-\r
- /**\r
- * Method isValid\r
- * \r
- * \r
- * \r
- * @return boolean\r
- */\r
- public boolean isValid()\r
- {\r
- try {\r
- validate();\r
- }\r
- catch (org.exolab.castor.xml.ValidationException vex) {\r
- return false;\r
- }\r
- return true;\r
- } //-- boolean isValid() \r
-\r
- /**\r
- * Method marshal\r
- * \r
- * \r
- * \r
- * @param out\r
- */\r
- public void marshal(java.io.Writer out)\r
- throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
- {\r
- \r
- Marshaller.marshal(this, out);\r
- } //-- void marshal(java.io.Writer) \r
-\r
- /**\r
- * Method marshal\r
- * \r
- * \r
- * \r
- * @param handler\r
- */\r
- public void marshal(org.xml.sax.ContentHandler handler)\r
- throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
- {\r
- \r
- Marshaller.marshal(this, handler);\r
- } //-- void marshal(org.xml.sax.ContentHandler) \r
-\r
- /**\r
- * Method removeAllAnnotationElement\r
- * \r
- */\r
- public void removeAllAnnotationElement()\r
- {\r
- _annotationElementList.removeAllElements();\r
- } //-- void removeAllAnnotationElement() \r
-\r
- /**\r
- * Method removeAnnotationElement\r
- * \r
- * \r
- * \r
- * @param index\r
- * @return AnnotationElement\r
- */\r
- public jalview.binding.AnnotationElement removeAnnotationElement(int index)\r
- {\r
- java.lang.Object obj = _annotationElementList.elementAt(index);\r
- _annotationElementList.removeElementAt(index);\r
- return (jalview.binding.AnnotationElement) obj;\r
- } //-- jalview.binding.AnnotationElement removeAnnotationElement(int) \r
-\r
- /**\r
- * Method setAnnotationElement\r
- * \r
- * \r
- * \r
- * @param index\r
- * @param vAnnotationElement\r
- */\r
- public void setAnnotationElement(int index, jalview.binding.AnnotationElement vAnnotationElement)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- //-- check bounds for index\r
- if ((index < 0) || (index > _annotationElementList.size())) {\r
- throw new IndexOutOfBoundsException();\r
- }\r
- _annotationElementList.setElementAt(vAnnotationElement, index);\r
- } //-- void setAnnotationElement(int, jalview.binding.AnnotationElement) \r
-\r
- /**\r
- * Method setAnnotationElement\r
- * \r
- * \r
- * \r
- * @param annotationElementArray\r
- */\r
- public void setAnnotationElement(jalview.binding.AnnotationElement[] annotationElementArray)\r
- {\r
- //-- copy array\r
- _annotationElementList.removeAllElements();\r
- for (int i = 0; i < annotationElementArray.length; i++) {\r
- _annotationElementList.addElement(annotationElementArray[i]);\r
- }\r
- } //-- void setAnnotationElement(jalview.binding.AnnotationElement) \r
-\r
- /**\r
- * Sets the value of field 'description'.\r
- * \r
- * @param description the value of field 'description'.\r
- */\r
- public void setDescription(java.lang.String description)\r
- {\r
- this._description = description;\r
- } //-- void setDescription(java.lang.String) \r
-\r
- /**\r
- * Sets the value of field 'graph'.\r
- * \r
- * @param graph the value of field 'graph'.\r
- */\r
- public void setGraph(boolean graph)\r
- {\r
- this._graph = graph;\r
- this._has_graph = true;\r
- } //-- void setGraph(boolean) \r
-\r
- /**\r
- * Sets the value of field 'graphType'.\r
- * \r
- * @param graphType the value of field 'graphType'.\r
- */\r
- public void setGraphType(int graphType)\r
- {\r
- this._graphType = graphType;\r
- this._has_graphType = true;\r
- } //-- void setGraphType(int) \r
-\r
- /**\r
- * Sets the value of field 'label'.\r
- * \r
- * @param label the value of field 'label'.\r
- */\r
- public void setLabel(java.lang.String label)\r
- {\r
- this._label = label;\r
- } //-- void setLabel(java.lang.String) \r
-\r
- /**\r
- * Method unmarshal\r
- * \r
- * \r
- * \r
- * @param reader\r
- * @return Object\r
- */\r
- public static java.lang.Object unmarshal(java.io.Reader reader)\r
- throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
- {\r
- return (jalview.binding.Annotation) Unmarshaller.unmarshal(jalview.binding.Annotation.class, reader);\r
- } //-- java.lang.Object unmarshal(java.io.Reader) \r
-\r
- /**\r
- * Method validate\r
- * \r
- */\r
- public void validate()\r
- throws org.exolab.castor.xml.ValidationException\r
- {\r
- org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
- validator.validate(this);\r
- } //-- void validate() \r
-\r
-}\r
+/*******************************************************************************
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ *******************************************************************************/
+/*
+ * This class was automatically generated with
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
+ * Schema.
+ * $Id$
+ */
+
+package jalview.binding;
+
+ //---------------------------------/
+ //- Imported classes and packages -/
+//---------------------------------/
+
+import org.exolab.castor.xml.Marshaller;
+import org.exolab.castor.xml.Unmarshaller;
+
+/**
+ * Class Annotation.
+ *
+ * @version $Revision$ $Date$
+ */
+public class Annotation implements java.io.Serializable {
+
+
+ //--------------------------/
+ //- Class/Member Variables -/
+ //--------------------------/
+
+ /**
+ * Field _graph.
+ */
+ private boolean _graph;
+
+ /**
+ * keeps track of state for field: _graph
+ */
+ private boolean _has_graph;
+
+ /**
+ * Field _graphType.
+ */
+ private int _graphType;
+
+ /**
+ * keeps track of state for field: _graphType
+ */
+ private boolean _has_graphType;
+
+ /**
+ * Field _annotationElementList.
+ */
+ private java.util.Vector _annotationElementList;
+
+ /**
+ * Field _label.
+ */
+ private java.lang.String _label;
+
+ /**
+ * Field _description.
+ */
+ private java.lang.String _description;
+
+
+ //----------------/
+ //- Constructors -/
+ //----------------/
+
+ public Annotation() {
+ super();
+ this._annotationElementList = new java.util.Vector();
+ }
+
+
+ //-----------/
+ //- Methods -/
+ //-----------/
+
+ /**
+ *
+ *
+ * @param vAnnotationElement
+ * @throws java.lang.IndexOutOfBoundsException if the index
+ * given is outside the bounds of the collection
+ */
+ public void addAnnotationElement(
+ final jalview.binding.AnnotationElement vAnnotationElement)
+ throws java.lang.IndexOutOfBoundsException {
+ this._annotationElementList.addElement(vAnnotationElement);
+ }
+
+ /**
+ *
+ *
+ * @param index
+ * @param vAnnotationElement
+ * @throws java.lang.IndexOutOfBoundsException if the index
+ * given is outside the bounds of the collection
+ */
+ public void addAnnotationElement(
+ final int index,
+ final jalview.binding.AnnotationElement vAnnotationElement)
+ throws java.lang.IndexOutOfBoundsException {
+ this._annotationElementList.add(index, vAnnotationElement);
+ }
+
+ /**
+ */
+ public void deleteGraph(
+ ) {
+ this._has_graph= false;
+ }
+
+ /**
+ */
+ public void deleteGraphType(
+ ) {
+ this._has_graphType= false;
+ }
+
+ /**
+ * Method enumerateAnnotationElement.
+ *
+ * @return an Enumeration over all
+ * jalview.binding.AnnotationElement elements
+ */
+ public java.util.Enumeration enumerateAnnotationElement(
+ ) {
+ return this._annotationElementList.elements();
+ }
+
+ /**
+ * Method getAnnotationElement.
+ *
+ * @param index
+ * @throws java.lang.IndexOutOfBoundsException if the index
+ * given is outside the bounds of the collection
+ * @return the value of the jalview.binding.AnnotationElement
+ * at the given index
+ */
+ public jalview.binding.AnnotationElement getAnnotationElement(
+ final int index)
+ throws java.lang.IndexOutOfBoundsException {
+ // check bounds for index
+ if (index < 0 || index >= this._annotationElementList.size()) {
+ throw new IndexOutOfBoundsException("getAnnotationElement: Index value '" + index + "' not in range [0.." + (this._annotationElementList.size() - 1) + "]");
+ }
+
+ return (jalview.binding.AnnotationElement) _annotationElementList.get(index);
+ }
+
+ /**
+ * Method getAnnotationElement.Returns the contents of the
+ * collection in an Array. <p>Note: Just in case the
+ * collection contents are changing in another thread, we pass
+ * a 0-length Array of the correct type into the API call.
+ * This way we <i>know</i> that the Array returned is of
+ * exactly the correct length.
+ *
+ * @return this collection as an Array
+ */
+ public jalview.binding.AnnotationElement[] getAnnotationElement(
+ ) {
+ jalview.binding.AnnotationElement[] array = new jalview.binding.AnnotationElement[0];
+ return (jalview.binding.AnnotationElement[]) this._annotationElementList.toArray(array);
+ }
+
+ /**
+ * Method getAnnotationElementCount.
+ *
+ * @return the size of this collection
+ */
+ public int getAnnotationElementCount(
+ ) {
+ return this._annotationElementList.size();
+ }
+
+ /**
+ * Returns the value of field 'description'.
+ *
+ * @return the value of field 'Description'.
+ */
+ public java.lang.String getDescription(
+ ) {
+ return this._description;
+ }
+
+ /**
+ * Returns the value of field 'graph'.
+ *
+ * @return the value of field 'Graph'.
+ */
+ public boolean getGraph(
+ ) {
+ return this._graph;
+ }
+
+ /**
+ * Returns the value of field 'graphType'.
+ *
+ * @return the value of field 'GraphType'.
+ */
+ public int getGraphType(
+ ) {
+ return this._graphType;
+ }
+
+ /**
+ * Returns the value of field 'label'.
+ *
+ * @return the value of field 'Label'.
+ */
+ public java.lang.String getLabel(
+ ) {
+ return this._label;
+ }
+
+ /**
+ * Method hasGraph.
+ *
+ * @return true if at least one Graph has been added
+ */
+ public boolean hasGraph(
+ ) {
+ return this._has_graph;
+ }
+
+ /**
+ * Method hasGraphType.
+ *
+ * @return true if at least one GraphType has been added
+ */
+ public boolean hasGraphType(
+ ) {
+ return this._has_graphType;
+ }
+
+ /**
+ * Returns the value of field 'graph'.
+ *
+ * @return the value of field 'Graph'.
+ */
+ public boolean isGraph(
+ ) {
+ return this._graph;
+ }
+
+ /**
+ * Method isValid.
+ *
+ * @return true if this object is valid according to the schema
+ */
+ public boolean isValid(
+ ) {
+ try {
+ validate();
+ } catch (org.exolab.castor.xml.ValidationException vex) {
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ *
+ *
+ * @param out
+ * @throws org.exolab.castor.xml.MarshalException if object is
+ * null or if any SAXException is thrown during marshaling
+ * @throws org.exolab.castor.xml.ValidationException if this
+ * object is an invalid instance according to the schema
+ */
+ public void marshal(
+ final java.io.Writer out)
+ throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
+ Marshaller.marshal(this, out);
+ }
+
+ /**
+ *
+ *
+ * @param handler
+ * @throws java.io.IOException if an IOException occurs during
+ * marshaling
+ * @throws org.exolab.castor.xml.ValidationException if this
+ * object is an invalid instance according to the schema
+ * @throws org.exolab.castor.xml.MarshalException if object is
+ * null or if any SAXException is thrown during marshaling
+ */
+ public void marshal(
+ final org.xml.sax.ContentHandler handler)
+ throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
+ Marshaller.marshal(this, handler);
+ }
+
+ /**
+ */
+ public void removeAllAnnotationElement(
+ ) {
+ this._annotationElementList.clear();
+ }
+
+ /**
+ * Method removeAnnotationElement.
+ *
+ * @param vAnnotationElement
+ * @return true if the object was removed from the collection.
+ */
+ public boolean removeAnnotationElement(
+ final jalview.binding.AnnotationElement vAnnotationElement) {
+ boolean removed = _annotationElementList.remove(vAnnotationElement);
+ return removed;
+ }
+
+ /**
+ * Method removeAnnotationElementAt.
+ *
+ * @param index
+ * @return the element removed from the collection
+ */
+ public jalview.binding.AnnotationElement removeAnnotationElementAt(
+ final int index) {
+ java.lang.Object obj = this._annotationElementList.remove(index);
+ return (jalview.binding.AnnotationElement) obj;
+ }
+
+ /**
+ *
+ *
+ * @param index
+ * @param vAnnotationElement
+ * @throws java.lang.IndexOutOfBoundsException if the index
+ * given is outside the bounds of the collection
+ */
+ public void setAnnotationElement(
+ final int index,
+ final jalview.binding.AnnotationElement vAnnotationElement)
+ throws java.lang.IndexOutOfBoundsException {
+ // check bounds for index
+ if (index < 0 || index >= this._annotationElementList.size()) {
+ throw new IndexOutOfBoundsException("setAnnotationElement: Index value '" + index + "' not in range [0.." + (this._annotationElementList.size() - 1) + "]");
+ }
+
+ this._annotationElementList.set(index, vAnnotationElement);
+ }
+
+ /**
+ *
+ *
+ * @param vAnnotationElementArray
+ */
+ public void setAnnotationElement(
+ final jalview.binding.AnnotationElement[] vAnnotationElementArray) {
+ //-- copy array
+ _annotationElementList.clear();
+
+ for (int i = 0; i < vAnnotationElementArray.length; i++) {
+ this._annotationElementList.add(vAnnotationElementArray[i]);
+ }
+ }
+
+ /**
+ * Sets the value of field 'description'.
+ *
+ * @param description the value of field 'description'.
+ */
+ public void setDescription(
+ final java.lang.String description) {
+ this._description = description;
+ }
+
+ /**
+ * Sets the value of field 'graph'.
+ *
+ * @param graph the value of field 'graph'.
+ */
+ public void setGraph(
+ final boolean graph) {
+ this._graph = graph;
+ this._has_graph = true;
+ }
+
+ /**
+ * Sets the value of field 'graphType'.
+ *
+ * @param graphType the value of field 'graphType'.
+ */
+ public void setGraphType(
+ final int graphType) {
+ this._graphType = graphType;
+ this._has_graphType = true;
+ }
+
+ /**
+ * Sets the value of field 'label'.
+ *
+ * @param label the value of field 'label'.
+ */
+ public void setLabel(
+ final java.lang.String label) {
+ this._label = label;
+ }
+
+ /**
+ * Method unmarshal.
+ *
+ * @param reader
+ * @throws org.exolab.castor.xml.MarshalException if object is
+ * null or if any SAXException is thrown during marshaling
+ * @throws org.exolab.castor.xml.ValidationException if this
+ * object is an invalid instance according to the schema
+ * @return the unmarshaled jalview.binding.Annotation
+ */
+ public static jalview.binding.Annotation unmarshal(
+ final java.io.Reader reader)
+ throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
+ return (jalview.binding.Annotation) Unmarshaller.unmarshal(jalview.binding.Annotation.class, reader);
+ }
+
+ /**
+ *
+ *
+ * @throws org.exolab.castor.xml.ValidationException if this
+ * object is an invalid instance according to the schema
+ */
+ public void validate(
+ )
+ throws org.exolab.castor.xml.ValidationException {
+ org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
+ validator.validate(this);
+ }
+
+}
git://source.jalview.org / jalview.git / blobdiff