updatePDBEntry method to add any PDBEntry from the list of DBRefEntries
[jalview.git] / src / jalview / schemabinding / version2 / Sequence.java
index 993ad23..e606eeb 100755 (executable)
@@ -1,6 +1,6 @@
 /*\r
  * This class was automatically generated with \r
- * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
  * Schema.\r
  * $Id$\r
  */\r
@@ -11,17 +11,8 @@ package jalview.schemabinding.version2;
  //- 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 Sequence.\r
@@ -38,7 +29,14 @@ implements java.io.Serializable
     //--------------------------/\r
 \r
     /**\r
-     * Field _DBRefList\r
+     * dataset sequence id for this sequence. Will be created as\r
+     * union of sequences.\r
+     *  \r
+     */\r
+    private java.lang.String _dsseqid;\r
+\r
+    /**\r
+     * Field _DBRefList.\r
      */\r
     private java.util.Vector _DBRefList;\r
 \r
@@ -49,8 +47,8 @@ implements java.io.Serializable
 \r
     public Sequence() {\r
         super();\r
-        _DBRefList = new Vector();\r
-    } //-- jalview.schemabinding.version2.Sequence()\r
+        this._DBRefList = new java.util.Vector();\r
+    }\r
 \r
 \r
       //-----------/\r
@@ -58,219 +56,256 @@ implements java.io.Serializable
     //-----------/\r
 \r
     /**\r
-     * Method addDBRef\r
-     * \r
      * \r
      * \r
      * @param vDBRef\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
      */\r
-    public void addDBRef(jalview.schemabinding.version2.DBRef vDBRef)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        _DBRefList.addElement(vDBRef);\r
-    } //-- void addDBRef(jalview.schemabinding.version2.DBRef) \r
+    public void addDBRef(\r
+            final jalview.schemabinding.version2.DBRef vDBRef)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._DBRefList.addElement(vDBRef);\r
+    }\r
 \r
     /**\r
-     * Method addDBRef\r
-     * \r
      * \r
      * \r
      * @param index\r
      * @param vDBRef\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
      */\r
-    public void addDBRef(int index, jalview.schemabinding.version2.DBRef vDBRef)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        _DBRefList.insertElementAt(vDBRef, index);\r
-    } //-- void addDBRef(int, jalview.schemabinding.version2.DBRef) \r
+    public void addDBRef(\r
+            final int index,\r
+            final jalview.schemabinding.version2.DBRef vDBRef)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._DBRefList.add(index, vDBRef);\r
+    }\r
 \r
     /**\r
-     * Method enumerateDBRef\r
+     * Method enumerateDBRef.\r
      * \r
-     * \r
-     * \r
-     * @return Enumeration\r
+     * @return an Enumeration over all\r
+     * jalview.schemabinding.version2.DBRef elements\r
      */\r
-    public java.util.Enumeration enumerateDBRef()\r
-    {\r
-        return _DBRefList.elements();\r
-    } //-- java.util.Enumeration enumerateDBRef() \r
+    public java.util.Enumeration enumerateDBRef(\r
+    ) {\r
+        return this._DBRefList.elements();\r
+    }\r
 \r
     /**\r
-     * Method getDBRef\r
-     * \r
-     * \r
+     * Method getDBRef.\r
      * \r
      * @param index\r
-     * @return DBRef\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     * @return the value of the\r
+     * jalview.schemabinding.version2.DBRef at the given index\r
      */\r
-    public jalview.schemabinding.version2.DBRef getDBRef(int index)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        //-- check bounds for index\r
-        if ((index < 0) || (index > _DBRefList.size())) {\r
-            throw new IndexOutOfBoundsException();\r
+    public jalview.schemabinding.version2.DBRef getDBRef(\r
+            final int index)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._DBRefList.size()) {\r
+            throw new IndexOutOfBoundsException("getDBRef: Index value '" + index + "' not in range [0.." + (this._DBRefList.size() - 1) + "]");\r
         }\r
         \r
-        return (jalview.schemabinding.version2.DBRef) _DBRefList.elementAt(index);\r
-    } //-- jalview.schemabinding.version2.DBRef getDBRef(int) \r
+        return (jalview.schemabinding.version2.DBRef) _DBRefList.get(index);\r
+    }\r
 \r
     /**\r
-     * Method getDBRef\r
-     * \r
+     * Method getDBRef.Returns the contents of the collection in an\r
+     * Array.  <p>Note:  Just in case the collection contents are\r
+     * changing in another thread, we pass a 0-length Array of the\r
+     * correct type into the API call.  This way we <i>know</i>\r
+     * that the Array returned is of exactly the correct length.\r
      * \r
-     * \r
-     * @return DBRef\r
+     * @return this collection as an Array\r
      */\r
