src/org/vamsas/objects/core/Tree.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 org.vamsas.objects.core;\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 Tree.\r
  28  * \r
  29  * @version $Revision$ $Date$\r
  30  */\r
  31 public class Tree 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 _title\r
  45      */\r
  46     private java.lang.String _title;\r
  47 \r
  48     /**\r
  49      * Field _newickList\r
  50      */\r
  51     private java.util.Vector _newickList;\r
  52 \r
  53     /**\r
  54      * Field _provenance\r
  55      */\r
  56     private org.vamsas.objects.core.Provenance _provenance;\r
  57 \r
  58 \r
  59       //----------------/\r
  60      //- Constructors -/\r
  61     //----------------/\r
  62 \r
  63     public Tree() {\r
  64         super();\r
  65         _newickList = new Vector();\r
  66     } //-- org.vamsas.objects.core.Tree()\r
  67 \r
  68 \r
  69       //-----------/\r
  70      //- Methods -/\r
  71     //-----------/\r
  72 \r
  73     /**\r
  74      * Method addNewick\r
  75      * \r
  76      * \r
  77      * \r
  78      * @param vNewick\r
  79      */\r
  80     public void addNewick(org.vamsas.objects.core.Newick vNewick)\r
  81         throws java.lang.IndexOutOfBoundsException\r
  82     {\r
  83         _newickList.addElement(vNewick);\r
  84     } //-- void addNewick(org.vamsas.objects.core.Newick) \r
  85 \r
  86     /**\r
  87      * Method addNewick\r
  88      * \r
  89      * \r
  90      * \r
  91      * @param index\r
  92      * @param vNewick\r
  93      */\r
  94     public void addNewick(int index, org.vamsas.objects.core.Newick vNewick)\r
  95         throws java.lang.IndexOutOfBoundsException\r
  96     {\r
  97         _newickList.insertElementAt(vNewick, index);\r
  98     } //-- void addNewick(int, org.vamsas.objects.core.Newick) \r
  99 \r
 100     /**\r
 101      * Method enumerateNewick\r
 102      * \r
 103      * \r
 104      * \r
 105      * @return Enumeration\r
 106      */\r
 107     public java.util.Enumeration enumerateNewick()\r
 108     {\r
 109         return _newickList.elements();\r
 110     } //-- java.util.Enumeration enumerateNewick() \r
 111 \r
 112     /**\r
 113      * Returns the value of field 'id'.\r
 114      * \r
 115      * @return String\r
 116      * @return the value of field 'id'.\r
 117      */\r
 118     public java.lang.String getId()\r
 119     {\r
 120         return this._id;\r
 121     } //-- java.lang.String getId() \r
 122 \r
 123     /**\r
 124      * Method getNewick\r
 125      * \r
 126      * \r
 127      * \r
 128      * @param index\r
 129      * @return Newick\r
 130      */\r
 131     public org.vamsas.objects.core.Newick getNewick(int index)\r
 132         throws java.lang.IndexOutOfBoundsException\r
 133     {\r
 134         //-- check bounds for index\r
 135         if ((index < 0) || (index > _newickList.size())) {\r
 136             throw new IndexOutOfBoundsException();\r
 137         }\r
 138         \r
 139         return (org.vamsas.objects.core.Newick) _newickList.elementAt(index);\r
 140     } //-- org.vamsas.objects.core.Newick getNewick(int) \r
 141 \r
 142     /**\r
 143      * Method getNewick\r
 144      * \r
 145      * \r
 146      * \r
 147      * @return Newick\r
 148      */\r
 149     public org.vamsas.objects.core.Newick[] getNewick()\r
 150     {\r
 151         int size = _newickList.size();\r
 152         org.vamsas.objects.core.Newick[] mArray = new org.vamsas.objects.core.Newick[size];\r
 153         for (int index = 0; index < size; index++) {\r
 154             mArray[index] = (org.vamsas.objects.core.Newick) _newickList.elementAt(index);\r
 155         }\r
 156         return mArray;\r
 157     } //-- org.vamsas.objects.core.Newick[] getNewick() \r
 158 \r
 159     /**\r
 160      * Method getNewickCount\r
 161      * \r
 162      * \r
 163      * \r
 164      * @return int\r
 165      */\r
 166     public int getNewickCount()\r
 167     {\r
 168         return _newickList.size();\r
 169     } //-- int getNewickCount() \r
 170 \r
 171     /**\r
 172      * Returns the value of field 'provenance'.\r
 173      * \r
 174      * @return Provenance\r
 175      * @return the value of field 'provenance'.\r
 176      */\r
 177     public org.vamsas.objects.core.Provenance getProvenance()\r
 178     {\r
 179         return this._provenance;\r
 180     } //-- org.vamsas.objects.core.Provenance getProvenance() \r
 181 \r
 182     /**\r
 183      * Returns the value of field 'title'.\r
 184      * \r
 185      * @return String\r
 186      * @return the value of field 'title'.\r
 187      */\r
 188     public java.lang.String getTitle()\r
 189     {\r
 190         return this._title;\r
 191     } //-- java.lang.String getTitle() \r
 192 \r
 193     /**\r
 194      * Method isValid\r
 195      * \r
 196      * \r
 197      * \r
 198      * @return boolean\r
 199      */\r
 200     public boolean isValid()\r
 201     {\r
 202         try {\r
 203             validate();\r
 204         }\r
 205         catch (org.exolab.castor.xml.ValidationException vex) {\r
 206             return false;\r
 207         }\r
 208         return true;\r
 209     } //-- boolean isValid() \r
 210 \r
 211     /**\r
 212      * Method marshal\r
 213      * \r
 214      * \r
 215      * \r
 216      * @param out\r
 217      */\r
 218     public void marshal(java.io.Writer out)\r
 219         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 220     {\r
 221         \r
 222         Marshaller.marshal(this, out);\r
 223     } //-- void marshal(java.io.Writer) \r
 224 \r
 225     /**\r
 226      * Method marshal\r
 227      * \r
 228      * \r
 229      * \r
 230      * @param handler\r
 231      */\r
 232     public void marshal(org.xml.sax.ContentHandler handler)\r
 233         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 234     {\r
 235         \r
 236         Marshaller.marshal(this, handler);\r
 237     } //-- void marshal(org.xml.sax.ContentHandler) \r
 238 \r
 239     /**\r
 240      * Method removeAllNewick\r
 241      * \r
 242      */\r
 243     public void removeAllNewick()\r
 244     {\r
 245         _newickList.removeAllElements();\r
 246     } //-- void removeAllNewick() \r
 247 \r
 248     /**\r
 249      * Method removeNewick\r
 250      * \r
 251      * \r
 252      * \r
 253      * @param index\r
 254      * @return Newick\r
 255      */\r
 256     public org.vamsas.objects.core.Newick removeNewick(int index)\r
 257     {\r
 258         java.lang.Object obj = _newickList.elementAt(index);\r
 259         _newickList.removeElementAt(index);\r
 260         return (org.vamsas.objects.core.Newick) obj;\r
 261     } //-- org.vamsas.objects.core.Newick removeNewick(int) \r
 262 \r
 263     /**\r
 264      * Sets the value of field 'id'.\r
 265      * \r
 266      * @param id the value of field 'id'.\r
 267      */\r
 268     public void setId(java.lang.String id)\r
 269     {\r
 270         this._id = id;\r
 271     } //-- void setId(java.lang.String) \r
 272 \r
 273     /**\r
 274      * Method setNewick\r
 275      * \r
 276      * \r
 277      * \r
 278      * @param index\r
 279      * @param vNewick\r
 280      */\r
 281     public void setNewick(int index, org.vamsas.objects.core.Newick vNewick)\r
 282         throws java.lang.IndexOutOfBoundsException\r
 283     {\r
 284         //-- check bounds for index\r
 285         if ((index < 0) || (index > _newickList.size())) {\r
 286             throw new IndexOutOfBoundsException();\r
 287         }\r
 288         _newickList.setElementAt(vNewick, index);\r
 289     } //-- void setNewick(int, org.vamsas.objects.core.Newick) \r
 290 \r
 291     /**\r
 292      * Method setNewick\r
 293      * \r
 294      * \r
 295      * \r
 296      * @param newickArray\r
 297      */\r
 298     public void setNewick(org.vamsas.objects.core.Newick[] newickArray)\r
 299     {\r
 300         //-- copy array\r
 301         _newickList.removeAllElements();\r
 302         for (int i = 0; i < newickArray.length; i++) {\r
 303             _newickList.addElement(newickArray[i]);\r
 304         }\r
 305     } //-- void setNewick(org.vamsas.objects.core.Newick) \r
 306 \r
 307     /**\r
 308      * Sets the value of field 'provenance'.\r
 309      * \r
 310      * @param provenance the value of field 'provenance'.\r
 311      */\r
 312     public void setProvenance(org.vamsas.objects.core.Provenance provenance)\r
 313     {\r
 314         this._provenance = provenance;\r
 315     } //-- void setProvenance(org.vamsas.objects.core.Provenance) \r
 316 \r
 317     /**\r
 318      * Sets the value of field 'title'.\r
 319      * \r
 320      * @param title the value of field 'title'.\r
 321      */\r
 322     public void setTitle(java.lang.String title)\r
 323     {\r
 324         this._title = title;\r
 325     } //-- void setTitle(java.lang.String) \r
 326 \r
 327     /**\r
 328      * Method unmarshal\r
 329      * \r
 330      * \r
 331      * \r
 332      * @param reader\r
 333      * @return Object\r
 334      */\r
 335     public static java.lang.Object unmarshal(java.io.Reader reader)\r
 336         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 337     {\r
 338         return (org.vamsas.objects.core.Tree) Unmarshaller.unmarshal(org.vamsas.objects.core.Tree.class, reader);\r
 339     } //-- java.lang.Object unmarshal(java.io.Reader) \r
 340 \r
 341     /**\r
 342      * Method validate\r
 343      * \r
 344      */\r
 345     public void validate()\r
 346         throws org.exolab.castor.xml.ValidationException\r
 347     {\r
 348         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 349         validator.validate(this);\r
 350     } //-- void validate() \r
 351 \r
 352 }\r