rebult for castor-1.1(vamsas version)
[vamsas.git] / src / uk / ac / vamsas / objects / core / VAMSAS.java
index 155e0a4..ba8146f 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * This class was automatically generated with 
- * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
  * Schema.
  * $Id$
  */
@@ -11,17 +11,8 @@ package uk.ac.vamsas.objects.core;
  //- Imported classes and packages -/
 //---------------------------------/
 
-import java.io.IOException;
-import java.io.Reader;
-import java.io.Serializable;
-import java.io.Writer;
-import java.util.Enumeration;
-import java.util.Vector;
-import org.exolab.castor.xml.MarshalException;
 import org.exolab.castor.xml.Marshaller;
 import org.exolab.castor.xml.Unmarshaller;
-import org.exolab.castor.xml.ValidationException;
-import org.xml.sax.ContentHandler;
 
 /**
  * contains unassociated trees and a number of analysis sets
@@ -44,17 +35,17 @@ implements java.io.Serializable
     private java.lang.String _id;
 
     /**
-     * Field _modifiable
+     * Field _modifiable.
      */
     private java.lang.String _modifiable;
 
     /**
-     * Field _treeList
+     * Field _treeList.
      */
     private java.util.Vector _treeList;
 
     /**
-     * Field _dataSetList
+     * Field _dataSetList.
      */
     private java.util.Vector _dataSetList;
 
@@ -63,12 +54,11 @@ implements java.io.Serializable
      //- Constructors -/
     //----------------/
 
-    public VAMSAS() 
-     {
+    public VAMSAS() {
         super();
-        _treeList = new Vector();
-        _dataSetList = new Vector();
-    } //-- uk.ac.vamsas.objects.core.VAMSAS()
+        this._treeList = new java.util.Vector();
+        this._dataSetList = new java.util.Vector();
+    }
 
 
       //-----------/
@@ -76,91 +66,91 @@ implements java.io.Serializable
     //-----------/
 
     /**
-     * Method addDataSet
-     * 
      * 
      * 
      * @param vDataSet
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addDataSet(uk.ac.vamsas.objects.core.DataSet vDataSet)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _dataSetList.addElement(vDataSet);
-    } //-- void addDataSet(uk.ac.vamsas.objects.core.DataSet) 
+    public void addDataSet(
+            final uk.ac.vamsas.objects.core.DataSet vDataSet)
+    throws java.lang.IndexOutOfBoundsException {
+        this._dataSetList.addElement(vDataSet);
+    }
 
     /**
-     * Method addDataSet
-     * 
      * 
      * 
      * @param index
      * @param vDataSet
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addDataSet(int index, uk.ac.vamsas.objects.core.DataSet vDataSet)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _dataSetList.insertElementAt(vDataSet, index);
-    } //-- void addDataSet(int, uk.ac.vamsas.objects.core.DataSet) 
+    public void addDataSet(
+            final int index,
+            final uk.ac.vamsas.objects.core.DataSet vDataSet)
+    throws java.lang.IndexOutOfBoundsException {
+        this._dataSetList.add(index, vDataSet);
+    }
 
     /**
-     * Method addTree
-     * 
      * 
      * 
      * @param vTree
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addTree(uk.ac.vamsas.objects.core.Tree vTree)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _treeList.addElement(vTree);
-    } //-- void addTree(uk.ac.vamsas.objects.core.Tree) 
+    public void addTree(
+            final uk.ac.vamsas.objects.core.Tree vTree)
+    throws java.lang.IndexOutOfBoundsException {
+        this._treeList.addElement(vTree);
+    }
 
     /**
-     * Method addTree
-     * 
      * 
      * 
      * @param index
      * @param vTree
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addTree(int index, uk.ac.vamsas.objects.core.Tree vTree)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _treeList.insertElementAt(vTree, index);
-    } //-- void addTree(int, uk.ac.vamsas.objects.core.Tree) 
+    public void addTree(
+            final int index,
+            final uk.ac.vamsas.objects.core.Tree vTree)
+    throws java.lang.IndexOutOfBoundsException {
+        this._treeList.add(index, vTree);
+    }
 
     /**
-     * Method enumerateDataSet
-     * 
-     * 
+     * Method enumerateDataSet.
      * 
-     * @return Enumeration
+     * @return an Enumeration over all
+     * uk.ac.vamsas.objects.core.DataSet elements
      */