-    public jalview.schemabinding.version2.DBRef[] getDBRef()\r
-    {\r
-        int size = _DBRefList.size();\r
-        jalview.schemabinding.version2.DBRef[] mArray = new jalview.schemabinding.version2.DBRef[size];\r
-        for (int index = 0; index < size; index++) {\r
-            mArray[index] = (jalview.schemabinding.version2.DBRef) _DBRefList.elementAt(index);\r
-        }\r
-        return mArray;\r
-    } //-- jalview.schemabinding.version2.DBRef[] getDBRef() \r
+    public jalview.schemabinding.version2.DBRef[] getDBRef(\r
+    ) {\r
+        jalview.schemabinding.version2.DBRef[] array = new jalview.schemabinding.version2.DBRef[0];\r
+        return (jalview.schemabinding.version2.DBRef[]) this._DBRefList.toArray(array);\r
+    }\r
 \r
     /**\r
-     * Method getDBRefCount\r
-     * \r
+     * Method getDBRefCount.\r
      * \r
-     * \r
-     * @return int\r
+     * @return the size of this collection\r
      */\r
-    public int getDBRefCount()\r
-    {\r
-        return _DBRefList.size();\r
-    } //-- int getDBRefCount() \r
+    public int getDBRefCount(\r
+    ) {\r
+        return this._DBRefList.size();\r
+    }\r
 \r
     /**\r
-     * Method isValid\r
-     * \r
+     * Returns the value of field 'dsseqid'. The field 'dsseqid'\r
+     * has the following description: dataset sequence id for this\r
+     * sequence. Will be created as union of sequences.\r
+     *  \r
      * \r
+     * @return the value of field 'Dsseqid'.\r
+     */\r
+    public java.lang.String getDsseqid(\r
+    ) {\r
+        return this._dsseqid;\r
+    }\r
+\r
+    /**\r
+     * Method isValid.\r
      * \r
-     * @return boolean\r
+     * @return true if this object is valid according to the schema\r
      */\r
-    public boolean isValid()\r
-    {\r
+    public boolean isValid(\r
+    ) {\r
         try {\r
             validate();\r
-        }\r
-        catch (org.exolab.castor.xml.ValidationException vex) {\r
+        } catch (org.exolab.castor.xml.ValidationException vex) {\r
             return false;\r
         }\r
         return true;\r
-    } //-- boolean isValid() \r
+    }\r
 \r
     /**\r
-     * Method marshal\r
-     * \r
      * \r
      * \r
      * @param out\r
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * 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, org.exolab.castor.xml.ValidationException\r
-    {\r
-        \r
+    public void marshal(\r
+            final java.io.Writer out)\r
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
         Marshaller.marshal(this, out);\r
-    } //-- void marshal(java.io.Writer) \r
+    }\r
 \r
     /**\r
-     * Method marshal\r
-     * \r
      * \r
      * \r
      * @param handler\r
+     * @throws java.io.IOException if an IOException occurs during\r
+     * marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\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
+    public void marshal(\r
+            final org.xml.sax.ContentHandler handler)\r
+    throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
         Marshaller.marshal(this, handler);\r
-    } //-- void marshal(org.xml.sax.ContentHandler) \r
+    }\r
 \r
     /**\r
-     * Method removeAllDBRef\r
-     * \r
      */\r
-    public void removeAllDBRef()\r
-    {\r
-        _DBRefList.removeAllElements();\r
-    } //-- void removeAllDBRef() \r
+    public void removeAllDBRef(\r
+    ) {\r
+        this._DBRefList.clear();\r
+    }\r
 \r
     /**\r
-     * Method removeDBRef\r
-     * \r
+     * Method removeDBRef.\r
      * \r
+     * @param vDBRef\r
+     * @return true if the object was removed from the collection.\r
+     */\r
+    public boolean removeDBRef(\r
+            final jalview.schemabinding.version2.DBRef vDBRef) {\r
+        boolean removed = _DBRefList.remove(vDBRef);\r
+        return removed;\r
+    }\r
+\r
+    /**\r
+     * Method removeDBRefAt.\r
      * \r
      * @param index\r
-     * @return DBRef\r
+     * @return the element removed from the collection\r
      */\r
