javadoc todo
[vamsas.git] / src / uk / ac / vamsas / objects / core / Entry.java
index 6def10e..ec6444b 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;
 
 /**
  * Class Entry.
@@ -59,7 +50,7 @@ implements java.io.Serializable
     private java.lang.String _action;
 
     /**
-     * When 
+     * When : TODO: change to dateTime for release 
      */
     private org.exolab.castor.types.Date _date;
 
@@ -84,13 +75,12 @@ implements java.io.Serializable
      //- Constructors -/
     //----------------/
 
-    public Entry() 
-     {
+    public Entry() {
         super();
-        _propertyList = new Vector();
-        _paramList = new Vector();
-        _inputList = new Vector();
-    } //-- uk.ac.vamsas.objects.core.Entry()
+        this._propertyList = new java.util.Vector();
+        this._paramList = new java.util.Vector();
+        this._inputList = new java.util.Vector();
+    }
 
 
       //-----------/
@@ -98,130 +88,130 @@ implements java.io.Serializable
     //-----------/
 
     /**
-     * Method addInput
-     * 
      * 
      * 
      * @param vInput
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addInput(uk.ac.vamsas.objects.core.Input vInput)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _inputList.addElement(vInput);
-    } //-- void addInput(uk.ac.vamsas.objects.core.Input) 
+    public void addInput(
+            final uk.ac.vamsas.objects.core.Input vInput)
+    throws java.lang.IndexOutOfBoundsException {
+        this._inputList.addElement(vInput);
+    }
 
     /**
-     * Method addInput
-     * 
      * 
      * 
      * @param index
      * @param vInput
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addInput(int index, uk.ac.vamsas.objects.core.Input vInput)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _inputList.insertElementAt(vInput, index);
-    } //-- void addInput(int, uk.ac.vamsas.objects.core.Input) 
+    public void addInput(
+            final int index,
+            final uk.ac.vamsas.objects.core.Input vInput)
+    throws java.lang.IndexOutOfBoundsException {
+        this._inputList.add(index, vInput);
+    }
 
     /**
-     * Method addParam
-     * 
      * 
      * 
      * @param vParam
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addParam(uk.ac.vamsas.objects.core.Param vParam)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _paramList.addElement(vParam);
-    } //-- void addParam(uk.ac.vamsas.objects.core.Param) 
+    public void addParam(
+            final uk.ac.vamsas.objects.core.Param vParam)
+    throws java.lang.IndexOutOfBoundsException {
+        this._paramList.addElement(vParam);
+    }
 
     /**
-     * Method addParam
-     * 
      * 
      * 
      * @param index
      * @param vParam
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addParam(int index, uk.ac.vamsas.objects.core.Param vParam)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _paramList.insertElementAt(vParam, index);
-    } //-- void addParam(int, uk.ac.vamsas.objects.core.Param) 
+    public void addParam(
+            final int index,
+            final uk.ac.vamsas.objects.core.Param vParam)
+    throws java.lang.IndexOutOfBoundsException {
+        this._paramList.add(index, vParam);
+    }
 
     /**
-     * Method addProperty
-     * 
      * 
      * 
      * @param vProperty
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addProperty(uk.ac.vamsas.objects.core.Property vProperty)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _propertyList.addElement(vProperty);
-    } //-- void addProperty(uk.ac.vamsas.objects.core.Property) 
+    public void addProperty(
+            final uk.ac.vamsas.objects.core.Property vProperty)
+    throws java.lang.IndexOutOfBoundsException {
+        this._propertyList.addElement(vProperty);
+    }
 
     /**
-     * Method addProperty
-     * 
      * 
      * 
      * @param index
      * @param vProperty
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addProperty(int index, uk.ac.vamsas.objects.core.Property vProperty)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _propertyList.insertElementAt(vProperty, index);
-    } //-- void addProperty(int, uk.ac.vamsas.objects.core.Property) 
+    public void addProperty(
+            final int index,
+            final uk.ac.vamsas.objects.core.Property vProperty)
+    throws java.lang.IndexOutOfBoundsException {
+        this._propertyList.add(index, vProperty);
+    }
 
     /**
-     * Method enumerateInput
-     * 
-     * 
+     * Method enumerateInput.
      * 
-     * @return Enumeration
+     * @return an Enumeration over all
+     * uk.ac.vamsas.objects.core.Input elements
      */
