schema changes: provenance-entry-date is now an xmlSchema:dateTime bound directly...
[vamsas.git] / src / uk / ac / vamsas / objects / core / Input.java
index db1af9e..3ad7a8e 100644 (file)
@@ -1,6 +1,6 @@
 /*\r
  * This class was automatically generated with \r
- * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML\r
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
  * Schema.\r
  * $Id$\r
  */\r
@@ -11,15 +11,8 @@ package uk.ac.vamsas.objects.core;
  //- Imported classes and packages -/\r
 //---------------------------------/\r
 \r
-import java.io.IOException;\r
-import java.io.Reader;\r
-import java.io.Serializable;\r
-import java.io.Writer;\r
-import org.exolab.castor.xml.MarshalException;\r
 import org.exolab.castor.xml.Marshaller;\r
 import org.exolab.castor.xml.Unmarshaller;\r
-import org.exolab.castor.xml.ValidationException;\r
-import org.xml.sax.ContentHandler;\r
 \r
 /**\r
  * Class Input.\r
@@ -36,7 +29,7 @@ implements java.io.Serializable
     //--------------------------/\r
 \r
     /**\r
-     * Field _name\r
+     * Field _name.\r
      */\r
     private java.lang.String _name;\r
 \r
@@ -44,17 +37,17 @@ implements java.io.Serializable
      * Reference Frame for rangeType specfication\r
      *  \r
      */\r
-    private java.lang.Object _objRef;\r
+    private java.util.Vector _objRef;\r
 \r
 \r
       //----------------/\r
      //- Constructors -/\r
     //----------------/\r
 \r
-    public Input() \r
-     {\r
+    public Input() {\r
         super();\r
-    } //-- uk.ac.vamsas.objects.core.Input()\r
+        this._objRef = new java.util.Vector();\r
+    }\r
 \r
 \r
       //-----------/\r
@@ -62,13 +55,51 @@ implements java.io.Serializable
     //-----------/\r
 \r
     /**\r
-     * Note: hashCode() has not been overriden\r
+     * \r
+     * \r
+     * @param vObjRef\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     */\r
+    public void addObjRef(\r
+            final java.lang.Object vObjRef)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._objRef.addElement(vObjRef);\r
+    }\r
+\r
+    /**\r
+     * \r
+     * \r
+     * @param index\r
+     * @param vObjRef\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     */\r
+    public void addObjRef(\r
+            final int index,\r
+            final java.lang.Object vObjRef)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._objRef.add(index, vObjRef);\r
+    }\r
+\r
+    /**\r
+     * Method enumerateObjRef.\r
+     * \r
+     * @return an Enumeration over all java.lang.Object elements\r
+     */\r
+    public java.util.Enumeration enumerateObjRef(\r
+    ) {\r
+        return this._objRef.elements();\r
+    }\r
+\r
+    /**\r
+     * Overrides the java.lang.Object.equals method.\r
      * \r
      * @param obj\r
-     * @return boolean\r
+     * @return true if the objects are equal.\r
      */\r
-    public boolean equals(java.lang.Object obj)\r
-    {\r
+    public boolean equals(\r
+            final java.lang.Object obj) {\r
         if ( this == obj )\r
             return true;\r
         \r
@@ -95,125 +126,273 @@ implements java.io.Serializable
             return true;\r
         }\r
         return false;\r
-    } //-- boolean equals(java.lang.Object) \r
+    }\r
 \r
     /**\r
      * Returns the value of field 'name'.\r
      * \r
-     * @return String\r
-     * @return the value of field 'name'.\r
+     * @return the value of field 'Name'.\r
      */\r
-    public java.lang.String getName()\r
-    {\r
+    public java.lang.String getName(\r
+    ) {\r
         return this._name;\r
-    } //-- java.lang.String getName() \r
+    }\r
 \r
     /**\r
-     * Returns the value of field 'objRef'. The field 'objRef' has\r
-     * the following description: Reference Frame for rangeType\r
-     * specfication\r
-     *  \r
+     * Method getObjRef.\r
      * \r
-     * @return Object\r
-     * @return the value of field 'objRef'.\r
+     * @param index\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     * @return the value of the java.lang.Object at the given index\r
      */\r