-    public java.util.Enumeration enumerateDataSet()
-    {
-        return _dataSetList.elements();
-    } //-- java.util.Enumeration enumerateDataSet() 
+    public java.util.Enumeration enumerateDataSet(
+    ) {
+        return this._dataSetList.elements();
+    }
 
     /**
-     * Method enumerateTree
+     * Method enumerateTree.
      * 
-     * 
-     * 
-     * @return Enumeration
+     * @return an Enumeration over all
+     * uk.ac.vamsas.objects.core.Tree elements
      */
-    public java.util.Enumeration enumerateTree()
-    {
-        return _treeList.elements();
-    } //-- java.util.Enumeration enumerateTree() 
+    public java.util.Enumeration enumerateTree(
+    ) {
+        return this._treeList.elements();
+    }
 
     /**
-     * Note: hashCode() has not been overriden
+     * Overrides the java.lang.Object.equals method.
      * 
      * @param obj
-     * @return boolean
+     * @return true if the objects are equal.
      */
-    public boolean equals(java.lang.Object obj)
-    {
+    public boolean equals(
+            final java.lang.Object obj) {
         if ( this == obj )
             return true;
         
@@ -201,255 +191,342 @@ implements java.io.Serializable
             return true;
         }
         return false;
-    } //-- boolean equals(java.lang.Object) 
+    }
 
     /**
-     * Method getDataSet
-     * 
-     * 
+     * Method getDataSet.
      * 
      * @param index
-     * @return DataSet
-     */
-    public uk.ac.vamsas.objects.core.DataSet getDataSet(int index)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _dataSetList.size())) {
-            throw new IndexOutOfBoundsException("getDataSet: Index value '"+index+"' not in range [0.."+_dataSetList.size()+ "]");
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
+     * @return the value of the uk.ac.vamsas.objects.core.DataSet
+     * at the given index
+     */
+    public uk.ac.vamsas.objects.core.DataSet getDataSet(
+            final int index)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._dataSetList.size()) {
+            throw new IndexOutOfBoundsException("getDataSet: Index value '" + index + "' not in range [0.." + (this._dataSetList.size() - 1) + "]");
         }
         
-        return (uk.ac.vamsas.objects.core.DataSet) _dataSetList.elementAt(index);
-    } //-- uk.ac.vamsas.objects.core.DataSet getDataSet(int) 
+        return (uk.ac.vamsas.objects.core.DataSet) _dataSetList.get(index);
+    }
 
     /**
-     * Method getDataSet
-     * 
+     * Method getDataSet.Returns the contents of the collection in
+     * an Array.  <p>Note:  Just in case the collection contents
+     * are changing in another thread, we pass a 0-length Array of
+     * the correct type into the API call.  This way we <i>know</i>
+     * that the Array returned is of exactly the correct length.
      * 
-     * 
-     * @return DataSet
+     * @return this collection as an Array
      */
-    public uk.ac.vamsas.objects.core.DataSet[] getDataSet()
-    {
-        int size = _dataSetList.size();
-        uk.ac.vamsas.objects.core.DataSet[] mArray = new uk.ac.vamsas.objects.core.DataSet[size];
-        for (int index = 0; index < size; index++) {
-            mArray[index] = (uk.ac.vamsas.objects.core.DataSet) _dataSetList.elementAt(index);
-        }
-        return mArray;
-    } //-- uk.ac.vamsas.objects.core.DataSet[] getDataSet() 
+    public uk.ac.vamsas.objects.core.DataSet[] getDataSet(
+    ) {
+        uk.ac.vamsas.objects.core.DataSet[] array = new uk.ac.vamsas.objects.core.DataSet[0];
+        return (uk.ac.vamsas.objects.core.DataSet[]) this._dataSetList.toArray(array);
+    }
 
     /**
-     * Method getDataSetCount
-     * 
+     * Method getDataSetAsReference.Returns a reference to
+     * '_dataSetList'. No type checking is performed on any
+     * modifications to the Vector.
      * 
+     * @return a reference to the Vector backing this class
+     */
+    public java.util.Vector getDataSetAsReference(
+    ) {
+        return this._dataSetList;
+    }
+
+    /**
+     * Method getDataSetCount.
      * 
-     * @return int
+     * @return the size of this collection
      */