-    public java.util.Enumeration enumerateInput()
-    {
-        return _inputList.elements();
-    } //-- java.util.Enumeration enumerateInput() 
+    public java.util.Enumeration enumerateInput(
+    ) {
+        return this._inputList.elements();
+    }
 
     /**
-     * Method enumerateParam
+     * Method enumerateParam.
      * 
-     * 
-     * 
-     * @return Enumeration
+     * @return an Enumeration over all
+     * uk.ac.vamsas.objects.core.Param elements
      */
-    public java.util.Enumeration enumerateParam()
-    {
-        return _paramList.elements();
-    } //-- java.util.Enumeration enumerateParam() 
+    public java.util.Enumeration enumerateParam(
+    ) {
+        return this._paramList.elements();
+    }
 
     /**
-     * Method enumerateProperty
-     * 
-     * 
+     * Method enumerateProperty.
      * 
-     * @return Enumeration
+     * @return an Enumeration over all
+     * uk.ac.vamsas.objects.core.Property elements
      */
-    public java.util.Enumeration enumerateProperty()
-    {
-        return _propertyList.elements();
-    } //-- java.util.Enumeration enumerateProperty() 
+    public java.util.Enumeration enumerateProperty(
+    ) {
+        return this._propertyList.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;
         
@@ -290,43 +280,41 @@ implements java.io.Serializable
             return true;
         }
         return false;
-    } //-- boolean equals(java.lang.Object) 
+    }
 
     /**
      * Returns the value of field 'action'. The field 'action' has
      * the following description: Did what 
      * 
-     * @return String
-     * @return the value of field 'action'.
+     * @return the value of field 'Action'.
      */
-    public java.lang.String getAction()
-    {
+    public java.lang.String getAction(
+    ) {
         return this._action;
-    } //-- java.lang.String getAction() 
+    }
 
     /**
      * Returns the value of field 'app'. The field 'app' has the
      * following description: With which application 
      * 
-     * @return String
-     * @return the value of field 'app'.
+     * @return the value of field 'App'.
      */
-    public java.lang.String getApp()
-    {
+    public java.lang.String getApp(
+    ) {
         return this._app;
-    } //-- java.lang.String getApp() 
+    }
 
     /**
      * Returns the value of field 'date'. The field 'date' has the
-     * following description: When 
+     * following description: When : TODO: change to dateTime for
+     * release 
      * 
-     * @return Date
-     * @return the value of field 'date'.
+     * @return the value of field 'Date'.
      */
-    public org.exolab.castor.types.Date getDate()
-    {
+    public org.exolab.castor.types.Date getDate(
+    ) {
         return this._date;
-    } //-- org.exolab.castor.types.Date getDate() 
+    }
 
     /**
      * Returns the value of field 'id'. The field 'id' has the
@@ -334,287 +322,375 @@ implements java.io.Serializable
      * 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() 
+    }
 
     /**
-     * Method getInput
-     * 
-     * 
+     * Method getInput.
      * 
      * @param index
-     * @return Input
-     */
-    public uk.ac.vamsas.objects.core.Input getInput(int index)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _inputList.size())) {
-            throw new IndexOutOfBoundsException("getInput: Index value '"+index+"' not in range [0.."+_inputList.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.Input at
+     * the given index
+     */
+    public uk.ac.vamsas.objects.core.Input getInput(
+            final int index)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._inputList.size()) {
+            throw new IndexOutOfBoundsException("getInput: Index value '" + index + "' not in range [0.." + (this._inputList.size() - 1) + "]");
         }
         
-        return (uk.ac.vamsas.objects.core.Input) _inputList.elementAt(index);
-    } //-- uk.ac.vamsas.objects.core.Input getInput(int) 
+        return (uk.ac.vamsas.objects.core.Input) _inputList.get(index);
+    }
 
     /**
-     * Method getInput
-     * 
+     * Method getInput.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 Input
+     * @return this collection as an Array
      */
