updatePDBEntry method to add any PDBEntry from the list of DBRefEntries
[jalview.git] / src / jalview / schemabinding / version2 / Pdbentry.java
index 93c2748..6ff1819 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 Pdbentry.\r
@@ -36,22 +27,22 @@ public class Pdbentry implements java.io.Serializable {
     //--------------------------/\r
 \r
     /**\r
-     * Field _id\r
+     * Field _id.\r
      */\r
     private java.lang.String _id;\r
 \r
     /**\r
-     * Field _type\r
+     * Field _type.\r
      */\r
     private java.lang.String _type;\r
 \r
     /**\r
-     * Field _file\r
+     * Field _file.\r
      */\r
     private java.lang.String _file;\r
 \r
     /**\r
-     * Field _items\r
+     * Field _items.\r
      */\r
     private java.util.Vector _items;\r
 \r
@@ -62,8 +53,8 @@ public class Pdbentry implements java.io.Serializable {
 \r
     public Pdbentry() {\r
         super();\r
-        _items = new Vector();\r
-    } //-- jalview.schemabinding.version2.Pdbentry()\r
+        this._items = new java.util.Vector();\r
+    }\r
 \r
 \r
       //-----------/\r
@@ -71,282 +62,291 @@ public class Pdbentry implements java.io.Serializable {
     //-----------/\r
 \r
     /**\r
-     * Method addPdbentryItem\r
-     * \r
      * \r
      * \r
      * @param vPdbentryItem\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
      */\r
-    public void addPdbentryItem(jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        _items.addElement(vPdbentryItem);\r
-    } //-- void addPdbentryItem(jalview.schemabinding.version2.PdbentryItem) \r
+    public void addPdbentryItem(\r
+            final jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._items.addElement(vPdbentryItem);\r
+    }\r
 \r
     /**\r
-     * Method addPdbentryItem\r
-     * \r
      * \r
      * \r
      * @param index\r
      * @param vPdbentryItem\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
      */\r
-    public void addPdbentryItem(int index, jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        _items.insertElementAt(vPdbentryItem, index);\r
-    } //-- void addPdbentryItem(int, jalview.schemabinding.version2.PdbentryItem) \r
+    public void addPdbentryItem(\r
+            final int index,\r
+            final jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._items.add(index, vPdbentryItem);\r
+    }\r
 \r
     /**\r
-     * Method enumeratePdbentryItem\r
-     * \r
-     * \r
+     * Method enumeratePdbentryItem.\r
      * \r
-     * @return Enumeration\r
+     * @return an Enumeration over all\r
+     * jalview.schemabinding.version2.PdbentryItem elements\r
      */\r
-    public java.util.Enumeration enumeratePdbentryItem()\r
-    {\r
-        return _items.elements();\r
-    } //-- java.util.Enumeration enumeratePdbentryItem() \r
+    public java.util.Enumeration enumeratePdbentryItem(\r
+    ) {\r
+        return this._items.elements();\r
+    }\r
 \r
     /**\r
      * Returns the value of field 'file'.\r
      * \r
-     * @return String\r
-     * @return the value of field 'file'.\r
+     * @return the value of field 'File'.\r
      */\r
-    public java.lang.String getFile()\r
-    {\r
+    public java.lang.String getFile(\r
+    ) {\r
         return this._file;\r
-    } //-- java.lang.String getFile() \r
+    }\r
 \r
     /**\r
      * Returns the value of field 'id'.\r
      * \r
-     * @return String\r
-     * @return the value of field 'id'.\r
+     * @return the value of field 'Id'.\r
      */\r
-    public java.lang.String getId()\r
-    {\r
+    public java.lang.String getId(\r
+    ) {\r
         return this._id;\r
-    } //-- java.lang.String getId() \r
+    }\r
 \r
     /**\r
-     * Method getPdbentryItem\r
-     * \r
-     * \r
+     * Method getPdbentryItem.\r
      * \r
      * @param index\r
-     * @return PdbentryItem\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.PdbentryItem at the given inde\r
      */\r
-    public jalview.schemabinding.version2.PdbentryItem getPdbentryItem(int index)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        //-- check bounds for index\r
-        if ((index < 0) || (index > _items.size())) {\r
-            throw new IndexOutOfBoundsException();\r
+    public jalview.schemabinding.version2.PdbentryItem getPdbentryItem(\r
+            final int index)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._items.size()) {\r
+            throw new IndexOutOfBoundsException("getPdbentryItem: Index value '" + index + "' not in range [0.." + (this._items.size() - 1) + "]");\r
         }\r
         \r
-        return (jalview.schemabinding.version2.PdbentryItem) _items.elementAt(index);\r
-    } //-- jalview.schemabinding.version2.PdbentryItem getPdbentryItem(int) \r
+        return (jalview.schemabinding.version2.PdbentryItem) _items.get(index);\r
+    }\r
 \r
     /**\r
-     * Method getPdbentryItem\r
-     * \r
-     * \r
-     * \r
-     * @return PdbentryItem\r
+     * Method getPdbentryItem.Returns the contents of the\r
+     * collection in an Array.  <p>Note:  Just in case the\r
+     * collection contents are changing in another thread, we pass\r
+     * a 0-length Array of the correct type into the API call. \r
+     * This way we <i>know</i> that the Array returned is of\r
+     * exactly the correct length.\r
+     * \r
+     * @return this collection as an Array\r
      */\r