-    public int getDataSetCount()
-    {
-        return _dataSetList.size();
-    } //-- int getDataSetCount() 
+    public int getDataSetCount(
+    ) {
+        return this._dataSetList.size();
+    }
 
     /**
      * Returns the value of field 'id'. The field 'id' has the
      * following description: Primary Key for vamsas object
      * referencing 
      * 
-     * @return String
-     * @return the value of field 'id'.
+     * @return the value of field 'Id'.
      */
-    public java.lang.String getId()
-    {
+    public java.lang.String getId(
+    ) {
         return this._id;
-    } //-- java.lang.String getId() 
+    }
 
     /**
      * Returns the value of field 'modifiable'.
      * 
-     * @return String
-     * @return the value of field 'modifiable'.
+     * @return the value of field 'Modifiable'.
      */
-    public java.lang.String getModifiable()
-    {
+    public java.lang.String getModifiable(
+    ) {
         return this._modifiable;
-    } //-- java.lang.String getModifiable() 
+    }
 
     /**
-     * Method getTree
-     * 
-     * 
+     * Method getTree.
      * 
      * @param index
-     * @return Tree
-     */
-    public uk.ac.vamsas.objects.core.Tree getTree(int index)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _treeList.size())) {
-            throw new IndexOutOfBoundsException("getTree: Index value '"+index+"' not in range [0.."+_treeList.size()+ "]");
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
+     * @return the value of the uk.ac.vamsas.objects.core.Tree at
+     * the given index
+     */
+    public uk.ac.vamsas.objects.core.Tree getTree(
+            final int index)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._treeList.size()) {
+            throw new IndexOutOfBoundsException("getTree: Index value '" + index + "' not in range [0.." + (this._treeList.size() - 1) + "]");
         }
         
-        return (uk.ac.vamsas.objects.core.Tree) _treeList.elementAt(index);
-    } //-- uk.ac.vamsas.objects.core.Tree getTree(int) 
+        return (uk.ac.vamsas.objects.core.Tree) _treeList.get(index);
+    }
 
     /**
-     * Method getTree
-     * 
-     * 
+     * Method getTree.Returns the contents of the collection in an
+     * Array.  <p>Note:  Just in case the collection contents are
+     * changing in another thread, we pass a 0-length Array of the
+     * correct type into the API call.  This way we <i>know</i>
+     * that the Array returned is of exactly the correct length.
      * 
-     * @return Tree
+     * @return this collection as an Array
      */
-    public uk.ac.vamsas.objects.core.Tree[] getTree()
-    {
-        int size = _treeList.size();
-        uk.ac.vamsas.objects.core.Tree[] mArray = new uk.ac.vamsas.objects.core.Tree[size];
-        for (int index = 0; index < size; index++) {
-            mArray[index] = (uk.ac.vamsas.objects.core.Tree) _treeList.elementAt(index);
-        }
-        return mArray;
-    } //-- uk.ac.vamsas.objects.core.Tree[] getTree() 
+    public uk.ac.vamsas.objects.core.Tree[] getTree(
+    ) {
+        uk.ac.vamsas.objects.core.Tree[] array = new uk.ac.vamsas.objects.core.Tree[0];
+        return (uk.ac.vamsas.objects.core.Tree[]) this._treeList.toArray(array);
+    }
 
     /**
-     * Method getTreeCount
-     * 
-     * 
+     * Method getTreeAsReference.Returns a reference to
+     * '_treeList'. No type checking is performed on any
+     * modifications to the Vector.
      * 
-     * @return int
+     * @return a reference to the Vector backing this class
      */