-    public uk.ac.vamsas.objects.core.Input[] getInput()
-    {
-        int size = _inputList.size();
-        uk.ac.vamsas.objects.core.Input[] mArray = new uk.ac.vamsas.objects.core.Input[size];
-        for (int index = 0; index < size; index++) {
-            mArray[index] = (uk.ac.vamsas.objects.core.Input) _inputList.elementAt(index);
-        }
-        return mArray;
-    } //-- uk.ac.vamsas.objects.core.Input[] getInput() 
+    public uk.ac.vamsas.objects.core.Input[] getInput(
+    ) {
+        uk.ac.vamsas.objects.core.Input[] array = new uk.ac.vamsas.objects.core.Input[0];
+        return (uk.ac.vamsas.objects.core.Input[]) this._inputList.toArray(array);
+    }
 
     /**
-     * Method getInputCount
-     * 
-     * 
+     * Method getInputAsReference.Returns a reference to
+     * '_inputList'. No type checking is performed on any
+     * modifications to the Vector.
      * 
-     * @return int
+     * @return a reference to the Vector backing this class
      */
-    public int getInputCount()
-    {
-        return _inputList.size();
-    } //-- int getInputCount() 
+    public java.util.Vector getInputAsReference(
+    ) {
+        return this._inputList;
+    }
 
     /**
-     * Method getParam
-     * 
+     * Method getInputCount.
      * 
+     * @return the size of this collection
+     */
+    public int getInputCount(
+    ) {
+        return this._inputList.size();
+    }
+
+    /**
+     * Method getParam.
      * 
      * @param index
-     * @return Param
-     */
-    public uk.ac.vamsas.objects.core.Param getParam(int index)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _paramList.size())) {
-            throw new IndexOutOfBoundsException("getParam: Index value '"+index+"' not in range [0.."+_paramList.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.Param at
+     * the given index
+     */
+    public uk.ac.vamsas.objects.core.Param getParam(
+            final int index)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._paramList.size()) {
+            throw new IndexOutOfBoundsException("getParam: Index value '" + index + "' not in range [0.." + (this._paramList.size() - 1) + "]");
         }
         
-        return (uk.ac.vamsas.objects.core.Param) _paramList.elementAt(index);
-    } //-- uk.ac.vamsas.objects.core.Param getParam(int) 
+        return (uk.ac.vamsas.objects.core.Param) _paramList.get(index);
+    }
 
     /**
-     * Method getParam
+     * Method getParam.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 Param
+     * @return this collection as an Array
      */
-    public uk.ac.vamsas.objects.core.Param[] getParam()
-    {
-        int size = _paramList.size();
-        uk.ac.vamsas.objects.core.Param[] mArray = new uk.ac.vamsas.objects.core.Param[size];
-        for (int index = 0; index < size; index++) {
-            mArray[index] = (uk.ac.vamsas.objects.core.Param) _paramList.elementAt(index);
-        }
-        return mArray;
-    } //-- uk.ac.vamsas.objects.core.Param[] getParam() 
+    public uk.ac.vamsas.objects.core.Param[] getParam(
+    ) {
+        uk.ac.vamsas.objects.core.Param[] array = new uk.ac.vamsas.objects.core.Param[0];
+        return (uk.ac.vamsas.objects.core.Param[]) this._paramList.toArray(array);
+    }
 
     /**
-     * Method getParamCount
-     * 
+     * Method getParamAsReference.Returns a reference to
+     * '_paramList'. No type checking is performed on any
+     * modifications to the Vector.
      * 
-     * 
-     * @return int
+     * @return a reference to the Vector backing this class
      */