-    public java.lang.Object getObjRef()\r
-    {\r
+    public java.lang.Object getObjRef(\r
+            final int index)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._objRef.size()) {\r
+            throw new IndexOutOfBoundsException("getObjRef: Index value '" + index + "' not in range [0.." + (this._objRef.size() - 1) + "]");\r
+        }\r
+        \r
+        return _objRef.get(index);\r
+    }\r
+\r
+    /**\r
+     * Method getObjRef.Returns the contents of the collection in\r
+     * an Array.  <p>Note:  Just in case the collection contents\r
+     * are changing in another thread, we pass a 0-length Array of\r
+     * the correct type into the API call.  This way we <i>know</i>\r
+     * that the Array returned is of exactly the correct length.\r
+     * \r
+     * @return this collection as an Array\r
+     */\r
+    public java.lang.Object[] getObjRef(\r
+    ) {\r
+        java.lang.Object[] array = new java.lang.Object[0];\r
+        return (java.lang.Object[]) this._objRef.toArray(array);\r
+    }\r
+\r
+    /**\r
+     * Method getObjRefAsReference.Returns a reference to\r
+     * '_objRef'. No type checking is performed on any\r
+     * modifications to the Vector.\r
+     * \r
+     * @return a reference to the Vector backing this class\r
+     */\r
+    public java.util.Vector getObjRefAsReference(\r
+    ) {\r
         return this._objRef;\r
-    } //-- java.lang.Object getObjRef() \r
+    }\r
 \r
     /**\r
-     * Method isValid\r
+     * Method getObjRefCount.\r
      * \r
+     * @return the size of this collection\r
+     */\r
+    public int getObjRefCount(\r
+    ) {\r
+        return this._objRef.size();\r
+    }\r
+\r
+    /**\r
+     * Overrides the java.lang.Object.hashCode method.\r
+     * <p>\r
+     * The following steps came from <b>Effective Java Programming\r
+     * Language Guide</b> by Joshua Bloch, Chapter 3\r
      * \r
+     * @return a hash code value for the object.\r
+     */\r
+    public int hashCode(\r
+    ) {\r
+        int result = super.hashCode();\r
+        \r
+        long tmp;\r
+        if (_name != null) {\r
+           result = 37 * result + _name.hashCode();\r
+        }\r
+        if (_objRef != null) {\r
+           result = 37 * result + _objRef.hashCode();\r
+        }\r
+        \r
+        return result;\r
+    }\r
+\r
+    /**\r
+     * Method isValid.\r
      * \r
-     * @return boolean\r
+     * @return true if this object is valid according to the schema\r
      */\r
-    public boolean isValid()\r
-    {\r
+    public boolean isValid(\r
+    ) {\r
         try {\r
             validate();\r
-        }\r
-        catch (org.exolab.castor.xml.ValidationException vex) {\r
+        } catch (org.exolab.castor.xml.ValidationException vex) {\r
             return false;\r
         }\r
         return true;\r
-    } //-- boolean isValid() \r
+    }\r
 \r
     /**\r
-     * Method marshal\r
-     * \r
      * \r
      * \r
      * @param out\r
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
      */\r
-    public void marshal(java.io.Writer out)\r
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
-    {\r
-        \r
+    public void marshal(\r
+            final java.io.Writer out)\r
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
         Marshaller.marshal(this, out);\r
-    } //-- void marshal(java.io.Writer) \r
+    }\r
 \r
     /**\r
-     * Method marshal\r
-     * \r
      * \r
      * \r
      * @param handler\r
+     * @throws java.io.IOException if an IOException occurs during\r
+     * marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\r
      */\r
-    public void marshal(org.xml.sax.ContentHandler handler)\r
-        throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
-    {\r
-        \r
+    public void marshal(\r
+            final org.xml.sax.ContentHandler handler)\r
+    throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
         Marshaller.marshal(this, handler);\r
-    } //-- void marshal(org.xml.sax.ContentHandler) \r
+    }\r
+\r
+    /**\r
+     */\r
+    public void removeAllObjRef(\r
+    ) {\r
+        this._objRef.clear();\r
+    }\r
+\r
+    /**\r
+     * Method removeObjRef.\r
+     * \r
+     * @param vObjRef\r
+     * @return true if the object was removed from the collection.\r
+     */\r
+    public boolean removeObjRef(\r
+            final java.lang.Object vObjRef) {\r
+        boolean removed = _objRef.remove(vObjRef);\r
+        return removed;\r
+    }\r
+\r
+    /**\r
+     * Method removeObjRefAt.\r
+     * \r
+     * @param index\r
+     * @return the element removed from the collection\r
+     */\r
+    public java.lang.Object removeObjRefAt(\r
+            final int index) {\r
+        java.lang.Object obj = this._objRef.remove(index);\r
+        return obj;\r
+    }\r
 \r
     /**\r
      * Sets the value of field 'name'.\r
      * \r
      * @param name the value of field 'name'.\r
      */\r