-    public int getTreeCount()
-    {
-        return _treeList.size();
-    } //-- int getTreeCount() 
+    public java.util.Vector getTreeAsReference(
+    ) {
+        return this._treeList;
+    }
 
     /**
-     * Method isValid
+     * Method getTreeCount.
      * 
+     * @return the size of this collection
+     */
+    public int getTreeCount(
+    ) {
+        return this._treeList.size();
+    }
+
+    /**
+     * Overrides the java.lang.Object.hashCode method.
+     * <p>
+     * The following steps came from <b>Effective Java Programming
+     * Language Guide</b> by Joshua Bloch, Chapter 3
      * 
+     * @return a hash code value for the object.
+     */
+    public int hashCode(
+    ) {
+        int result = super.hashCode();
+        
+        long tmp;
+        if (_id != null) {
+           result = 37 * result + _id.hashCode();
+        }
+        if (_modifiable != null) {
+           result = 37 * result + _modifiable.hashCode();
+        }
+        if (_treeList != null) {
+           result = 37 * result + _treeList.hashCode();
+        }
+        if (_dataSetList != null) {
+           result = 37 * result + _dataSetList.hashCode();
+        }
+        
+        return result;
+    }
+
+    /**
+     * Method isValid.
      * 
-     * @return boolean
+     * @return true if this object is valid according to the schema
      */
-    public boolean isValid()
-    {
+    public boolean isValid(
+    ) {
         try {
             validate();
-        }
-        catch (org.exolab.castor.xml.ValidationException vex) {
+        } catch (org.exolab.castor.xml.ValidationException vex) {
             return false;
         }
         return true;
-    } //-- boolean isValid() 
+    }
 
     /**
-     * Method marshal
-     * 
      * 
      * 
      * @param out
-     */
-    public void marshal(java.io.Writer out)
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
-        
+     * @throws org.exolab.castor.xml.MarshalException if object is
+     * null or if any SAXException is thrown during marshaling
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
+     */
+    public void marshal(
+            final java.io.Writer out)
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
         Marshaller.marshal(this, out);
-    } //-- void marshal(java.io.Writer) 
+    }
 
     /**
-     * Method marshal
-     * 
      * 
      * 
      * @param handler
-     */
-    public void marshal(org.xml.sax.ContentHandler handler)
-        throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
-        
+     * @throws java.io.IOException if an IOException occurs during
+     * marshaling
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
+     * @throws org.exolab.castor.xml.MarshalException if object is
+     * null or if any SAXException is thrown during marshaling
+     */
+    public void marshal(
+            final org.xml.sax.ContentHandler handler)
+    throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
         Marshaller.marshal(this, handler);
-    } //-- void marshal(org.xml.sax.ContentHandler) 
+    }
 
     /**
-     * Method removeAllDataSet
-     * 
      */
-    public void removeAllDataSet()
-    {
-        _dataSetList.removeAllElements();
-    } //-- void removeAllDataSet() 
+    public void removeAllDataSet(
+    ) {
+        this._dataSetList.clear();
+    }
 
     /**
-     * Method removeAllTree
-     * 
      */
-    public void removeAllTree()
-    {
-        _treeList.removeAllElements();
-    } //-- void removeAllTree() 
+    public void removeAllTree(
+    ) {
+        this._treeList.clear();
+    }
 
     /**
-     * Method removeDataSet
-     * 
+     * Method removeDataSet.
      * 
+     * @param vDataSet
+     * @return true if the object was removed from the collection.
+     */
+    public boolean removeDataSet(
+            final uk.ac.vamsas.objects.core.DataSet vDataSet) {
+        boolean removed = _dataSetList.remove(vDataSet);
+        return removed;
+    }
+
+    /**
+     * Method removeDataSetAt.
      * 
      * @param index
-     * @return DataSet
+     * @return the element removed from the collection
      */