-    public int getParamCount()
-    {
-        return _paramList.size();
-    } //-- int getParamCount() 
+    public java.util.Vector getParamAsReference(
+    ) {
+        return this._paramList;
+    }
 
     /**
-     * Method getProperty
-     * 
+     * Method getParamCount.
      * 
+     * @return the size of this collection
+     */
+    public int getParamCount(
+    ) {
+        return this._paramList.size();
+    }
+
+    /**
+     * Method getProperty.
      * 
      * @param index
-     * @return Property
-     */
-    public uk.ac.vamsas.objects.core.Property getProperty(int index)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _propertyList.size())) {
-            throw new IndexOutOfBoundsException("getProperty: Index value '"+index+"' not in range [0.."+_propertyList.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.Property
+     * at the given index
+     */
+    public uk.ac.vamsas.objects.core.Property getProperty(
+            final int index)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._propertyList.size()) {
+            throw new IndexOutOfBoundsException("getProperty: Index value '" + index + "' not in range [0.." + (this._propertyList.size() - 1) + "]");
         }
         
-        return (uk.ac.vamsas.objects.core.Property) _propertyList.elementAt(index);
-    } //-- uk.ac.vamsas.objects.core.Property getProperty(int) 
+        return (uk.ac.vamsas.objects.core.Property) _propertyList.get(index);
+    }
 
     /**
-     * Method getProperty
-     * 
-     * 
+     * Method getProperty.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 Property
+     * @return this collection as an Array
      */
-    public uk.ac.vamsas.objects.core.Property[] getProperty()
-    {
-        int size = _propertyList.size();
-        uk.ac.vamsas.objects.core.Property[] mArray = new uk.ac.vamsas.objects.core.Property[size];
-        for (int index = 0; index < size; index++) {
-            mArray[index] = (uk.ac.vamsas.objects.core.Property) _propertyList.elementAt(index);
-        }
-        return mArray;
-    } //-- uk.ac.vamsas.objects.core.Property[] getProperty() 
+    public uk.ac.vamsas.objects.core.Property[] getProperty(
+    ) {
+        uk.ac.vamsas.objects.core.Property[] array = new uk.ac.vamsas.objects.core.Property[0];
+        return (uk.ac.vamsas.objects.core.Property[]) this._propertyList.toArray(array);
+    }
 
     /**
-     * Method getPropertyCount
-     * 
+     * Method getPropertyAsReference.Returns a reference to
+     * '_propertyList'. No type checking is performed on any
+     * modifications to the Vector.
      * 
+     * @return a reference to the Vector backing this class
+     */
+    public java.util.Vector getPropertyAsReference(
+    ) {
+        return this._propertyList;
+    }
+
+    /**
+     * Method getPropertyCount.
      * 
-     * @return int
+     * @return the size of this collection
      */
-    public int getPropertyCount()
-    {
-        return _propertyList.size();
-    } //-- int getPropertyCount() 
+    public int getPropertyCount(
+    ) {
+        return this._propertyList.size();
+    }
 
     /**
      * Returns the value of field 'user'. The field 'user' has the
      * following description: Who 
      * 
-     * @return String
-     * @return the value of field 'user'.
+     * @return the value of field 'User'.
      */
-    public java.lang.String getUser()
-    {
+    public java.lang.String getUser(
+    ) {
         return this._user;
-    } //-- java.lang.String getUser() 
+    }
 
     /**
-     * Method isValid
-     * 
+     * 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 (_user != null) {
+           result = 37 * result + _user.hashCode();
+        }
+        if (_app != null) {
+           result = 37 * result + _app.hashCode();
+        }
+        if (_action != null) {
+           result = 37 * result + _action.hashCode();
+        }
+        if (_date != null) {
+           result = 37 * result + _date.hashCode();
+        }
+        if (_propertyList != null) {
+           result = 37 * result + _propertyList.hashCode();
+        }
+        if (_paramList != null) {
+           result = 37 * result + _paramList.hashCode();
+        }
+        if (_inputList != null) {
+           result = 37 * result + _inputList.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 removeAllInput
-     * 
      */
-    public void removeAllInput()
-    {
-        _inputList.removeAllElements();
-    } //-- void removeAllInput() 
+    public void removeAllInput(
+    ) {
+        this._inputList.clear();
+    }
 
     /**
-     * Method removeAllParam
-     * 
      */
-    public void removeAllParam()
-    {
-        _paramList.removeAllElements();
-    } //-- void removeAllParam() 
+    public void removeAllParam(
+    ) {
+        this._paramList.clear();
+    }
 
     /**
-     * Method removeAllProperty
-     * 
      */
