src/jalview/binding/Pdbentry.java

   1 /*\r
   2  * This class was automatically generated with \r
   3  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
   4  * Schema.\r
   5  * $Id$\r
   6  */\r
   7 \r
   8 package jalview.binding;\r
   9 \r
  10   //---------------------------------/\r
  11  //- Imported classes and packages -/\r
  12 //---------------------------------/\r
  13 \r
  14 import java.io.IOException;\r
  15 import java.io.Reader;\r
  16 import java.io.Serializable;\r
  17 import java.io.Writer;\r
  18 import java.util.Enumeration;\r
  19 import java.util.Vector;\r
  20 import org.exolab.castor.xml.MarshalException;\r
  21 import org.exolab.castor.xml.Marshaller;\r
  22 import org.exolab.castor.xml.Unmarshaller;\r
  23 import org.exolab.castor.xml.ValidationException;\r
  24 import org.xml.sax.ContentHandler;\r
  25 \r
  26 /**\r
  27  * Class Pdbentry.\r
  28  * \r
  29  * @version $Revision$ $Date$\r
  30  */\r
  31 public class Pdbentry implements java.io.Serializable {\r
  32 \r
  33 \r
  34       //--------------------------/\r
  35      //- Class/Member Variables -/\r
  36     //--------------------------/\r
  37 \r
  38     /**\r
  39      * Field _id\r
  40      */\r
  41     private java.lang.String _id;\r
  42 \r
  43     /**\r
  44      * Field _type\r
  45      */\r
  46     private java.lang.String _type;\r
  47 \r
  48     /**\r
  49      * Field _items\r
  50      */\r
  51     private java.util.Vector _items;\r
  52 \r
  53 \r
  54       //----------------/\r
  55      //- Constructors -/\r
  56     //----------------/\r
  57 \r
  58     public Pdbentry() {\r
  59         super();\r
  60         _items = new Vector();\r
  61     } //-- jalview.binding.Pdbentry()\r
  62 \r
  63 \r
  64       //-----------/\r
  65      //- Methods -/\r
  66     //-----------/\r
  67 \r
  68     /**\r
  69      * Method addPdbentryItem\r
  70      * \r
  71      * \r
  72      * \r
  73      * @param vPdbentryItem\r
  74      */\r
  75     public void addPdbentryItem(jalview.binding.PdbentryItem vPdbentryItem)\r
  76         throws java.lang.IndexOutOfBoundsException\r
  77     {\r
  78         _items.addElement(vPdbentryItem);\r
  79     } //-- void addPdbentryItem(jalview.binding.PdbentryItem) \r
  80 \r
  81     /**\r
  82      * Method addPdbentryItem\r
  83      * \r
  84      * \r
  85      * \r
  86      * @param index\r
  87      * @param vPdbentryItem\r
  88      */\r
  89     public void addPdbentryItem(int index, jalview.binding.PdbentryItem vPdbentryItem)\r
  90         throws java.lang.IndexOutOfBoundsException\r
  91     {\r
  92         _items.insertElementAt(vPdbentryItem, index);\r
  93     } //-- void addPdbentryItem(int, jalview.binding.PdbentryItem) \r
  94 \r
  95     /**\r
  96      * Method enumeratePdbentryItem\r
  97      * \r
  98      * \r
  99      * \r
 100      * @return Enumeration\r
 101      */\r
 102     public java.util.Enumeration enumeratePdbentryItem()\r
 103     {\r
 104         return _items.elements();\r
 105     } //-- java.util.Enumeration enumeratePdbentryItem() \r
 106 \r
 107     /**\r
 108      * Returns the value of field 'id'.\r
 109      * \r
 110      * @return String\r
 111      * @return the value of field 'id'.\r
 112      */\r
 113     public java.lang.String getId()\r
 114     {\r
 115         return this._id;\r
 116     } //-- java.lang.String getId() \r
 117 \r
 118     /**\r
 119      * Method getPdbentryItem\r
 120      * \r
 121      * \r
 122      * \r
 123      * @param index\r
 124      * @return PdbentryItem\r
 125      */\r
 126     public jalview.binding.PdbentryItem getPdbentryItem(int index)\r
 127         throws java.lang.IndexOutOfBoundsException\r
 128     {\r
 129         //-- check bounds for index\r
 130         if ((index < 0) || (index > _items.size())) {\r
 131             throw new IndexOutOfBoundsException();\r
 132         }\r
 133         \r
 134         return (jalview.binding.PdbentryItem) _items.elementAt(index);\r
 135     } //-- jalview.binding.PdbentryItem getPdbentryItem(int) \r
 136 \r
 137     /**\r
 138      * Method getPdbentryItem\r
 139      * \r
 140      * \r
 141      * \r
 142      * @return PdbentryItem\r
 143      */\r
 144     public jalview.binding.PdbentryItem[] getPdbentryItem()\r
 145     {\r
 146         int size = _items.size();\r
 147         jalview.binding.PdbentryItem[] mArray = new jalview.binding.PdbentryItem[size];\r
 148         for (int index = 0; index < size; index++) {\r
 149             mArray[index] = (jalview.binding.PdbentryItem) _items.elementAt(index);\r
 150         }\r
 151         return mArray;\r
 152     } //-- jalview.binding.PdbentryItem[] getPdbentryItem() \r
 153 \r
 154     /**\r
 155      * Method getPdbentryItemCount\r
 156      * \r
 157      * \r
 158      * \r
 159      * @return int\r
 160      */\r
 161     public int getPdbentryItemCount()\r
 162     {\r
 163         return _items.size();\r
 164     } //-- int getPdbentryItemCount() \r
 165 \r
 166     /**\r
 167      * Returns the value of field 'type'.\r
 168      * \r
 169      * @return String\r
 170      * @return the value of field 'type'.\r
 171      */\r
 172     public java.lang.String getType()\r
 173     {\r
 174         return this._type;\r
 175     } //-- java.lang.String getType() \r
 176 \r
 177     /**\r
 178      * Method isValid\r
 179      * \r
 180      * \r
 181      * \r
 182      * @return boolean\r
 183      */\r
 184     public boolean isValid()\r
 185     {\r
 186         try {\r
 187             validate();\r
 188         }\r
 189         catch (org.exolab.castor.xml.ValidationException vex) {\r
 190             return false;\r
 191         }\r
 192         return true;\r
 193     } //-- boolean isValid() \r
 194 \r
 195     /**\r
 196      * Method marshal\r
 197      * \r
 198      * \r
 199      * \r
 200      * @param out\r
 201      */\r
 202     public void marshal(java.io.Writer out)\r
 203         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 204     {\r
 205         \r
 206         Marshaller.marshal(this, out);\r
 207     } //-- void marshal(java.io.Writer) \r
 208 \r
 209     /**\r
 210      * Method marshal\r
 211      * \r
 212      * \r
 213      * \r
 214      * @param handler\r
 215      */\r
 216     public void marshal(org.xml.sax.ContentHandler handler)\r
 217         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 218     {\r
 219         \r
 220         Marshaller.marshal(this, handler);\r
 221     } //-- void marshal(org.xml.sax.ContentHandler) \r
 222 \r
 223     /**\r
 224      * Method removeAllPdbentryItem\r
 225      * \r
 226      */\r
 227     public void removeAllPdbentryItem()\r
 228     {\r
 229         _items.removeAllElements();\r
 230     } //-- void removeAllPdbentryItem() \r
 231 \r
 232     /**\r
 233      * Method removePdbentryItem\r
 234      * \r
 235      * \r
 236      * \r
 237      * @param index\r
 238      * @return PdbentryItem\r
 239      */\r
 240     public jalview.binding.PdbentryItem removePdbentryItem(int index)\r
 241     {\r
 242         java.lang.Object obj = _items.elementAt(index);\r
 243         _items.removeElementAt(index);\r
 244         return (jalview.binding.PdbentryItem) obj;\r
 245     } //-- jalview.binding.PdbentryItem removePdbentryItem(int) \r
 246 \r
 247     /**\r
 248      * Sets the value of field 'id'.\r
 249      * \r
 250      * @param id the value of field 'id'.\r
 251      */\r
 252     public void setId(java.lang.String id)\r
 253     {\r
 254         this._id = id;\r
 255     } //-- void setId(java.lang.String) \r
 256 \r
 257     /**\r
 258      * Method setPdbentryItem\r
 259      * \r
 260      * \r
 261      * \r
 262      * @param index\r
 263      * @param vPdbentryItem\r
 264      */\r
 265     public void setPdbentryItem(int index, jalview.binding.PdbentryItem vPdbentryItem)\r
 266         throws java.lang.IndexOutOfBoundsException\r
 267     {\r
 268         //-- check bounds for index\r
 269         if ((index < 0) || (index > _items.size())) {\r
 270             throw new IndexOutOfBoundsException();\r
 271         }\r
 272         _items.setElementAt(vPdbentryItem, index);\r
 273     } //-- void setPdbentryItem(int, jalview.binding.PdbentryItem) \r
 274 \r
 275     /**\r
 276      * Method setPdbentryItem\r
 277      * \r
 278      * \r
 279      * \r
 280      * @param pdbentryItemArray\r
 281      */\r
 282     public void setPdbentryItem(jalview.binding.PdbentryItem[] pdbentryItemArray)\r
 283     {\r
 284         //-- copy array\r
 285         _items.removeAllElements();\r
 286         for (int i = 0; i < pdbentryItemArray.length; i++) {\r
 287             _items.addElement(pdbentryItemArray[i]);\r
 288         }\r
 289     } //-- void setPdbentryItem(jalview.binding.PdbentryItem) \r
 290 \r
 291     /**\r
 292      * Sets the value of field 'type'.\r
 293      * \r
 294      * @param type the value of field 'type'.\r
 295      */\r
 296     public void setType(java.lang.String type)\r
 297     {\r
 298         this._type = type;\r
 299     } //-- void setType(java.lang.String) \r
 300 \r
 301     /**\r
 302      * Method unmarshal\r
 303      * \r
 304      * \r
 305      * \r
 306      * @param reader\r
 307      * @return Object\r
 308      */\r
 309     public static java.lang.Object unmarshal(java.io.Reader reader)\r
 310         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 311     {\r
 312         return (jalview.binding.Pdbentry) Unmarshaller.unmarshal(jalview.binding.Pdbentry.class, reader);\r
 313     } //-- java.lang.Object unmarshal(java.io.Reader) \r
 314 \r
 315     /**\r
 316      * Method validate\r
 317      * \r
 318      */\r
 319     public void validate()\r
 320         throws org.exolab.castor.xml.ValidationException\r
 321     {\r
 322         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 323         validator.validate(this);\r
 324     } //-- void validate() \r
 325 \r
 326 }\r