refactored org to uk
[vamsas.git] / src / uk / ac / vamsas / objects / core / Provenance.java
diff --git a/src/uk/ac/vamsas/objects/core/Provenance.java b/src/uk/ac/vamsas/objects/core/Provenance.java
new file mode 100644 (file)
index 0000000..d5daa1f
--- /dev/null
@@ -0,0 +1,306 @@
+/*
+ * This class was automatically generated with 
+ * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML
+ * Schema.
+ * $Id:Provenance.java 264 2006-12-14 17:42:54Z JimP $
+ */
+
+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 Provenance.
+ * 
+ * @version $Revision:264 $ $Date:2006-12-14 17:42:54 +0000 (Thu, 14 Dec 2006) $
+ */
+public class Provenance extends uk.ac.vamsas.client.Vobject 
+implements java.io.Serializable
+{
+
+
+      //--------------------------/
+     //- Class/Member Variables -/
+    //--------------------------/
+
+    /**
+     * Field _entryList
+     */
+    private java.util.Vector _entryList;
+
+
+      //----------------/
+     //- Constructors -/
+    //----------------/
+
+    public Provenance() 
+     {
+        super();
+        _entryList = new Vector();
+    } //-- uk.ac.vamsas.objects.core.Provenance()
+
+
+      //-----------/
+     //- Methods -/
+    //-----------/
+
+    /**
+     * Method addEntry
+     * 
+     * 
+     * 
+     * @param vEntry
+     */
+    public void addEntry(uk.ac.vamsas.objects.core.Entry vEntry)
+        throws java.lang.IndexOutOfBoundsException
+    {
+        _entryList.addElement(vEntry);
+    } //-- void addEntry(uk.ac.vamsas.objects.core.Entry) 
+
+    /**
+     * Method addEntry
+     * 
+     * 
+     * 
+     * @param index
+     * @param vEntry
+     */
+    public void addEntry(int index, uk.ac.vamsas.objects.core.Entry vEntry)
+        throws java.lang.IndexOutOfBoundsException
+    {
+        _entryList.insertElementAt(vEntry, index);
+    } //-- void addEntry(int, uk.ac.vamsas.objects.core.Entry) 
+
+    /**
+     * Method enumerateEntry
+     * 
+     * 
+     * 
+     * @return Enumeration
+     */
+    public java.util.Enumeration enumerateEntry()
+    {
+        return _entryList.elements();
+    } //-- java.util.Enumeration enumerateEntry() 
+
+    /**
+     * Note: hashCode() has not been overriden
+     * 
+     * @param obj
+     * @return boolean
+     */
+    public boolean equals(java.lang.Object obj)
+    {
+        if ( this == obj )
+            return true;
+        
+        if (super.equals(obj)==false)
+            return false;
+        
+        if (obj instanceof Provenance) {
+        
+            Provenance temp = (Provenance)obj;
+            if (this._entryList != null) {
+                if (temp._entryList == null) return false;
+                else if (!(this._entryList.equals(temp._entryList))) 
+                    return false;
+            }
+            else if (temp._entryList != null)
+                return false;
+            return true;
+        }
+        return false;
+    } //-- boolean equals(java.lang.Object) 
+
+    /**
+     * Method getEntry
+     * 
+     * 
+     * 
+     * @param index
+     * @return Entry
+     */
+    public uk.ac.vamsas.objects.core.Entry getEntry(int index)
+        throws java.lang.IndexOutOfBoundsException
+    {
+        //-- check bounds for index
+        if ((index < 0) || (index > _entryList.size())) {
+            throw new IndexOutOfBoundsException("getEntry: Index value '"+index+"' not in range [0.."+_entryList.size()+ "]");
+        }
+        
+        return (uk.ac.vamsas.objects.core.Entry) _entryList.elementAt(index);
+    } //-- uk.ac.vamsas.objects.core.Entry getEntry(int) 
+
+    /**
+     * Method getEntry
+     * 
+     * 
+     * 
+     * @return Entry
+     */
+    public uk.ac.vamsas.objects.core.Entry[] getEntry()
+    {
+        int size = _entryList.size();
+        uk.ac.vamsas.objects.core.Entry[] mArray = new uk.ac.vamsas.objects.core.Entry[size];
+        for (int index = 0; index < size; index++) {
+            mArray[index] = (uk.ac.vamsas.objects.core.Entry) _entryList.elementAt(index);
+        }
+        return mArray;
+    } //-- uk.ac.vamsas.objects.core.Entry[] getEntry() 
+
+    /**
+     * Method getEntryCount
+     * 
+     * 
+     * 
+     * @return int
+     */
+    public int getEntryCount()
+    {
+        return _entryList.size();
+    } //-- int getEntryCount() 
+
+    /**
+     * Method isValid
+     * 
+     * 
+     * 
+     * @return boolean
+     */
+    public boolean isValid()
+    {
+        try {
+            validate();
+        }
+        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
+    {
+        
+        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
+    {
+        
+        Marshaller.marshal(this, handler);
+    } //-- void marshal(org.xml.sax.ContentHandler) 
+
+    /**
+     * Method removeAllEntry
+     * 
+     */
+    public void removeAllEntry()
+    {
+        _entryList.removeAllElements();
+    } //-- void removeAllEntry() 
+
+    /**
+     * Method removeEntry
+     * 
+     * 
+     * 
+     * @param index
+     * @return Entry
+     */
+    public uk.ac.vamsas.objects.core.Entry removeEntry(int index)
+    {
+        java.lang.Object obj = _entryList.elementAt(index);
+        _entryList.removeElementAt(index);
+        return (uk.ac.vamsas.objects.core.Entry) obj;
+    } //-- uk.ac.vamsas.objects.core.Entry removeEntry(int) 
+
+    /**
+     * Method setEntry
+     * 
+     * 
+     * 
+     * @param index
+     * @param vEntry
+     */
+    public void setEntry(int index, uk.ac.vamsas.objects.core.Entry vEntry)
+        throws java.lang.IndexOutOfBoundsException
+    {
+        //-- check bounds for index
+        if ((index < 0) || (index > _entryList.size())) {
+            throw new IndexOutOfBoundsException("setEntry: Index value '"+index+"' not in range [0.."+_entryList.size()+ "]");
+        }
+        _entryList.setElementAt(vEntry, index);
+    } //-- void setEntry(int, uk.ac.vamsas.objects.core.Entry) 
+
+    /**
+     * Method setEntry
+     * 
+     * 
+     * 
+     * @param entryArray
+     */
+    public void setEntry(uk.ac.vamsas.objects.core.Entry[] entryArray)
+    {
+        //-- copy array
+        _entryList.removeAllElements();
+        for (int i = 0; i < entryArray.length; i++) {
+            _entryList.addElement(entryArray[i]);
+        }
+    } //-- void setEntry(uk.ac.vamsas.objects.core.Entry) 
+
+    /**
+     * Method unmarshal
+     * 
+     * 
+     * 
+     * @param reader
+     * @return Provenance
+     */
+    public static uk.ac.vamsas.objects.core.Provenance unmarshal(java.io.Reader reader)
+        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
+    {
+        return (uk.ac.vamsas.objects.core.Provenance) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Provenance.class, reader);
+    } //-- uk.ac.vamsas.objects.core.Provenance unmarshal(java.io.Reader) 
+
+    /**
+     * Method validate
+     * 
+     */
+    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() 
+
+}