-    public void removeAllProperty()
-    {
-        _propertyList.removeAllElements();
-    } //-- void removeAllProperty() 
+    public void removeAllProperty(
+    ) {
+        this._propertyList.clear();
+    }
 
     /**
-     * Method removeInput
-     * 
+     * Method removeInput.
      * 
+     * @param vInput
+     * @return true if the object was removed from the collection.
+     */
+    public boolean removeInput(
+            final uk.ac.vamsas.objects.core.Input vInput) {
+        boolean removed = _inputList.remove(vInput);
+        return removed;
+    }
+
+    /**
+     * Method removeInputAt.
      * 
      * @param index
-     * @return Input
+     * @return the element removed from the collection
      */
-    public uk.ac.vamsas.objects.core.Input removeInput(int index)
-    {
-        java.lang.Object obj = _inputList.elementAt(index);
-        _inputList.removeElementAt(index);
+    public uk.ac.vamsas.objects.core.Input removeInputAt(
+            final int index) {
+        java.lang.Object obj = this._inputList.remove(index);
         return (uk.ac.vamsas.objects.core.Input) obj;
-    } //-- uk.ac.vamsas.objects.core.Input removeInput(int) 
+    }
 
     /**
-     * Method removeParam
-     * 
+     * Method removeParam.
      * 
+     * @param vParam
+     * @return true if the object was removed from the collection.
+     */
+    public boolean removeParam(
+            final uk.ac.vamsas.objects.core.Param vParam) {
+        boolean removed = _paramList.remove(vParam);
+        return removed;
+    }
+
+    /**
+     * Method removeParamAt.
      * 
      * @param index
-     * @return Param
+     * @return the element removed from the collection
      */
-    public uk.ac.vamsas.objects.core.Param removeParam(int index)
-    {
-        java.lang.Object obj = _paramList.elementAt(index);
-        _paramList.removeElementAt(index);
+    public uk.ac.vamsas.objects.core.Param removeParamAt(
+            final int index) {
+        java.lang.Object obj = this._paramList.remove(index);
         return (uk.ac.vamsas.objects.core.Param) obj;
-    } //-- uk.ac.vamsas.objects.core.Param removeParam(int) 
+    }
 
     /**
-     * Method removeProperty
-     * 
+     * Method removeProperty.
      * 
+     * @param vProperty
+     * @return true if the object was removed from the collection.
+     */
+    public boolean removeProperty(
+            final uk.ac.vamsas.objects.core.Property vProperty) {
+        boolean removed = _propertyList.remove(vProperty);
+        return removed;
+    }
+
+    /**
+     * Method removePropertyAt.
      * 
      * @param index
-     * @return Property
+     * @return the element removed from the collection
      */
-    public uk.ac.vamsas.objects.core.Property removeProperty(int index)
-    {
-        java.lang.Object obj = _propertyList.elementAt(index);
-        _propertyList.removeElementAt(index);
+    public uk.ac.vamsas.objects.core.Property removePropertyAt(
+            final int index) {
+        java.lang.Object obj = this._propertyList.remove(index);
         return (uk.ac.vamsas.objects.core.Property) obj;
-    } //-- uk.ac.vamsas.objects.core.Property removeProperty(int) 
+    }
 
     /**
      * Sets the value of field 'action'. The field 'action' has the
@@ -622,10 +698,10 @@ implements java.io.Serializable
      * 
      * @param action the value of field 'action'.
      */
-    public void setAction(java.lang.String action)
-    {
+    public void setAction(
+            final java.lang.String action) {
         this._action = action;
-    } //-- void setAction(java.lang.String) 
+    }
 
     /**
      * Sets the value of field 'app'. The field 'app' has the
@@ -633,21 +709,22 @@ implements java.io.Serializable
      * 
      * @param app the value of field 'app'.
      */
-    public void setApp(java.lang.String app)
-    {
+    public void setApp(
+            final java.lang.String app) {
         this._app = app;
-    } //-- void setApp(java.lang.String) 
+    }
 
     /**
      * Sets the value of field 'date'. The field 'date' has the
-     * following description: When 
+     * following description: When : TODO: change to dateTime for
+     * release 
      * 
      * @param date the value of field 'date'.
      */
