updated to castor-0.9.9M2 and added some comments
[vamsas.git] / src / org / vamsas / objects / core / VAMSAS.java
index c1d4fa5..12a81f2 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * This class was automatically generated with 
- * <a href="http://www.castor.org">Castor 0.9.9M1</a>, using an XML
+ * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML
  * Schema.
  * $Id$
  */
@@ -38,9 +38,14 @@ implements java.io.Serializable
     //--------------------------/
 
     /**
-     * Field _treeList
+     * Field _id
      */
-    private java.util.Vector _treeList;
+    private java.lang.String _id;
+
+    /**
+     * Field _dendroList
+     */
+    private java.util.Vector _dendroList;
 
     /**
      * Field _sequenceSetList
@@ -55,7 +60,7 @@ implements java.io.Serializable
     public VAMSAS() 
      {
         super();
-        _treeList = new Vector();
+        _dendroList = new Vector();
         _sequenceSetList = new Vector();
     } //-- org.vamsas.objects.core.VAMSAS()
 
@@ -65,82 +70,82 @@ implements java.io.Serializable
     //-----------/
 
     /**
-     * Method addSequenceSet
+     * Method addDendro
      * 
      * 
      * 
-     * @param vSequenceSet
+     * @param vDendro
      */
-    public void addSequenceSet(org.vamsas.objects.core.SequenceSet vSequenceSet)
+    public void addDendro(org.vamsas.objects.core.Dendro vDendro)
         throws java.lang.IndexOutOfBoundsException
     {
-        _sequenceSetList.addElement(vSequenceSet);
-    } //-- void addSequenceSet(org.vamsas.objects.core.SequenceSet) 
+        _dendroList.addElement(vDendro);
+    } //-- void addDendro(org.vamsas.objects.core.Dendro) 
 
     /**
-     * Method addSequenceSet
+     * Method addDendro
      * 
      * 
      * 
      * @param index
-     * @param vSequenceSet
+     * @param vDendro
      */
-    public void addSequenceSet(int index, org.vamsas.objects.core.SequenceSet vSequenceSet)
+    public void addDendro(int index, org.vamsas.objects.core.Dendro vDendro)
         throws java.lang.IndexOutOfBoundsException
     {
-        _sequenceSetList.insertElementAt(vSequenceSet, index);
-    } //-- void addSequenceSet(int, org.vamsas.objects.core.SequenceSet) 
+        _dendroList.insertElementAt(vDendro, index);
+    } //-- void addDendro(int, org.vamsas.objects.core.Dendro) 
 
     /**
-     * Method addTree
+     * Method addSequenceSet
      * 
      * 
      * 
-     * @param vTree
+     * @param vSequenceSet
      */
-    public void addTree(java.lang.String vTree)
+    public void addSequenceSet(org.vamsas.objects.core.SequenceSet vSequenceSet)
         throws java.lang.IndexOutOfBoundsException
     {
-        _treeList.addElement(vTree);
-    } //-- void addTree(java.lang.String) 
+        _sequenceSetList.addElement(vSequenceSet);
+    } //-- void addSequenceSet(org.vamsas.objects.core.SequenceSet) 
 
     /**
-     * Method addTree
+     * Method addSequenceSet
      * 
      * 
      * 
      * @param index
-     * @param vTree
+     * @param vSequenceSet
      */
-    public void addTree(int index, java.lang.String vTree)
+    public void addSequenceSet(int index, org.vamsas.objects.core.SequenceSet vSequenceSet)
         throws java.lang.IndexOutOfBoundsException
     {
-        _treeList.insertElementAt(vTree, index);
-    } //-- void addTree(int, java.lang.String) 
+        _sequenceSetList.insertElementAt(vSequenceSet, index);
+    } //-- void addSequenceSet(int, org.vamsas.objects.core.SequenceSet) 
 
     /**
-     * Method enumerateSequenceSet
+     * Method enumerateDendro
      * 
      * 
      * 
      * @return Enumeration
      */
-    public java.util.Enumeration enumerateSequenceSet()
+    public java.util.Enumeration enumerateDendro()
     {
-        return _sequenceSetList.elements();
-    } //-- java.util.Enumeration enumerateSequenceSet() 
+        return _dendroList.elements();
+    } //-- java.util.Enumeration enumerateDendro() 
 
     /**
-     * Method enumerateTree
+     * Method enumerateSequenceSet
      * 
      * 
      * 
      * @return Enumeration
      */
