src/org/vamsas/objects/core/VAMSAS.java

   1 /*
   2  * This class was automatically generated with
   3  * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML
   4  * Schema.
   5  * $Id:VAMSAS.java 264 2006-12-14 17:42:54Z JimP $
   6  */
   7
   8 package org.vamsas.objects.core;
   9
  10   //---------------------------------/
  11  //- Imported classes and packages -/
  12 //---------------------------------/
  13
  14 import java.io.IOException;
  15 import java.io.Reader;
  16 import java.io.Serializable;
  17 import java.io.Writer;
  18 import java.util.Enumeration;
  19 import java.util.Vector;
  20 import org.exolab.castor.xml.MarshalException;
  21 import org.exolab.castor.xml.Marshaller;
  22 import org.exolab.castor.xml.Unmarshaller;
  23 import org.exolab.castor.xml.ValidationException;
  24 import org.xml.sax.ContentHandler;
  25
  26 /**
  27  * contains unassociated trees and a number of analysis sets
  28  *
  29  *
  30  * @version $Revision:264 $ $Date:2006-12-14 17:42:54 +0000 (Thu, 14 Dec 2006) $
  31  */
  32 public class VAMSAS extends uk.ac.vamsas.client.Vobject
  33 implements java.io.Serializable
  34 {
  35
  36
  37       //--------------------------/
  38      //- Class/Member Variables -/
  39     //--------------------------/
  40
  41     /**
  42      * Primary Key for vamsas object referencing
  43      */
  44     private java.lang.String _id;
  45
  46     /**
  47      * Field _modifiable
  48      */
  49     private java.lang.String _modifiable;
  50
  51     /**
  52      * Field _treeList
  53      */
  54     private java.util.Vector _treeList;
  55
  56     /**
  57      * Field _dataSetList
  58      */
  59     private java.util.Vector _dataSetList;
  60
  61
  62       //----------------/
  63      //- Constructors -/
  64     //----------------/
  65
  66     public VAMSAS()
  67      {
  68         super();
  69         _treeList = new Vector();
  70         _dataSetList = new Vector();
  71     } //-- org.vamsas.objects.core.VAMSAS()
  72
  73
  74       //-----------/
  75      //- Methods -/
  76     //-----------/
  77
  78     /**
  79      * Method addDataSet
  80      *
  81      *
  82      *
  83      * @param vDataSet
  84      */
  85     public void addDataSet(org.vamsas.objects.core.DataSet vDataSet)
  86         throws java.lang.IndexOutOfBoundsException
  87     {
  88         _dataSetList.addElement(vDataSet);
  89     } //-- void addDataSet(org.vamsas.objects.core.DataSet)
  90
  91     /**
  92      * Method addDataSet
  93      *
  94      *
  95      *
  96      * @param index
  97      * @param vDataSet
  98      */
  99     public void addDataSet(int index, org.vamsas.objects.core.DataSet vDataSet)
 100         throws java.lang.IndexOutOfBoundsException
 101     {
 102         _dataSetList.insertElementAt(vDataSet, index);
 103     } //-- void addDataSet(int, org.vamsas.objects.core.DataSet)
 104
 105     /**
 106      * Method addTree
 107      *
 108      *
 109      *
 110      * @param vTree
 111      */
 112     public void addTree(org.vamsas.objects.core.Tree vTree)
 113         throws java.lang.IndexOutOfBoundsException
 114     {
 115         _treeList.addElement(vTree);
 116     } //-- void addTree(org.vamsas.objects.core.Tree)
 117
 118     /**
 119      * Method addTree
 120      *
 121      *
 122      *
 123      * @param index
 124      * @param vTree
 125      */
 126     public void addTree(int index, org.vamsas.objects.core.Tree vTree)
 127         throws java.lang.IndexOutOfBoundsException
 128     {
 129         _treeList.insertElementAt(vTree, index);
 130     } //-- void addTree(int, org.vamsas.objects.core.Tree)
 131
 132     /**
 133      * Method enumerateDataSet
 134      *
 135      *
 136      *
 137      * @return Enumeration
 138      */
 139     public java.util.Enumeration enumerateDataSet()
 140     {
 141         return _dataSetList.elements();
 142     } //-- java.util.Enumeration enumerateDataSet()
 143
 144     /**
 145      * Method enumerateTree
 146      *
 147      *
 148      *
 149      * @return Enumeration
 150      */
 151     public java.util.Enumeration enumerateTree()
 152     {
 153         return _treeList.elements();
 154     } //-- java.util.Enumeration enumerateTree()
 155
 156     /**
 157      * Note: hashCode() has not been overriden
 158      *
 159      * @param obj
 160      * @return boolean
 161      */
 162     public boolean equals(java.lang.Object obj)
 163     {
 164         if ( this == obj )
 165             return true;
 166
 167         if (super.equals(obj)==false)
 168             return false;
 169
 170         if (obj instanceof VAMSAS) {
 171
 172             VAMSAS temp = (VAMSAS)obj;
 173             if (this._id != null) {
 174                 if (temp._id == null) return false;
 175                 else if (!(this._id.equals(temp._id)))
 176                     return false;
 177             }
 178             else if (temp._id != null)
 179                 return false;
 180             if (this._modifiable != null) {
 181                 if (temp._modifiable == null) return false;
 182                 else if (!(this._modifiable.equals(temp._modifiable)))
 183                     return false;
 184             }
 185             else if (temp._modifiable != null)
 186                 return false;
 187             if (this._treeList != null) {
 188                 if (temp._treeList == null) return false;
 189                 else if (!(this._treeList.equals(temp._treeList)))
 190                     return false;
 191             }
 192             else if (temp._treeList != null)
 193                 return false;
 194             if (this._dataSetList != null) {
 195                 if (temp._dataSetList == null) return false;
 196                 else if (!(this._dataSetList.equals(temp._dataSetList)))
 197                     return false;
 198             }
 199             else if (temp._dataSetList != null)
 200                 return false;
 201             return true;
 202         }
 203         return false;
 204     } //-- boolean equals(java.lang.Object)
 205
 206     /**
 207      * Method getDataSet
 208      *
 209      *
 210      *
 211      * @param index
 212      * @return DataSet
 213      */
 214     public org.vamsas.objects.core.DataSet getDataSet(int index)
 215         throws java.lang.IndexOutOfBoundsException
 216     {
 217         //-- check bounds for index
 218         if ((index < 0) || (index > _dataSetList.size())) {
 219             throw new IndexOutOfBoundsException("getDataSet: Index value '"+index+"' not in range [0.."+_dataSetList.size()+ "]");
 220         }
 221
 222         return (org.vamsas.objects.core.DataSet) _dataSetList.elementAt(index);
 223     } //-- org.vamsas.objects.core.DataSet getDataSet(int)
 224
 225     /**
 226      * Method getDataSet
 227      *
 228      *
 229      *
 230      * @return DataSet
 231      */
 232     public org.vamsas.objects.core.DataSet[] getDataSet()
 233     {
 234         int size = _dataSetList.size();
 235         org.vamsas.objects.core.DataSet[] mArray = new org.vamsas.objects.core.DataSet[size];
 236         for (int index = 0; index < size; index++) {
 237             mArray[index] = (org.vamsas.objects.core.DataSet) _dataSetList.elementAt(index);
 238         }
 239         return mArray;
 240     } //-- org.vamsas.objects.core.DataSet[] getDataSet()
 241
 242     /**
 243      * Method getDataSetCount
 244      *
 245      *
 246      *
 247      * @return int
 248      */
 249     public int getDataSetCount()
 250     {
 251         return _dataSetList.size();
 252     } //-- int getDataSetCount()
 253
 254     /**
 255      * Returns the value of field 'id'. The field 'id' has the
 256      * following description: Primary Key for vamsas object
 257      * referencing
 258      *
 259      * @return String
 260      * @return the value of field 'id'.
 261      */
 262     public java.lang.String getId()
 263     {
 264         return this._id;
 265     } //-- java.lang.String getId()
 266
 267     /**
 268      * Returns the value of field 'modifiable'.
 269      *
 270      * @return String
 271      * @return the value of field 'modifiable'.
 272      */
 273     public java.lang.String getModifiable()
 274     {
 275         return this._modifiable;
 276     } //-- java.lang.String getModifiable()
 277
 278     /**
 279      * Method getTree
 280      *
 281      *
 282      *
 283      * @param index
 284      * @return Tree
 285      */
 286     public org.vamsas.objects.core.Tree getTree(int index)
 287         throws java.lang.IndexOutOfBoundsException
 288     {
 289         //-- check bounds for index
 290         if ((index < 0) || (index > _treeList.size())) {
 291             throw new IndexOutOfBoundsException("getTree: Index value '"+index+"' not in range [0.."+_treeList.size()+ "]");
 292         }
 293
 294         return (org.vamsas.objects.core.Tree) _treeList.elementAt(index);
 295     } //-- org.vamsas.objects.core.Tree getTree(int)
 296
 297     /**
 298      * Method getTree
 299      *
 300      *
 301      *
 302      * @return Tree
 303      */
 304     public org.vamsas.objects.core.Tree[] getTree()
 305     {
 306         int size = _treeList.size();
 307         org.vamsas.objects.core.Tree[] mArray = new org.vamsas.objects.core.Tree[size];
 308         for (int index = 0; index < size; index++) {
 309             mArray[index] = (org.vamsas.objects.core.Tree) _treeList.elementAt(index);
 310         }
 311         return mArray;
 312     } //-- org.vamsas.objects.core.Tree[] getTree()
 313
 314     /**
 315      * Method getTreeCount
 316      *
 317      *
 318      *
 319      * @return int
 320      */
 321     public int getTreeCount()
 322     {
 323         return _treeList.size();
 324     } //-- int getTreeCount()
 325
 326     /**
 327      * Method isValid
 328      *
 329      *
 330      *
 331      * @return boolean
 332      */
 333     public boolean isValid()
 334     {
 335         try {
 336             validate();
 337         }
 338         catch (org.exolab.castor.xml.ValidationException vex) {
 339             return false;
 340         }
 341         return true;
 342     } //-- boolean isValid()
 343
 344     /**
 345      * Method marshal
 346      *
 347      *
 348      *
 349      * @param out
 350      */
 351     public void marshal(java.io.Writer out)
 352         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
 353     {
 354
 355         Marshaller.marshal(this, out);
 356     } //-- void marshal(java.io.Writer)
 357
 358     /**
 359      * Method marshal
 360      *
 361      *
 362      *
 363      * @param handler
 364      */
 365     public void marshal(org.xml.sax.ContentHandler handler)
 366         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
 367     {
 368
 369         Marshaller.marshal(this, handler);
 370     } //-- void marshal(org.xml.sax.ContentHandler)
 371
 372     /**
 373      * Method removeAllDataSet
 374      *
 375      */
 376     public void removeAllDataSet()
 377     {
 378         _dataSetList.removeAllElements();
 379     } //-- void removeAllDataSet()
 380
 381     /**
 382      * Method removeAllTree
 383      *
 384      */
 385     public void removeAllTree()
 386     {
 387         _treeList.removeAllElements();
 388     } //-- void removeAllTree()
 389
 390     /**
 391      * Method removeDataSet
 392      *
 393      *
 394      *
 395      * @param index
 396      * @return DataSet
 397      */
 398     public org.vamsas.objects.core.DataSet removeDataSet(int index)
 399     {
 400         java.lang.Object obj = _dataSetList.elementAt(index);
 401         _dataSetList.removeElementAt(index);
 402         return (org.vamsas.objects.core.DataSet) obj;
 403     } //-- org.vamsas.objects.core.DataSet removeDataSet(int)
 404
 405     /**
 406      * Method removeTree
 407      *
 408      *
 409      *
 410      * @param index
 411      * @return Tree
 412      */
 413     public org.vamsas.objects.core.Tree removeTree(int index)
 414     {
 415         java.lang.Object obj = _treeList.elementAt(index);
 416         _treeList.removeElementAt(index);
 417         return (org.vamsas.objects.core.Tree) obj;
 418     } //-- org.vamsas.objects.core.Tree removeTree(int)
 419
 420     /**
 421      * Method setDataSet
 422      *
 423      *
 424      *
 425      * @param index
 426      * @param vDataSet
 427      */
 428     public void setDataSet(int index, org.vamsas.objects.core.DataSet vDataSet)
 429         throws java.lang.IndexOutOfBoundsException
 430     {
 431         //-- check bounds for index
 432         if ((index < 0) || (index > _dataSetList.size())) {
 433             throw new IndexOutOfBoundsException("setDataSet: Index value '"+index+"' not in range [0.."+_dataSetList.size()+ "]");
 434         }
 435         _dataSetList.setElementAt(vDataSet, index);
 436     } //-- void setDataSet(int, org.vamsas.objects.core.DataSet)
 437
 438     /**
 439      * Method setDataSet
 440      *
 441      *
 442      *
 443      * @param dataSetArray
 444      */
 445     public void setDataSet(org.vamsas.objects.core.DataSet[] dataSetArray)
 446     {
 447         //-- copy array
 448         _dataSetList.removeAllElements();
 449         for (int i = 0; i < dataSetArray.length; i++) {
 450             _dataSetList.addElement(dataSetArray[i]);
 451         }
 452     } //-- void setDataSet(org.vamsas.objects.core.DataSet)
 453
 454     /**
 455      * Sets the value of field 'id'. The field 'id' has the
 456      * following description: Primary Key for vamsas object
 457      * referencing
 458      *
 459      * @param id the value of field 'id'.
 460      */
 461     public void setId(java.lang.String id)
 462     {
 463         this._id = id;
 464     } //-- void setId(java.lang.String)
 465
 466     /**
 467      * Sets the value of field 'modifiable'.
 468      *
 469      * @param modifiable the value of field 'modifiable'.
 470      */
 471     public void setModifiable(java.lang.String modifiable)
 472     {
 473         this._modifiable = modifiable;
 474     } //-- void setModifiable(java.lang.String)
 475
 476     /**
 477      * Method setTree
 478      *
 479      *
 480      *
 481      * @param index
 482      * @param vTree
 483      */
 484     public void setTree(int index, org.vamsas.objects.core.Tree vTree)
 485         throws java.lang.IndexOutOfBoundsException
 486     {
 487         //-- check bounds for index
 488         if ((index < 0) || (index > _treeList.size())) {
 489             throw new IndexOutOfBoundsException("setTree: Index value '"+index+"' not in range [0.."+_treeList.size()+ "]");
 490         }
 491         _treeList.setElementAt(vTree, index);
 492     } //-- void setTree(int, org.vamsas.objects.core.Tree)
 493
 494     /**
 495      * Method setTree
 496      *
 497      *
 498      *
 499      * @param treeArray
 500      */
 501     public void setTree(org.vamsas.objects.core.Tree[] treeArray)
 502     {
 503         //-- copy array
 504         _treeList.removeAllElements();
 505         for (int i = 0; i < treeArray.length; i++) {
 506             _treeList.addElement(treeArray[i]);
 507         }
 508     } //-- void setTree(org.vamsas.objects.core.Tree)
 509
 510     /**
 511      * Method unmarshal
 512      *
 513      *
 514      *
 515      * @param reader
 516      * @return VAMSAS
 517      */
 518     public static org.vamsas.objects.core.VAMSAS unmarshal(java.io.Reader reader)
 519         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
 520     {
 521         return (org.vamsas.objects.core.VAMSAS) Unmarshaller.unmarshal(org.vamsas.objects.core.VAMSAS.class, reader);
 522     } //-- org.vamsas.objects.core.VAMSAS unmarshal(java.io.Reader)
 523
 524     /**
 525      * Method validate
 526      *
 527      */
 528     public void validate()
 529         throws org.exolab.castor.xml.ValidationException
 530     {
 531         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 532         validator.validate(this);
 533     } //-- void validate()
 534
 535 }