-    public jalview.schemabinding.version2.PdbentryItem[] getPdbentryItem()\r
-    {\r
-        int size = _items.size();\r
-        jalview.schemabinding.version2.PdbentryItem[] mArray = new jalview.schemabinding.version2.PdbentryItem[size];\r
-        for (int index = 0; index < size; index++) {\r
-            mArray[index] = (jalview.schemabinding.version2.PdbentryItem) _items.elementAt(index);\r
-        }\r
-        return mArray;\r
-    } //-- jalview.schemabinding.version2.PdbentryItem[] getPdbentryItem() \r
+    public jalview.schemabinding.version2.PdbentryItem[] getPdbentryItem(\r
+    ) {\r
+        jalview.schemabinding.version2.PdbentryItem[] array = new jalview.schemabinding.version2.PdbentryItem[0];\r
+        return (jalview.schemabinding.version2.PdbentryItem[]) this._items.toArray(array);\r
+    }\r
 \r
     /**\r
-     * Method getPdbentryItemCount\r
-     * \r
-     * \r
+     * Method getPdbentryItemCount.\r
      * \r
-     * @return int\r
+     * @return the size of this collection\r
      */\r
-    public int getPdbentryItemCount()\r
-    {\r
-        return _items.size();\r
-    } //-- int getPdbentryItemCount() \r
+    public int getPdbentryItemCount(\r
+    ) {\r
+        return this._items.size();\r
+    }\r
 \r
     /**\r
      * Returns the value of field 'type'.\r
      * \r
-     * @return String\r
-     * @return the value of field 'type'.\r
+     * @return the value of field 'Type'.\r
      */\r
-    public java.lang.String getType()\r
-    {\r
+    public java.lang.String getType(\r
+    ) {\r
         return this._type;\r
-    } //-- java.lang.String getType() \r
+    }\r
 \r
     /**\r
-     * Method isValid\r
+     * Method isValid.\r
      * \r
-     * \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 removeAllPdbentryItem\r
-     * \r
      */\r
-    public void removeAllPdbentryItem()\r
-    {\r
-        _items.removeAllElements();\r
-    } //-- void removeAllPdbentryItem() \r
+    public void removeAllPdbentryItem(\r
+    ) {\r
+        this._items.clear();\r
+    }\r
 \r
     /**\r
-     * Method removePdbentryItem\r
-     * \r
+     * Method removePdbentryItem.\r
      * \r
+     * @param vPdbentryItem\r
+     * @return true if the object was removed from the collection.\r
+     */\r
+    public boolean removePdbentryItem(\r
+            final jalview.schemabinding.version2.PdbentryItem vPdbentryItem) {\r
+        boolean removed = _items.remove(vPdbentryItem);\r
+        return removed;\r
+    }\r
+\r
+    /**\r
+     * Method removePdbentryItemAt.\r
      * \r
      * @param index\r
-     * @return PdbentryItem\r
+     * @return the element removed from the collection\r
      */\r