-    public uk.ac.vamsas.objects.core.DataSet removeDataSet(int index)
-    {
-        java.lang.Object obj = _dataSetList.elementAt(index);
-        _dataSetList.removeElementAt(index);
+    public uk.ac.vamsas.objects.core.DataSet removeDataSetAt(
+            final int index) {
+        java.lang.Object obj = this._dataSetList.remove(index);
         return (uk.ac.vamsas.objects.core.DataSet) obj;
-    } //-- uk.ac.vamsas.objects.core.DataSet removeDataSet(int) 
+    }
 
     /**
-     * Method removeTree
-     * 
+     * Method removeTree.
      * 
+     * @param vTree
+     * @return true if the object was removed from the collection.
+     */
+    public boolean removeTree(
+            final uk.ac.vamsas.objects.core.Tree vTree) {
+        boolean removed = _treeList.remove(vTree);
+        return removed;
+    }
+
+    /**
+     * Method removeTreeAt.
      * 
      * @param index
-     * @return Tree
+     * @return the element removed from the collection
      */
-    public uk.ac.vamsas.objects.core.Tree removeTree(int index)
-    {
-        java.lang.Object obj = _treeList.elementAt(index);
-        _treeList.removeElementAt(index);
+    public uk.ac.vamsas.objects.core.Tree removeTreeAt(
+            final int index) {
+        java.lang.Object obj = this._treeList.remove(index);
         return (uk.ac.vamsas.objects.core.Tree) obj;
-    } //-- uk.ac.vamsas.objects.core.Tree removeTree(int) 
+    }
 
     /**
-     * Method setDataSet
-     * 
      * 
      * 
      * @param index
      * @param vDataSet
-     */
-    public void setDataSet(int index, uk.ac.vamsas.objects.core.DataSet vDataSet)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _dataSetList.size())) {
-            throw new IndexOutOfBoundsException("setDataSet: Index value '"+index+"' not in range [0.."+_dataSetList.size()+ "]");
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
+     */
+    public void setDataSet(
+            final int index,
+            final uk.ac.vamsas.objects.core.DataSet vDataSet)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._dataSetList.size()) {
+            throw new IndexOutOfBoundsException("setDataSet: Index value '" + index + "' not in range [0.." + (this._dataSetList.size() - 1) + "]");
         }
-        _dataSetList.setElementAt(vDataSet, index);
-    } //-- void setDataSet(int, uk.ac.vamsas.objects.core.DataSet) 
+        
+        this._dataSetList.set(index, vDataSet);
+    }
 
     /**
-     * Method setDataSet
      * 
      * 
-     * 
-     * @param dataSetArray
+     * @param vDataSetArray
      */
-    public void setDataSet(uk.ac.vamsas.objects.core.DataSet[] dataSetArray)
-    {
+    public void setDataSet(
+            final uk.ac.vamsas.objects.core.DataSet[] vDataSetArray) {
         //-- copy array
-        _dataSetList.removeAllElements();
-        for (int i = 0; i < dataSetArray.length; i++) {
-            _dataSetList.addElement(dataSetArray[i]);
+        _dataSetList.clear();
+        
+        for (int i = 0; i < vDataSetArray.length; i++) {
+                this._dataSetList.add(vDataSetArray[i]);
         }
-    } //-- void setDataSet(uk.ac.vamsas.objects.core.DataSet) 
+    }
+
+    /**
+     * Sets the value of '_dataSetList' by copying the given
+     * Vector. All elements will be checked for type safety.
+     * 
+     * @param vDataSetList the Vector to copy.
+     */
+    public void setDataSet(
+            final java.util.Vector vDataSetList) {
+        // copy vector
+        this._dataSetList.clear();
+        
+        this._dataSetList.addAll(vDataSetList);
+    }
+
+    /**
+     * Sets the value of '_dataSetList' by setting it to the given
+     * Vector. No type checking is performed.
+     * @deprecated
+     * 
+     * @param dataSetVector the Vector to set.
+     */
+    public void setDataSetAsReference(
+            final java.util.Vector dataSetVector) {
+        this._dataSetList = dataSetVector;
+    }
 
     /**
      * Sets the value of field 'id'. The field 'id' has the
@@ -458,78 +535,109 @@ implements java.io.Serializable
      * 
      * @param id the value of field 'id'.
      */
-    public void setId(java.lang.String id)
-    {
+    public void setId(
+            final java.lang.String id) {
         this._id = id;
-    } //-- void setId(java.lang.String) 
+    }
 
     /**
      * Sets the value of field 'modifiable'.
      * 
      * @param modifiable the value of field 'modifiable'.
      */
-    public void setModifiable(java.lang.String modifiable)
-    {
+    public void setModifiable(
+            final java.lang.String modifiable) {
         this._modifiable = modifiable;
-    } //-- void setModifiable(java.lang.String) 
+    }
 
     /**
-     * Method setTree
-     * 
      * 
      * 
      * @param index
      * @param vTree
-     */
-    public void setTree(int index, uk.ac.vamsas.objects.core.Tree vTree)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _treeList.size())) {
-            throw new IndexOutOfBoundsException("setTree: Index value '"+index+"' not in range [0.."+_treeList.size()+ "]");
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
+     */
+    public void setTree(
+            final int index,
+            final uk.ac.vamsas.objects.core.Tree vTree)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._treeList.size()) {
+            throw new IndexOutOfBoundsException("setTree: Index value '" + index + "' not in range [0.." + (this._treeList.size() - 1) + "]");
         }