-    public jalview.schemabinding.version2.DBRef removeDBRef(int index)\r
-    {\r
-        java.lang.Object obj = _DBRefList.elementAt(index);\r
-        _DBRefList.removeElementAt(index);\r
+    public jalview.schemabinding.version2.DBRef removeDBRefAt(\r
+            final int index) {\r
+        java.lang.Object obj = this._DBRefList.remove(index);\r
         return (jalview.schemabinding.version2.DBRef) obj;\r
-    } //-- jalview.schemabinding.version2.DBRef removeDBRef(int) \r
+    }\r
 \r
     /**\r
-     * Method setDBRef\r
-     * \r
      * \r
      * \r
      * @param index\r
      * @param vDBRef\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
      */\r
-    public void setDBRef(int index, jalview.schemabinding.version2.DBRef vDBRef)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        //-- check bounds for index\r
-        if ((index < 0) || (index > _DBRefList.size())) {\r
-            throw new IndexOutOfBoundsException();\r
+    public void setDBRef(\r
+            final int index,\r
+            final jalview.schemabinding.version2.DBRef vDBRef)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._DBRefList.size()) {\r
+            throw new IndexOutOfBoundsException("setDBRef: Index value '" + index + "' not in range [0.." + (this._DBRefList.size() - 1) + "]");\r
         }\r
-        _DBRefList.setElementAt(vDBRef, index);\r
-    } //-- void setDBRef(int, jalview.schemabinding.version2.DBRef) \r
+        \r
+        this._DBRefList.set(index, vDBRef);\r
+    }\r
 \r
     /**\r
-     * Method setDBRef\r
-     * \r
      * \r
      * \r
-     * @param DBRefArray\r
+     * @param vDBRefArray\r
      */\r
-    public void setDBRef(jalview.schemabinding.version2.DBRef[] DBRefArray)\r
-    {\r
+    public void setDBRef(\r
+            final jalview.schemabinding.version2.DBRef[] vDBRefArray) {\r
         //-- copy array\r
-        _DBRefList.removeAllElements();\r
-        for (int i = 0; i < DBRefArray.length; i++) {\r
-            _DBRefList.addElement(DBRefArray[i]);\r
+        _DBRefList.clear();\r
+        \r
+        for (int i = 0; i < vDBRefArray.length; i++) {\r
+                this._DBRefList.add(vDBRefArray[i]);\r
         }\r
-    } //-- void setDBRef(jalview.schemabinding.version2.DBRef) \r
+    }\r
 \r
     /**\r
-     * Method unmarshal\r
-     * \r
+     * Sets the value of field 'dsseqid'. The field 'dsseqid' has\r
+     * the following description: dataset sequence id for this\r
+     * sequence. Will be created as union of sequences.\r
+     *  \r
      * \r
+     * @param dsseqid the value of field 'dsseqid'.\r
+     */\r
+    public void setDsseqid(\r
+            final java.lang.String dsseqid) {\r
+        this._dsseqid = dsseqid;\r
+    }\r
+\r
+    /**\r
+     * Method unmarshal.\r
      * \r
      * @param reader\r
-     * @return Object\r
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
+     * @return the unmarshaled\r
+     * jalview.schemabinding.version2.SequenceType\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.schemabinding.version2.Sequence) Unmarshaller.unmarshal(jalview.schemabinding.version2.Sequence.class, reader);\r
-    } //-- java.lang.Object unmarshal(java.io.Reader) \r
+    public static jalview.schemabinding.version2.SequenceType unmarshal(\r
+            final java.io.Reader reader)\r
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
+        return (jalview.schemabinding.version2.SequenceType) Unmarshaller.unmarshal(jalview.schemabinding.version2.Sequence.class, reader);\r
+    }\r
 \r
     /**\r
-     * Method validate\r
      * \r
+     * \r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
      */\r
-    public void validate()\r
-        throws org.exolab.castor.xml.ValidationException\r
-    {\r
+    public void validate(\r
+    )\r
+    throws org.exolab.castor.xml.ValidationException {\r
         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
         validator.validate(this);\r
-    } //-- void validate() \r
+    }\r
 \r
 }\r