-    public jalview.schemabinding.version2.PdbentryItem removePdbentryItem(int index)\r
-    {\r
-        java.lang.Object obj = _items.elementAt(index);\r
-        _items.removeElementAt(index);\r
+    public jalview.schemabinding.version2.PdbentryItem removePdbentryItemAt(\r
+            final int index) {\r
+        java.lang.Object obj = this._items.remove(index);\r
         return (jalview.schemabinding.version2.PdbentryItem) obj;\r
-    } //-- jalview.schemabinding.version2.PdbentryItem removePdbentryItem(int) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'file'.\r
      * \r
      * @param file the value of field 'file'.\r
      */\r
-    public void setFile(java.lang.String file)\r
-    {\r
+    public void setFile(\r
+            final java.lang.String file) {\r
         this._file = file;\r
-    } //-- void setFile(java.lang.String) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'id'.\r
      * \r
      * @param id the value of field 'id'.\r
      */\r
-    public void setId(java.lang.String id)\r
-    {\r
+    public void setId(\r
+            final java.lang.String id) {\r
         this._id = id;\r
-    } //-- void setId(java.lang.String) \r
+    }\r
 \r
     /**\r
-     * Method setPdbentryItem\r
-     * \r
      * \r
      * \r
      * @param index\r
      * @param vPdbentryItem\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
      */\r
-    public void setPdbentryItem(int index, jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        //-- check bounds for index\r
-        if ((index < 0) || (index > _items.size())) {\r
-            throw new IndexOutOfBoundsException();\r
+    public void setPdbentryItem(\r
+            final int index,\r
+            final jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._items.size()) {\r
+            throw new IndexOutOfBoundsException("setPdbentryItem: Index value '" + index + "' not in range [0.." + (this._items.size() - 1) + "]");\r
         }\r
-        _items.setElementAt(vPdbentryItem, index);\r
-    } //-- void setPdbentryItem(int, jalview.schemabinding.version2.PdbentryItem) \r
+        \r
+        this._items.set(index, vPdbentryItem);\r
+    }\r
 \r
     /**\r
-     * Method setPdbentryItem\r
-     * \r
      * \r
      * \r
-     * @param pdbentryItemArray\r
+     * @param vPdbentryItemArray\r
      */\r
-    public void setPdbentryItem(jalview.schemabinding.version2.PdbentryItem[] pdbentryItemArray)\r
-    {\r
+    public void setPdbentryItem(\r
+            final jalview.schemabinding.version2.PdbentryItem[] vPdbentryItemArray) {\r
         //-- copy array\r
-        _items.removeAllElements();\r
-        for (int i = 0; i < pdbentryItemArray.length; i++) {\r
-            _items.addElement(pdbentryItemArray[i]);\r
+        _items.clear();\r
+        \r
+        for (int i = 0; i < vPdbentryItemArray.length; i++) {\r
+                this._items.add(vPdbentryItemArray[i]);\r
         }\r
-    } //-- void setPdbentryItem(jalview.schemabinding.version2.PdbentryItem) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'type'.\r
      * \r
      * @param type the value of field 'type'.\r
      */\r
-    public void setType(java.lang.String type)\r
-    {\r
+    public void setType(\r
+            final java.lang.String type) {\r
         this._type = type;\r
-    } //-- void setType(java.lang.String) \r
+    }\r
 \r
     /**\r
-     * Method unmarshal\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.Pdbentry\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
+    public static jalview.schemabinding.version2.Pdbentry unmarshal(\r
+            final java.io.Reader reader)\r
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
         return (jalview.schemabinding.version2.Pdbentry) Unmarshaller.unmarshal(jalview.schemabinding.version2.Pdbentry.class, reader);\r
-    } //-- java.lang.Object unmarshal(java.io.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