-    public void setDate(org.exolab.castor.types.Date date)
-    {
+    public void setDate(
+            final org.exolab.castor.types.Date date) {
         this._date = date;
-    } //-- void setDate(org.exolab.castor.types.Date) 
+    }
 
     /**
      * Sets the value of field 'id'. The field 'id' has the
@@ -657,112 +734,193 @@ 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) 
+    }
 
     /**
-     * Method setInput
-     * 
      * 
      * 
      * @param index
      * @param vInput
-     */
-    public void setInput(int index, uk.ac.vamsas.objects.core.Input vInput)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _inputList.size())) {
-            throw new IndexOutOfBoundsException("setInput: Index value '"+index+"' not in range [0.."+_inputList.size()+ "]");
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
+     */
+    public void setInput(
+            final int index,
+            final uk.ac.vamsas.objects.core.Input vInput)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._inputList.size()) {
+            throw new IndexOutOfBoundsException("setInput: Index value '" + index + "' not in range [0.." + (this._inputList.size() - 1) + "]");
         }
-        _inputList.setElementAt(vInput, index);
-    } //-- void setInput(int, uk.ac.vamsas.objects.core.Input) 
+        
+        this._inputList.set(index, vInput);
+    }
 
     /**
-     * Method setInput
      * 
      * 
-     * 
-     * @param inputArray
+     * @param vInputArray
      */
-    public void setInput(uk.ac.vamsas.objects.core.Input[] inputArray)
-    {
+    public void setInput(
+            final uk.ac.vamsas.objects.core.Input[] vInputArray) {
         //-- copy array
-        _inputList.removeAllElements();
-        for (int i = 0; i < inputArray.length; i++) {
-            _inputList.addElement(inputArray[i]);
+        _inputList.clear();
+        
+        for (int i = 0; i < vInputArray.length; i++) {
+                this._inputList.add(vInputArray[i]);
         }
-    } //-- void setInput(uk.ac.vamsas.objects.core.Input) 
+    }
 
     /**
-     * Method setParam
+     * Sets the value of '_inputList' by copying the given Vector.
+     * All elements will be checked for type safety.
      * 
+     * @param vInputList the Vector to copy.
+     */
+    public void setInput(
+            final java.util.Vector vInputList) {
+        // copy vector
+        this._inputList.clear();
+        
+        this._inputList.addAll(vInputList);
+    }
+
+    /**
+     * Sets the value of '_inputList' by setting it to the given
+     * Vector. No type checking is performed.
+     * @deprecated
+     * 
+     * @param inputVector the Vector to set.
+     */
+    public void setInputAsReference(
+            final java.util.Vector inputVector) {
+        this._inputList = inputVector;
+    }
+
+    /**
      * 
      * 
      * @param index
      * @param vParam
-     */
-    public void setParam(int index, uk.ac.vamsas.objects.core.Param vParam)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _paramList.size())) {
-            throw new IndexOutOfBoundsException("setParam: Index value '"+index+"' not in range [0.."+_paramList.size()+ "]");
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
+     */
+    public void setParam(
+            final int index,
+            final uk.ac.vamsas.objects.core.Param vParam)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._paramList.size()) {
+            throw new IndexOutOfBoundsException("setParam: Index value '" + index + "' not in range [0.." + (this._paramList.size() - 1) + "]");
         }
-        _paramList.setElementAt(vParam, index);
-    } //-- void setParam(int, uk.ac.vamsas.objects.core.Param) 
+        
+        this._paramList.set(index, vParam);
+    }
 
     /**
-     * Method setParam
-     * 
      * 
      * 
-     * @param paramArray
+     * @param vParamArray
      */