-    public java.util.Enumeration enumerateTree()
+    public java.util.Enumeration enumerateSequenceSet()
     {
-        return _treeList.elements();
-    } //-- java.util.Enumeration enumerateTree() 
+        return _sequenceSetList.elements();
+    } //-- java.util.Enumeration enumerateSequenceSet() 
 
     /**
      * Note: hashCode() has not been overriden
@@ -159,12 +164,19 @@ implements java.io.Serializable
         if (obj instanceof VAMSAS) {
         
             VAMSAS temp = (VAMSAS)obj;
-            if (this._treeList != null) {
-                if (temp._treeList == null) return false;
-                else if (!(this._treeList.equals(temp._treeList))) 
+            if (this._id != null) {
+                if (temp._id == null) return false;
+                else if (!(this._id.equals(temp._id))) 
                     return false;
             }
-            else if (temp._treeList != null)
+            else if (temp._id != null)
+                return false;
+            if (this._dendroList != null) {
+                if (temp._dendroList == null) return false;
+                else if (!(this._dendroList.equals(temp._dendroList))) 
+                    return false;
+            }
+            else if (temp._dendroList != null)
                 return false;
             if (this._sequenceSetList != null) {
                 if (temp._sequenceSetList == null) return false;
@@ -179,100 +191,111 @@ implements java.io.Serializable
     } //-- boolean equals(java.lang.Object) 
 
     /**
-     * Method getSequenceSet
+     * Method getDendro
      * 
      * 
      * 
      * @param index
-     * @return SequenceSet
+     * @return Dendro
      */
-    public org.vamsas.objects.core.SequenceSet getSequenceSet(int index)
+    public org.vamsas.objects.core.Dendro getDendro(int index)
         throws java.lang.IndexOutOfBoundsException
     {
         //-- check bounds for index
-        if ((index < 0) || (index > _sequenceSetList.size())) {
-            throw new IndexOutOfBoundsException("getSequenceSet: Index value '"+index+"' not in range [0.."+_sequenceSetList.size()+ "]");
+        if ((index < 0) || (index > _dendroList.size())) {
+            throw new IndexOutOfBoundsException("getDendro: Index value '"+index+"' not in range [0.."+_dendroList.size()+ "]");
         }
         
-        return (org.vamsas.objects.core.SequenceSet) _sequenceSetList.elementAt(index);
-    } //-- org.vamsas.objects.core.SequenceSet getSequenceSet(int) 
+        return (org.vamsas.objects.core.Dendro) _dendroList.elementAt(index);
+    } //-- org.vamsas.objects.core.Dendro getDendro(int) 
 
     /**
-     * Method getSequenceSet
+     * Method getDendro
      * 
      * 
      * 
-     * @return SequenceSet
+     * @return Dendro
      */
-    public org.vamsas.objects.core.SequenceSet[] getSequenceSet()
+    public org.vamsas.objects.core.Dendro[] getDendro()
     {
-        int size = _sequenceSetList.size();
-        org.vamsas.objects.core.SequenceSet[] mArray = new org.vamsas.objects.core.SequenceSet[size];
+        int size = _dendroList.size();
+        org.vamsas.objects.core.Dendro[] mArray = new org.vamsas.objects.core.Dendro[size];
         for (int index = 0; index < size; index++) {
-            mArray[index] = (org.vamsas.objects.core.SequenceSet) _sequenceSetList.elementAt(index);
+            mArray[index] = (org.vamsas.objects.core.Dendro) _dendroList.elementAt(index);
         }
         return mArray;
-    } //-- org.vamsas.objects.core.SequenceSet[] getSequenceSet() 
+    } //-- org.vamsas.objects.core.Dendro[] getDendro() 
 
     /**
-     * Method getSequenceSetCount
+     * Method getDendroCount
      * 
      * 
      * 
      * @return int
      */
-    public int getSequenceSetCount()
+    public int getDendroCount()
     {
-        return _sequenceSetList.size();
-    } //-- int getSequenceSetCount() 
+        return _dendroList.size();
+    } //-- int getDendroCount() 
 
     /**
-     * Method getTree
+     * Returns the value of field 'id'.
+     * 
+     * @return String
+     * @return the value of field 'id'.
+     */
+    public java.lang.String getId()
+    {
+        return this._id;
+    } //-- java.lang.String getId() 
+
+    /**
+     * Method getSequenceSet
      * 
      * 
      * 
      * @param index
-     * @return String
+     * @return SequenceSet
      */
-    public java.lang.String getTree(int index)
+    public org.vamsas.objects.core.SequenceSet getSequenceSet(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()+ "]");
+        if ((index < 0) || (index > _sequenceSetList.size())) {
+            throw new IndexOutOfBoundsException("getSequenceSet: Index value '"+index+"' not in range [0.."+_sequenceSetList.size()+ "]");
         }
         
-        return (String)_treeList.elementAt(index);
-    } //-- java.lang.String getTree(int) 
+        return (org.vamsas.objects.core.SequenceSet) _sequenceSetList.elementAt(index);
+    } //-- org.vamsas.objects.core.SequenceSet getSequenceSet(int) 
 
     /**
-     * Method getTree
+     * Method getSequenceSet
      * 
      * 
      * 
-     * @return String
+     * @return SequenceSet
      */