-        _treeList.setElementAt(vTree, index);
-    } //-- void setTree(int, uk.ac.vamsas.objects.core.Tree) 
+        
+        this._treeList.set(index, vTree);
+    }
 
     /**
-     * Method setTree
-     * 
      * 
      * 
-     * @param treeArray
+     * @param vTreeArray
      */
-    public void setTree(uk.ac.vamsas.objects.core.Tree[] treeArray)
-    {
+    public void setTree(
+            final uk.ac.vamsas.objects.core.Tree[] vTreeArray) {
         //-- copy array
-        _treeList.removeAllElements();
-        for (int i = 0; i < treeArray.length; i++) {
-            _treeList.addElement(treeArray[i]);
+        _treeList.clear();
+        
+        for (int i = 0; i < vTreeArray.length; i++) {
+                this._treeList.add(vTreeArray[i]);
         }
-    } //-- void setTree(uk.ac.vamsas.objects.core.Tree) 
+    }
 
     /**
-     * Method unmarshal
+     * Sets the value of '_treeList' by copying the given Vector.
+     * All elements will be checked for type safety.
      * 
+     * @param vTreeList the Vector to copy.
+     */
+    public void setTree(
+            final java.util.Vector vTreeList) {
+        // copy vector
+        this._treeList.clear();
+        
+        this._treeList.addAll(vTreeList);
+    }
+
+    /**
+     * Sets the value of '_treeList' by setting it to the given
+     * Vector. No type checking is performed.
+     * @deprecated
      * 
+     * @param treeVector the Vector to set.
+     */
+    public void setTreeAsReference(
+            final java.util.Vector treeVector) {
+        this._treeList = treeVector;
+    }
+
+    /**
+     * Method unmarshal.
      * 
      * @param reader
-     * @return VAMSAS
-     */
-    public static uk.ac.vamsas.objects.core.VAMSAS unmarshal(java.io.Reader reader)
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
+     * @throws org.exolab.castor.xml.MarshalException if object is
+     * null or if any SAXException is thrown during marshaling
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
+     * @return the unmarshaled uk.ac.vamsas.objects.core.VAMSAS
+     */
+    public static uk.ac.vamsas.objects.core.VAMSAS unmarshal(
+            final java.io.Reader reader)
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
         return (uk.ac.vamsas.objects.core.VAMSAS) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.VAMSAS.class, reader);
-    } //-- uk.ac.vamsas.objects.core.VAMSAS unmarshal(java.io.Reader) 
+    }
 
     /**
-     * Method validate
      * 
+     * 
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
      */
-    public void validate()
-        throws org.exolab.castor.xml.ValidationException
-    {
+    public void validate(
+    )
+    throws org.exolab.castor.xml.ValidationException {
         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
         validator.validate(this);
-    } //-- void validate() 
+    }
 
 }