/*\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
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)\r
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
+ * \r
+ * This file is part of Jalview.\r
+ * \r
+ * Jalview is free software: you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License \r
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
+ * \r
+ * Jalview is distributed in the hope that it will be useful, but \r
+ * WITHOUT ANY WARRANTY; without even the implied warranty \r
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
+ * PURPOSE. See the GNU General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.\r
*/\r
-\r
package jalview.schemabinding.version2;\r
\r
- //---------------------------------/\r
- //- Imported classes and packages -/\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 Pdbentry.\r
* \r
* @version $Revision$ $Date$\r
*/\r
-public class Pdbentry implements java.io.Serializable {\r
-\r
-\r
- //--------------------------/\r
- //- Class/Member Variables -/\r
- //--------------------------/\r
-\r
- /**\r
- * Field _id\r
- */\r
- private java.lang.String _id;\r
-\r
- /**\r
- * Field _type\r
- */\r
- private java.lang.String _type;\r
-\r
- /**\r
- * Field _items\r
- */\r
- private java.util.Vector _items;\r
-\r
-\r
- //----------------/\r
- //- Constructors -/\r
- //----------------/\r
-\r
- public Pdbentry() {\r
- super();\r
- _items = new Vector();\r
- } //-- jalview.schemabinding.version2.Pdbentry()\r
-\r
-\r
- //-----------/\r
- //- Methods -/\r
- //-----------/\r
-\r
- /**\r
- * Method addPdbentryItem\r
- * \r
- * \r
- * \r
- * @param vPdbentryItem\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
-\r
- /**\r
- * Method addPdbentryItem\r
- * \r
- * \r
- * \r
- * @param index\r
- * @param vPdbentryItem\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
-\r
- /**\r
- * Method enumeratePdbentryItem\r
- * \r
- * \r
- * \r
- * @return Enumeration\r
- */\r
- public java.util.Enumeration enumeratePdbentryItem()\r
- {\r
- return _items.elements();\r
- } //-- java.util.Enumeration enumeratePdbentryItem() \r
-\r
- /**\r
- * Returns the value of field 'id'.\r
- * \r
- * @return String\r
- * @return the value of field 'id'.\r
- */\r
- public java.lang.String getId()\r
+public class Pdbentry implements java.io.Serializable\r
+{\r
+\r
+ // --------------------------/\r
+ // - Class/Member Variables -/\r
+ // --------------------------/\r
+\r
+ /**\r
+ * Field _id.\r
+ */\r
+ private java.lang.String _id;\r
+\r
+ /**\r
+ * Field _type.\r
+ */\r
+ private java.lang.String _type;\r
+\r
+ /**\r
+ * Field _file.\r
+ */\r
+ private java.lang.String _file;\r
+\r
+ /**\r
+ * Field _items.\r
+ */\r
+ private java.util.Vector _items;\r
+\r
+ // ----------------/\r
+ // - Constructors -/\r
+ // ----------------/\r
+\r
+ public Pdbentry()\r
+ {\r
+ super();\r
+ this._items = new java.util.Vector();\r
+ }\r
+\r
+ // -----------/\r
+ // - Methods -/\r
+ // -----------/\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param vPdbentryItem\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
+ */\r
+ public void addPdbentryItem(\r
+ final jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
+ throws java.lang.IndexOutOfBoundsException\r
+ {\r
+ this._items.addElement(vPdbentryItem);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vPdbentryItem\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
+ */\r
+ public void addPdbentryItem(final int index,\r
+ final jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
+ throws java.lang.IndexOutOfBoundsException\r
+ {\r
+ this._items.add(index, vPdbentryItem);\r
+ }\r
+\r
+ /**\r
+ * Method enumeratePdbentryItem.\r
+ * \r
+ * @return an Enumeration over all jalview.schemabinding.version2.PdbentryItem\r
+ * elements\r
+ */\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 the value of field 'File'.\r
+ */\r
+ public java.lang.String getFile()\r
+ {\r
+ return this._file;\r
+ }\r
+\r
+ /**\r
+ * Returns the value of field 'id'.\r
+ * \r
+ * @return the value of field 'Id'.\r
+ */\r
+ public java.lang.String getId()\r
+ {\r
+ return this._id;\r
+ }\r
+\r
+ /**\r
+ * Method getPdbentryItem.\r
+ * \r
+ * @param index\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
+ * @return the value of the jalview.schemabinding.version2.PdbentryItem at the\r
+ * given inde\r
+ */\r
+ public jalview.schemabinding.version2.PdbentryItem getPdbentryItem(\r
+ final int index) throws java.lang.IndexOutOfBoundsException\r
+ {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._items.size())\r
{\r
- return this._id;\r
- } //-- java.lang.String getId() \r
-\r
- /**\r
- * Method getPdbentryItem\r
- * \r
- * \r
- * \r
- * @param index\r
- * @return PdbentryItem\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
- }\r
- \r
- return (jalview.schemabinding.version2.PdbentryItem) _items.elementAt(index);\r
- } //-- jalview.schemabinding.version2.PdbentryItem getPdbentryItem(int) \r
-\r
- /**\r
- * Method getPdbentryItem\r
- * \r
- * \r
- * \r
- * @return PdbentryItem\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
-\r
- /**\r
- * Method getPdbentryItemCount\r
- * \r
- * \r
- * \r
- * @return int\r
- */\r
- public int getPdbentryItemCount()\r
- {\r
- return _items.size();\r
- } //-- int getPdbentryItemCount() \r
-\r
- /**\r
- * Returns the value of field 'type'.\r
- * \r
- * @return String\r
- * @return the value of field 'type'.\r
- */\r
- public java.lang.String getType()\r
+ throw new IndexOutOfBoundsException("getPdbentryItem: Index value '"\r
+ + index + "' not in range [0.." + (this._items.size() - 1)\r
+ + "]");\r
+ }\r
+\r
+ return (jalview.schemabinding.version2.PdbentryItem) _items.get(index);\r
+ }\r
+\r
+ /**\r
+ * Method getPdbentryItem.Returns the contents of the collection in an Array.\r
+ * <p>\r
+ * Note: Just in case the collection contents are changing in another thread,\r
+ * we pass a 0-length Array of the correct type into the API call. This way we\r
+ * <i>know</i> that the Array returned is of exactly the correct length.\r
+ * \r
+ * @return this collection as an Array\r
+ */\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\r
+ .toArray(array);\r
+ }\r
+\r
+ /**\r
+ * Method getPdbentryItemCount.\r
+ * \r
+ * @return the size of this collection\r
+ */\r
+ public int getPdbentryItemCount()\r
+ {\r
+ return this._items.size();\r
+ }\r
+\r
+ /**\r
+ * Returns the value of field 'type'.\r
+ * \r
+ * @return the value of field 'Type'.\r
+ */\r
+ public java.lang.String getType()\r
+ {\r
+ return this._type;\r
+ }\r
+\r
+ /**\r
+ * Method isValid.\r
+ * \r
+ * @return true if this object is valid according to the schema\r
+ */\r
+ public boolean isValid()\r
+ {\r
+ try\r
{\r
- return this._type;\r
- } //-- java.lang.String getType() \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
+ validate();\r
+ } catch (org.exolab.castor.xml.ValidationException vex)\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
+ return false;\r
+ }\r
+ return true;\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param out\r
+ * @throws org.exolab.castor.xml.MarshalException\r
+ * if object is null or if any SAXException is thrown during\r
+ * marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
+ */\r
+ public void marshal(final java.io.Writer out)\r
+ throws org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
+ {\r
+ Marshaller.marshal(this, out);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param handler\r
+ * @throws java.io.IOException\r
+ * if an IOException occurs during marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
+ * @throws org.exolab.castor.xml.MarshalException\r
+ * if object is null or if any SAXException is thrown during\r
+ * marshaling\r
+ */\r
+ public void marshal(final org.xml.sax.ContentHandler handler)\r
+ throws java.io.IOException,\r
+ org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
+ {\r
+ Marshaller.marshal(this, handler);\r
+ }\r
+\r
+ /**\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
+ public void removeAllPdbentryItem()\r
+ {\r
+ this._items.clear();\r
+ }\r
+\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
+ {\r
+ boolean removed = _items.remove(vPdbentryItem);\r
+ return removed;\r
+ }\r
+\r
+ /**\r
+ * Method removePdbentryItemAt.\r
+ * \r
+ * @param index\r
+ * @return the element removed from the collection\r
+ */\r
+ public jalview.schemabinding.version2.PdbentryItem removePdbentryItemAt(\r
+ final int index)\r
+ {\r
+ java.lang.Object obj = this._items.remove(index);\r
+ return (jalview.schemabinding.version2.PdbentryItem) obj;\r
+ }\r
+\r
+ /**\r
+ * Sets the value of field 'file'.\r
+ * \r
+ * @param file\r
+ * the value of field 'file'.\r
+ */\r
+ public void setFile(final java.lang.String file)\r
+ {\r
+ this._file = file;\r
+ }\r
+\r
+ /**\r
+ * Sets the value of field 'id'.\r
+ * \r
+ * @param id\r
+ * the value of field 'id'.\r
+ */\r
+ public void setId(final java.lang.String id)\r
+ {\r
+ this._id = id;\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vPdbentryItem\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
+ */\r
+ public void setPdbentryItem(final int index,\r
+ final jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
+ throws java.lang.IndexOutOfBoundsException\r
+ {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._items.size())\r
{\r
- \r
- Marshaller.marshal(this, handler);\r
- } //-- void marshal(org.xml.sax.ContentHandler) \r
-\r
- /**\r
- * Method removeAllPdbentryItem\r
- * \r
- */\r
- public void removeAllPdbentryItem()\r
- {\r
- _items.removeAllElements();\r
- } //-- void removeAllPdbentryItem() \r
-\r
- /**\r
- * Method removePdbentryItem\r
- * \r
- * \r
- * \r
- * @param index\r
- * @return PdbentryItem\r
- */\r
- public jalview.schemabinding.version2.PdbentryItem removePdbentryItem(int index)\r
- {\r
- java.lang.Object obj = _items.elementAt(index);\r
- _items.removeElementAt(index);\r
- return (jalview.schemabinding.version2.PdbentryItem) obj;\r
- } //-- jalview.schemabinding.version2.PdbentryItem removePdbentryItem(int) \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
- this._id = id;\r
- } //-- void setId(java.lang.String) \r
-\r
- /**\r
- * Method setPdbentryItem\r
- * \r
- * \r
- * \r
- * @param index\r
- * @param vPdbentryItem\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
- }\r
- _items.setElementAt(vPdbentryItem, index);\r
- } //-- void setPdbentryItem(int, jalview.schemabinding.version2.PdbentryItem) \r
-\r
- /**\r
- * Method setPdbentryItem\r
- * \r
- * \r
- * \r
- * @param pdbentryItemArray\r
- */\r
- public void setPdbentryItem(jalview.schemabinding.version2.PdbentryItem[] pdbentryItemArray)\r
- {\r
- //-- copy array\r
- _items.removeAllElements();\r
- for (int i = 0; i < pdbentryItemArray.length; i++) {\r
- _items.addElement(pdbentryItemArray[i]);\r
- }\r
- } //-- void setPdbentryItem(jalview.schemabinding.version2.PdbentryItem) \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
- this._type = type;\r
- } //-- void setType(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.schemabinding.version2.Pdbentry) Unmarshaller.unmarshal(jalview.schemabinding.version2.Pdbentry.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
+ throw new IndexOutOfBoundsException("setPdbentryItem: Index value '"\r
+ + index + "' not in range [0.." + (this._items.size() - 1)\r
+ + "]");\r
+ }\r
+\r
+ this._items.set(index, vPdbentryItem);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param vPdbentryItemArray\r
+ */\r
+ public void setPdbentryItem(\r
+ final jalview.schemabinding.version2.PdbentryItem[] vPdbentryItemArray)\r
+ {\r
+ // -- copy array\r
+ _items.clear();\r
+\r
+ for (int i = 0; i < vPdbentryItemArray.length; i++)\r
{\r
- org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
- validator.validate(this);\r
- } //-- void validate() \r
+ this._items.add(vPdbentryItemArray[i]);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Sets the value of field 'type'.\r
+ * \r
+ * @param type\r
+ * the value of field 'type'.\r
+ */\r
+ public void setType(final java.lang.String type)\r
+ {\r
+ this._type = type;\r
+ }\r
+\r
+ /**\r
+ * Method unmarshal.\r
+ * \r
+ * @param reader\r
+ * @throws org.exolab.castor.xml.MarshalException\r
+ * if object is null or if any SAXException is thrown during\r
+ * marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
+ * @return the unmarshaled jalview.schemabinding.version2.Pdbentry\r
+ */\r
+ public static jalview.schemabinding.version2.Pdbentry unmarshal(\r
+ final java.io.Reader reader)\r
+ throws org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
+ {\r
+ return (jalview.schemabinding.version2.Pdbentry) Unmarshaller\r
+ .unmarshal(jalview.schemabinding.version2.Pdbentry.class,\r
+ reader);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
+ */\r
+ public void validate() 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
+ }\r
\r
}\r
git://source.jalview.org / jalview.git / blobdiff