-    public java.lang.String[] getTree()
+    public org.vamsas.objects.core.SequenceSet[] getSequenceSet()
     {
-        int size = _treeList.size();
-        java.lang.String[] mArray = new java.lang.String[size];
+        int size = _sequenceSetList.size();
+        org.vamsas.objects.core.SequenceSet[] mArray = new org.vamsas.objects.core.SequenceSet[size];
         for (int index = 0; index < size; index++) {
-            mArray[index] = (String)_treeList.elementAt(index);
+            mArray[index] = (org.vamsas.objects.core.SequenceSet) _sequenceSetList.elementAt(index);
         }
         return mArray;
-    } //-- java.lang.String[] getTree() 
+    } //-- org.vamsas.objects.core.SequenceSet[] getSequenceSet() 
 
     /**
-     * Method getTreeCount
+     * Method getSequenceSetCount
      * 
      * 
      * 
      * @return int
      */
-    public int getTreeCount()
+    public int getSequenceSetCount()
     {
-        return _treeList.size();
-    } //-- int getTreeCount() 
+        return _sequenceSetList.size();
+    } //-- int getSequenceSetCount() 
 
     /**
      * Method isValid
@@ -321,6 +344,15 @@ implements java.io.Serializable
     } //-- void marshal(org.xml.sax.ContentHandler) 
 
     /**
+     * Method removeAllDendro
+     * 
+     */
+    public void removeAllDendro()
+    {
+        _dendroList.removeAllElements();
+    } //-- void removeAllDendro() 
+
+    /**
      * Method removeAllSequenceSet
      * 
      */
@@ -330,13 +362,19 @@ implements java.io.Serializable
     } //-- void removeAllSequenceSet() 
 
     /**
-     * Method removeAllTree
+     * Method removeDendro
+     * 
      * 
+     * 
+     * @param index
+     * @return Dendro
      */
-    public void removeAllTree()
+    public org.vamsas.objects.core.Dendro removeDendro(int index)
     {
-        _treeList.removeAllElements();
-    } //-- void removeAllTree() 
+        java.lang.Object obj = _dendroList.elementAt(index);
+        _dendroList.removeElementAt(index);
+        return (org.vamsas.objects.core.Dendro) obj;
+    } //-- org.vamsas.objects.core.Dendro removeDendro(int) 
 
     /**
      * Method removeSequenceSet
@@ -354,19 +392,48 @@ implements java.io.Serializable
     } //-- org.vamsas.objects.core.SequenceSet removeSequenceSet(int) 
 
     /**
-     * Method removeTree
+     * Method setDendro
      * 
      * 
      * 
      * @param index
-     * @return String
+     * @param vDendro
+     */
+    public void setDendro(int index, org.vamsas.objects.core.Dendro vDendro)
+        throws java.lang.IndexOutOfBoundsException
+    {
+        //-- check bounds for index
+        if ((index < 0) || (index > _dendroList.size())) {
+            throw new IndexOutOfBoundsException("setDendro: Index value '"+index+"' not in range [0.."+_dendroList.size()+ "]");
+        }
+        _dendroList.setElementAt(vDendro, index);
+    } //-- void setDendro(int, org.vamsas.objects.core.Dendro) 
+
+    /**
+     * Method setDendro
+     * 
+     * 
+     * 
+     * @param dendroArray
+     */
+    public void setDendro(org.vamsas.objects.core.Dendro[] dendroArray)
+    {
+        //-- copy array
+        _dendroList.removeAllElements();
+        for (int i = 0; i < dendroArray.length; i++) {
+            _dendroList.addElement(dendroArray[i]);
+        }
+    } //-- void setDendro(org.vamsas.objects.core.Dendro) 
+
+    /**
+     * Sets the value of field 'id'.
+     * 
+     * @param id the value of field 'id'.
      */
-    public java.lang.String removeTree(int index)
+    public void setId(java.lang.String id)
     {
-        java.lang.Object obj = _treeList.elementAt(index);
-        _treeList.removeElementAt(index);
-        return (String)obj;
-    } //-- java.lang.String removeTree(int) 
+        this._id = id;
+    } //-- void setId(java.lang.String) 
 
     /**
      * Method setSequenceSet
@@ -403,40 +470,6 @@ implements java.io.Serializable
     } //-- void setSequenceSet(org.vamsas.objects.core.SequenceSet) 
 
     /**
-     * Method setTree
-     * 
-     * 
-     * 
-     * @param index
-     * @param vTree
-     */
-    public void setTree(int index, java.lang.String 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()+ "]");
-        }
-        _treeList.setElementAt(vTree, index);
-    } //-- void setTree(int, java.lang.String) 
-
-    /**
-     * Method setTree
-     * 
-     * 
-     * 
-     * @param treeArray
-     */
-    public void setTree(java.lang.String[] treeArray)
-    {
-        //-- copy array
-        _treeList.removeAllElements();
-        for (int i = 0; i < treeArray.length; i++) {
-            _treeList.addElement(treeArray[i]);
-        }
-    } //-- void setTree(java.lang.String) 
-
-    /**
      * Method unmarshal
      * 
      *