-    public void setName(java.lang.String name)\r
-    {\r
+    public void setName(\r
+            final java.lang.String name) {\r
         this._name = name;\r
-    } //-- void setName(java.lang.String) \r
+    }\r
 \r
     /**\r
-     * Sets the value of field 'objRef'. The field 'objRef' has the\r
-     * following description: Reference Frame for rangeType\r
-     * specfication\r
-     *  \r
      * \r
-     * @param objRef the value of field 'objRef'.\r
+     * \r
+     * @param index\r
+     * @param vObjRef\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
      */\r
-    public void setObjRef(java.lang.Object objRef)\r
-    {\r
-        this._objRef = objRef;\r
-    } //-- void setObjRef(java.lang.Object) \r
+    public void setObjRef(\r
+            final int index,\r
+            final java.lang.Object vObjRef)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._objRef.size()) {\r
+            throw new IndexOutOfBoundsException("setObjRef: Index value '" + index + "' not in range [0.." + (this._objRef.size() - 1) + "]");\r
+        }\r
+        \r
+        this._objRef.set(index, vObjRef);\r
+    }\r
 \r
     /**\r
-     * Method unmarshal\r
      * \r
      * \r
+     * @param vObjRefArray\r
+     */\r
+    public void setObjRef(\r
+            final java.lang.Object[] vObjRefArray) {\r
+        //-- copy array\r
+        _objRef.clear();\r
+        \r
+        for (int i = 0; i < vObjRefArray.length; i++) {\r
+                this._objRef.add(vObjRefArray[i]);\r
+        }\r
+    }\r
+\r
+    /**\r
+     * Sets the value of '_objRef' by copying the given Vector. All\r
+     * elements will be checked for type safety.\r
+     * \r
+     * @param vObjRefList the Vector to copy.\r
+     */\r
+    public void setObjRef(\r
+            final java.util.Vector vObjRefList) {\r
+        // copy vector\r
+        this._objRef.clear();\r
+        \r
+        this._objRef.addAll(vObjRefList);\r
+    }\r
+\r
+    /**\r
+     * Sets the value of '_objRef' by setting it to the given\r
+     * Vector. No type checking is performed.\r
+     * @deprecated\r
+     * \r
+     * @param objRefVector the Vector to set.\r
+     */\r
+    public void setObjRefAsReference(\r
+            final java.util.Vector objRefVector) {\r
+        this._objRef = objRefVector;\r
+    }\r
+\r
+    /**\r
+     * Method unmarshal.\r
      * \r
      * @param reader\r
-     * @return RangeType\r
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
+     * @return the unmarshaled uk.ac.vamsas.objects.core.RangeType\r
      */\r
-    public static uk.ac.vamsas.objects.core.RangeType unmarshal(java.io.Reader reader)\r
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
-    {\r
-        return (uk.ac.vamsas.objects.core.Input) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Input.class, reader);\r
-    } //-- uk.ac.vamsas.objects.core.RangeType unmarshal(java.io.Reader) \r
+    public static uk.ac.vamsas.objects.core.RangeType unmarshal(\r
+            final java.io.Reader reader)\r
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
+        return (uk.ac.vamsas.objects.core.RangeType) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Input.class, reader);\r
+    }\r
 \r
     /**\r
-     * Method validate\r
      * \r
+     * \r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
      */\r
-    public void validate()\r
-        throws org.exolab.castor.xml.ValidationException\r
-    {\r
+    public void validate(\r
+    )\r
+    throws org.exolab.castor.xml.ValidationException {\r
         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
         validator.validate(this);\r
-    } //-- void validate() \r
+    }\r
 \r
 }\r