-    public void setParam(uk.ac.vamsas.objects.core.Param[] paramArray)
-    {
+    public void setParam(
+            final uk.ac.vamsas.objects.core.Param[] vParamArray) {
         //-- copy array
-        _paramList.removeAllElements();
-        for (int i = 0; i < paramArray.length; i++) {
-            _paramList.addElement(paramArray[i]);
+        _paramList.clear();
+        
+        for (int i = 0; i < vParamArray.length; i++) {
+                this._paramList.add(vParamArray[i]);
         }
-    } //-- void setParam(uk.ac.vamsas.objects.core.Param) 
+    }
 
     /**
-     * Method setProperty
+     * Sets the value of '_paramList' by copying the given Vector.
+     * All elements will be checked for type safety.
      * 
+     * @param vParamList the Vector to copy.
+     */
+    public void setParam(
+            final java.util.Vector vParamList) {
+        // copy vector
+        this._paramList.clear();
+        
+        this._paramList.addAll(vParamList);
+    }
+
+    /**
+     * Sets the value of '_paramList' by setting it to the given
+     * Vector. No type checking is performed.
+     * @deprecated
+     * 
+     * @param paramVector the Vector to set.
+     */
+    public void setParamAsReference(
+            final java.util.Vector paramVector) {
+        this._paramList = paramVector;
+    }
+
+    /**
      * 
      * 
      * @param index
      * @param vProperty
-     */
-    public void setProperty(int index, uk.ac.vamsas.objects.core.Property vProperty)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _propertyList.size())) {
-            throw new IndexOutOfBoundsException("setProperty: Index value '"+index+"' not in range [0.."+_propertyList.size()+ "]");
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
+     */
+    public void setProperty(
+            final int index,
+            final uk.ac.vamsas.objects.core.Property vProperty)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._propertyList.size()) {
+            throw new IndexOutOfBoundsException("setProperty: Index value '" + index + "' not in range [0.." + (this._propertyList.size() - 1) + "]");
         }
-        _propertyList.setElementAt(vProperty, index);
-    } //-- void setProperty(int, uk.ac.vamsas.objects.core.Property) 
+        
+        this._propertyList.set(index, vProperty);
+    }
 
     /**
-     * Method setProperty
      * 
      * 
-     * 
-     * @param propertyArray
+     * @param vPropertyArray
      */
-    public void setProperty(uk.ac.vamsas.objects.core.Property[] propertyArray)
-    {
+    public void setProperty(
+            final uk.ac.vamsas.objects.core.Property[] vPropertyArray) {
         //-- copy array
-        _propertyList.removeAllElements();
-        for (int i = 0; i < propertyArray.length; i++) {
-            _propertyList.addElement(propertyArray[i]);
+        _propertyList.clear();
+        
+        for (int i = 0; i < vPropertyArray.length; i++) {
+                this._propertyList.add(vPropertyArray[i]);
         }
-    } //-- void setProperty(uk.ac.vamsas.objects.core.Property) 
+    }
+
+    /**
+     * Sets the value of '_propertyList' by copying the given
+     * Vector. All elements will be checked for type safety.
+     * 
+     * @param vPropertyList the Vector to copy.
+     */
+    public void setProperty(
+            final java.util.Vector vPropertyList) {
+        // copy vector
+        this._propertyList.clear();
+        
+        this._propertyList.addAll(vPropertyList);
+    }
+
+    /**
+     * Sets the value of '_propertyList' by setting it to the given
+     * Vector. No type checking is performed.
+     * @deprecated
+     * 
+     * @param propertyVector the Vector to set.
+     */
+    public void setPropertyAsReference(
+            final java.util.Vector propertyVector) {
+        this._propertyList = propertyVector;
+    }
 
     /**
      * Sets the value of field 'user'. The field 'user' has the
@@ -770,34 +928,38 @@ implements java.io.Serializable
      * 
      * @param user the value of field 'user'.
      */
-    public void setUser(java.lang.String user)
-    {
+    public void setUser(
+            final java.lang.String user) {
         this._user = user;
-    } //-- void setUser(java.lang.String) 
+    }
 
     /**
-     * Method unmarshal
-     * 
-     * 
+     * Method unmarshal.
      * 
      * @param reader
-     * @return Entry
-     */
-    public static uk.ac.vamsas.objects.core.Entry 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.Entry
+     */
+    public static uk.ac.vamsas.objects.core.Entry unmarshal(
+            final java.io.Reader reader)
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
         return (uk.ac.vamsas.objects.core.Entry) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Entry.class, reader);
-    } //-- uk.ac.vamsas.objects.core.Entry 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() 
+    }
 
 }